docs: clarify env names are configurable, roles are positional - #133
Merged
Merged
Conversation
Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
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.
Problem
The docs use
dev/test/uat/prodthroughout, which can read as reserved names. Nothing in the generator treats those labels specially, and the env roles are decided by position, not by name. Readers had no single statement of that.Fix
Three surgical, documentation-only edits:
docs/src/content/docs/configuration.md(authoritative): a note aside in theenvironmentsarea stating names are fully configurable, roles are positional (last = release stage, second-to-last = prerelease), the example names are illustrative, the env count is structural, plus naming guidance (identifier-safe names, reservedenvironment/dry_rundispatch inputs,gha_environmentmaps to a real GitHub Environment).README.md: one line at the promote modes table noting the modes are generated from your configured env names and roles are positional.docs/src/content/docs/workflows.md: one clause in Promotion Modes noting the env names and<from>-to-<to>modes come from your configuration, with positional roles.Mermaid diagrams untouched; no per-mention annotations added.
Verification
astro build, 9 pages, search index built).