docs: fix default value for anonymous usage statistics references #10283
Conversation
This file contains hidden or 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
ldez
suggested changes
Dec 6, 2023
Contributor
ldez
left a comment
ldez
left a comment
There was a problem hiding this comment.
Hello,
the default value of sendanonymoususage send anonymous usage is false, the problem is related to the description, not the value.
Member
|
Hello @ariyonaty, and thanks for opening this pull request, @ldez is right, the default value of the To fix the command description, you have to edit it here: https://github.com/traefik/traefik/blob/master/pkg/config/static/static_config.go#L99, and to generate the reference documentation with Could you please open another pull request? In the meantime, I will close this pull request. |
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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?
This PR updates misleading documentation regarding the default value (
false) of the anonymous usage option.Motivation
When looking through the CLI reference documentation, noticed room for clarfication with the
--global.sendanonymoususageoption, where the default value was said to befalse, however the description said, "If the option is not specified, it will be enabled by default.".This PR aims to help clear up ambiguity for both the CLI Ref and the ENV ref docs regarding the option's default value.
More
Additional Notes
This will be my first PR to Traefik. Hopefully can make some more impactful contributions in the future.