Skip to content

docs: make release-only a first-class adoption path#247

Merged
joshua-temple merged 1 commit into
mainfrom
docs/adoption-non-env-first-class
Jun 22, 2026
Merged

docs: make release-only a first-class adoption path#247
joshua-temple merged 1 commit into
mainfrom
docs/adoption-non-env-first-class

Conversation

@joshua-temple

Copy link
Copy Markdown
Collaborator

Problem

The Adoption Guide was structured almost entirely around multi-environment pipelines. Release-only (no-env) repos were technically mentioned but marginalized: a one-line footnote at the bottom, with prose elsewhere quietly assuming every adopter has environments.

Fix

Make release-only a first-class path in adoption.md, without overclaiming:

  • Add an upfront framing that cascade fits two shapes equally (deploy-through-environments and release-only).
  • Scope the environments prerequisite to the deploy case; a release-only repo skips it.
  • Add a brief release-only note in the env-choosing step.
  • Promote the no-env topology bullet from a library/CLI footnote to a first-class shape, broadening the fit (libraries, CLIs, SDKs, published images, schemas/packages).
  • Preserve the real constraint: hotfix and rollback need two or more environments, so they do not apply to release-only repos.

Verification

  • Docs-only change to one Markdown file.
  • Independent review: APPROVE. Claims verified against code (no-env preset is real; release-only still gets version derivation, changelog, and release management; hotfix/rollback 2+ env requirement preserved).
  • In-page anchor and cross-page links checked.

Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
@joshua-temple joshua-temple enabled auto-merge (squash) June 22, 2026 16:12
@joshua-temple joshua-temple merged commit ab8d6d1 into main Jun 22, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant