Skip to content

docs: clarify env names are configurable, roles are positional - #133

Merged
joshua-temple merged 1 commit into
mainfrom
docs/env-name-configurability
Jun 13, 2026
Merged

joshua-temple merged 1 commit into
mainfrom
docs/env-name-configurability

Conversation

@joshua-temple

Copy link
Copy Markdown
Collaborator

Problem

The docs use dev/test/uat/prod throughout, 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 the environments area 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, reserved environment/dry_run dispatch inputs, gha_environment maps 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

  • Docs build passes (astro build, 9 pages, search index built).
  • Guardrail scan on the diff: zero forbidden strings, zero em dashes, no process language.

Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
@joshua-temple
joshua-temple merged commit 207ff3e into main Jun 13, 2026
8 checks passed
@joshua-temple joshua-temple added the docs Improvements or additions to documentation label Jun 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant