docs: add a single HFLOW_* environment variable reference page - #54
Closed
chintondutta wants to merge 1 commit into
Closed
docs: add a single HFLOW_* environment variable reference page#54chintondutta wants to merge 1 commit into
chintondutta wants to merge 1 commit into
Conversation
The six HFLOW_* variables were documented across five separate places, plus HFLOW_TEST_BUCKET_URL wasn't documented anywhere. Add docs/ENVIRONMENT.md as the one page to check, per the documentation contract (one primary purpose, linked from the index).
|
👋 Hi @chintondutta — thanks for the contribution! To keep starter issues available You already have #52 open, so this one is being closed automatically. |
This file contains hidden or 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
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.
Fixes #9.
The gap
HFlow recognizes seven
HFLOW_*environment variables, documented across five different places with no single reference -- andHFLOW_TEST_BUCKET_URLwasn't documented anywhere at all (greppedHFLOW_undersrc/andtests/to enumerate authoritatively; the issue listed six, there are seven).Change
Adds
docs/ENVIRONMENT.md: one table (variable, purpose, default, where it applies), linked to the existing pages that own each variable's operational detail rather than duplicating it. Linked fromdocs/README.md's Reference section, per the documentation contract (one primary purpose per page, linked from the index).Left the existing per-topic docs (README.md Requirements, RUNTIME.md, CATALOG.md, CONTRIBUTING.md, generated DEPLOY.md) untouched -- this page is the lookup table, not a replacement for where each variable is explained in context.
Testing
(lychee wasn't on PATH in this sandbox; ran it via the official Docker image instead of installing.)