Improved env var docs a bit. #1913
Conversation
There was a problem hiding this comment.
Nice work, I'm glad we're improving this!
How does the PR relate to these two issues:
- Document our environment variables #1894
- Make it clear in docs which env vars and how users need to set when deploying to production #2053
Can we take care of those as well?
For the context, this is 3 months old PR what was adding quite specific bits to the docs regarding env vars that were missing, which was made obviuos to me from the Discord convo I linked. Somehow we forgot about this PR, and I realized now it is still open, so thought let's merge it. That's a good point regardin g the issues you linked, and there is a general initiative to improve the env vars situation, but from taking a quick look at those issues, it is clear to me they are going quite wider in their scope. So I wouldn't tackle those now as they are not trivial, this PR is a useful incremental change on its own, and this bigger issues we can independently do later. |
There was a problem hiding this comment.
Did another iteration!
I accepted some of the changes, but some of them, that are about generally improving the pieces of docs we touched, I would propose not doing in this PR. It is 3 months old PR with specific small changes, I don't have all the context I had then and I would rather not get entangled into the rest of the docs here. We can have a separate effort where we rehaul the whole file to make it be closer to our writing guide. I did though make sure that additions do stick to writing guide.
There was a problem hiding this comment.
I'm approving. You can merge this when you're satisfied.
Do what you want with all remaining unresolved comments (and resolve them when you're happy). None of them are important enough to take up more time.
Btw, I forgot this is three months old. If I had remembered, I wouldn't leave that many comments (since the changes have been out of your context for a while, and aren't that important)
I forgot to mention it is that old! That would have helped. |
Martinsos
force-pushed
the
env-vars-docs-fix
branch
from
086a515
to
6be9fd8
Compare
Martinsos
force-pushed
the
env-vars-docs-fix
branch
from
6be9fd8
to
8296ca8
Compare
Inspired by this Discord question: https://discord.com/channels/686873244791210014/1220070515276775516/1220070515276775516 .