Improve acme CLI options in Let's Encrypt documentation #6762
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
netoax
force-pushed
the
devel_fix_lets_encrypt_docs
branch
from
658d9e9
to
31cfcbd
Compare
|
Hello, Thank you, The CLI flags are case insensitive, so camelCase or lowercase produce the same result. https://docs.traefik.io/operations/cli/#general The blocks of 4 trailing spaces are not errors but used to handle section. |
|
Hello @ldez, thanks for the feedback. I didn't know about the trailing spaces being used to control section, sorry. Is this still valuable changing the flags to keep standardization across the docs? |
|
Have an homogeneous documentation is still a valuable change. Could you restore the trailing space, thank you. Could you also edit the PR description. |
ldez
added
area/documentation
contributor/waiting-for-corrections
kind/enhancement
ldez
changed the title
netoax
force-pushed
the
devel_fix_lets_encrypt_docs
branch
from
31cfcbd
to
6270158
Compare
netoax
force-pushed
the
devel_fix_lets_encrypt_docs
branch
from
6270158
to
090cdef
Compare
Done. |
mpl
approved these changes
May 4, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
When reading the current documentation I noticed the Let's Encrypt section shows the acme CLI flags in camelCase format instead of lowercase, which is different from other sections of documentation such as the CLI configuration reference. Because of that, this PR updates the flags to keep homogeneous documentation. Example:
From:
--certificatesResolvers.<name>.acme.caServerTo:
--certificatesresolvers.<name>.acme.caserverMotivation
My main motivation is to improve the documentation in a way that avoids newcomers get confused.
More