clarified docs for env-vars and config files #13050
Open
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
|
This was born out of the discussion in #13043, hence the branch reference. |
1 task
More links between sections are added. It should bring all documentation together in a more coherent manner. The Environemnt variables section has been cleaned. Now there are not 3 *random* examples which might have confused users to only suspect that those 3 examples where the only available ones. Now this section clarifies how *any* CLI-option is specified through an env var, and clarifies that the shell example, *is* an example. Signed-off-by: Nick Papior <nickpapior@gmail.com>
Signed-off-by: Nick Papior <nickpapior@gmail.com>
zerothi
force-pushed
the
13043-docs-env-vars
branch
from
dc77343 to
627a1ae
Compare
ichard26
requested changes
Dec 14, 2024
Signed-off-by: Nick Papior <nickpapior@gmail.com>
ichard26
added
the
skip news
ichard26
approved these changes
Dec 16, 2024
|
Great! Looks complete to me! |
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.
More links between sections are added.
It should bring all documentation together
in a more coherent manner.
The Environemnt variables section has been
cleaned.
Now there are not 3 random examples which
might have confused users to only suspect that those 3 examples where the only available ones.
Now this section clarifies how any CLI-option
is specified through an env var, and clarifies
that the shell example, is an example.