Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clarified docs for env-vars and config files #13050

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

zerothi
Copy link

@zerothi zerothi commented Oct 27, 2024

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.

@zerothi
Copy link
Author

zerothi commented Oct 27, 2024

This was born out of the discussion in #13043, hence the branch reference.

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant