Skip to content

docs: clarify external scope in configuration reference - #224

Merged
joshua-temple merged 1 commit into
mainfrom
docs/clarify-external-scope
Jun 18, 2026
Merged

joshua-temple merged 1 commit into
mainfrom
docs/clarify-external-scope

Conversation

@joshua-temple

@joshua-temple joshua-temple commented Jun 18, 2026 •

Copy link
Copy Markdown
Collaborator

Problem

The external: section heading and one-line description left it ambiguous whether the field covers GitOps mirror patterns (pushing rendered manifests to a separate repo and tracking the pushed commit) or the satellite/sibling-repo artifact coordination pattern. Issue #2 calls this out.

Fix

Added a concise paragraph immediately under the section heading in docs/src/content/docs/configuration.md that states plainly:

  • what external: is for: satellite repos that own their own builds, deploy to their first environment, and notify the primary via workflow_dispatch; the primary records SHA/version and drives promotions
  • what it is not for: GitOps mirror deploys (push-manifests-to-config-repo); those belong in a callback workflow, with a link to the Deploy Workflow Contract in callback-contract.md

Verification

  • Guardrail scan on diff: clean (forbidden strings and em dashes checked)
  • Docs build: Node 22 not available in this environment; Starlight build not run locally
  • Commit is GPG-signed and DCO signed-off

Refs #2

Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
@joshua-temple
joshua-temple force-pushed the docs/clarify-external-scope branch from 784ee84 to 8282a2b Compare June 18, 2026 18:55
@joshua-temple
joshua-temple merged commit 997c8cf into main Jun 18, 2026
15 checks passed
@joshua-temple
joshua-temple deleted the docs/clarify-external-scope branch June 18, 2026 19:01
@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