Conversation
|
Read the docs has the ability to show docs for particular versions. Currently we just have latest and stable on there. I'm not sure what it would take to show older versions of the documentation, but that could be an option as well instead of branching. |
certbot/docs/using.rst
Outdated
|
|
||
| certbot reconfigure --cert-name example.com --webroot-path /path/to/new/location | ||
|
|
||
| If this command succeeds, you are done! |
There was a problem hiding this comment.
Thanks for taking this! One thing I would add is something like "For other common options that may be updated with the "reconfigure" subcommand, run certbot help reconfigure." Maybe also that the certificate needs to be specified with the --cert-name flag, which is often the first domain on the certificate.
There was a problem hiding this comment.
Added!
I think maybe we will want to expand the help topic to include flags like --standalone, --http-01-port, --http-01-address, --https-port, --preferred-chain, --preferred-challenges --[no-]reuse-key. It's kind of a bummer that there doesn't appear to be a way to include topics in plugin flags like --webroot-path. There might be a backwards-compat way to do this with a kwarg though.
There was a problem hiding this comment.
Good call. Adding most of those is very easy. Yeah, I think I briefly looked at adding --webroot-path and thought it wasn't worth the effort at the time, but I could see it being worth doing in its own PR. We could also include a note in the top matter to run certbot help webroot for more options or something.
I think it could make sense if we identify a long term need to have documentation at different versions. i.e. to support our users who are using Certbot packaged by LTS distros. I wasn't planning on having this particular piece of branching in places for more than a release or so according to the current 2.x release plan, so I'd be happy to leave it as-is in this case. |
Cool great agreed, let's leave it like this then |
certbot/docs/using.rst
Outdated
|
|
||
| certbot reconfigure --cert-name example.com --webroot-path /path/to/new/location | ||
|
|
||
| If this command succeeds, you are done! |
There was a problem hiding this comment.
Yeah I have found that cute tends to age poorly in documentation 😆
Co-authored-by: ohemorange <ebportnoy@gmail.com>
ohemorange
left a comment
There was a problem hiding this comment.
Thanks! Let's also make an issue to add those extra flags you mentioned so we don't forget.
Fixes #9531.
We should remove the branching/old instructions eventually, I think either during @zoracon's user guide rewrite or maybe once we have pushed Certbot 2.x to all snap users.