Update docs for plugins

I’m trying to update the website docs for plugins, but I’m unable to figure out where to make the changes. One example is as follows;

The redis storage plugin page: JSON Config Structure - Caddy Documentation references the old/archived github plugin: GitHub - gamalan/caddy-tlsredis: Redis Storage using for Caddy TLS Data, but the latest github plugin is: GitHub - pberkel/caddy-storage-redis.

How can I update the website to reflect the correct github page?

Following the docs pathing, the docs should be under: website/src/docs/json at master · caddyserver/website · GitHub, but I’m not spotting it so clearly I’m missing something.

The module docs are not updated on the website repo. They’re generated from the modules code base.

You need to ask the repo owner to register on the Caddy website then claim the package to have it scanned and its docs generated:

1 Like

Actually it already is registered, but the JSON docs has no way to deduplicate the two because they use the same module ID.

@matt I think we should drop the gamalan one from the database, it’s now archived.

3 Likes

For now, if you’re looking for pberkel’s docs, navigate to Modules on the left side of the /docs page of the website, then search for redis. Here it is:

2 Likes

Oh good to know.

I haven’t done this yet :sweat_smile: so I will have to figure out how to do that. (Again, this is the most neglected part of the project.)

2 Likes

This topic was automatically closed after 90 days. New replies are no longer allowed.