-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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: Refactor "Environment variables" into 3 articles (Diátaxis) #9966
Docs: Refactor "Environment variables" into 3 articles (Diátaxis) #9966
Conversation
…) and reference (pre-defined)
…ore detail on using secret envs
…g into diataxis/environment-variables
…ets of environment variables"
…ue between sections
@ericholscher I dare say that this is ready for review 👍 |
…g into diataxis/environment-variables
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm a little confused on the differences in these 2 pages. I think a better title on Configuring environment variables
would help. It's not about configuring them, is it?
It was a terrible title! There are currently 3 pages in play, all of which are largely finished methinks..
The "3rd page" was called "Configuring environment variables" and the title wasn't good. I've changed it to "Understanding environment variables" and added a better introduction and some more content about sphinx-multiproject, since that AFAICT is a very solid reason to mention here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a 💯 refactor. Thanks for explaining it. Definitely quite close, just a few nitpicks.
Co-authored-by: Eric Holscher <[email protected]>
This breaks up our current Environment Variables guide:
Refs: #9746
📚 Documentation previews 📚
docs
): https://docs--9966.org.readthedocs.build/en/9966/dev
): https://dev--9966.org.readthedocs.build/en/9966/