fix(docs): scope the v1beta3 requirement to the Preflight kind - #4539
Merged
Merged
Conversation
The docs say Embedded Cluster v3 requires preflight specs to use troubleshoot.sh/v1beta3, but that requirement is scoped to the Preflight custom resource. Troubleshoot has no v1beta3 HostPreflight, so host preflight specs stay v1beta2 on every product including v3. A vendor writing a custom host preflight for v3 had no way to tell. Qualify the statement everywhere it appeared, and state the carve-out as a list of kinds rather than a concept, so a reader sees HostPreflight named explicitly instead of inferring it from silence. Also replace the hand-copied note in the Preflight reference with an import of the shared partial, so the two cannot drift again. The migration page heading keeps its original anchor, which seven pages link to. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
AmberAlston
marked this pull request as ready for review
September 18, 2026 20:21
banjoh
approved these changes
Sep 21, 2026
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
3 participants
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.
The docs tell vendors that Embedded Cluster v3 requires preflight specs to use
troubleshoot.sh/v1beta3. That requirement is real, but it is scoped to thePreflightcustom resource. There is no v1beta3HostPreflight, so host preflight specs stayv1beta2on every product, including v3.Because the docs said "preflight specs" instead of naming the kind, a vendor writing a custom host preflight for v3 had no way to tell which rule applied to them.
This qualifies the statement everywhere it appeared, and states the carve-out as a list of kinds so HostPreflight is named explicitly rather than inferred from silence.
Also in here:
{#preflight-specs-must-use-v1beta3}anchor, which seven pages link to. Link labels were updated to match.Verified with a local
npm run build. The anchor, the requalified heading, and the imported partial all render.Surfaced while reviewing #4535, which correctly documents
v1beta2for HostPreflight. That PR is fine, the surrounding docs were the problem.