docs: clarify external scope in configuration reference - #224
Merged
Merged
Conversation
Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
joshua-temple
force-pushed
the
docs/clarify-external-scope
branch
from
June 18, 2026 18:55
784ee84 to
8282a2b
Compare
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
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.mdthat states plainly:external:is for: satellite repos that own their own builds, deploy to their first environment, and notify the primary viaworkflow_dispatch; the primary records SHA/version and drives promotionsVerification
Refs #2