-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
docs: Update CLI page and add new environment variables page #4311
Merged
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
dosubot
bot
added
size:L
This PR changes 100-499 lines, ignoring generated files.
documentation
Improvements or additions to documentation
labels
Oct 29, 2024
github-actions
bot
added
documentation
Improvements or additions to documentation
and removed
documentation
Improvements or additions to documentation
labels
Oct 29, 2024
carlosrcoelho
requested review from
italojohnny,
ogabrielluiz and
Cristhianzl
October 29, 2024 20:55
italojohnny
approved these changes
Oct 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
lgtm
This PR has been approved by a maintainer
size:L
This PR changes 100-499 lines, ignoring generated files.
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.
Summary
This PR does the following:
There are many pages/features in the docs that reference or directly involve using environment variables, but up until this point there has been no centralized page that catalogs all of them or describes their general usage. The goal of these updates is to provide make it easier to refer users to these pages for learning general information about the CLI and environment variable options rather than repeating the information in multiple locations across the docs.
Although the Markdown syntax isn't pretty, I was able to add anchors to every environment variable and option so that going forward, we can start linking to them directly from other pages.
Need reviewer help