Repository navigation
docs(features): say GHES is untested against a real appliance - #1182
Merged
Merged
Conversation
Both GHES entries read as finished support. The end-to-end claim has never been observed: q536-ghes-private-ca-trust.md's own "What this plan will not verify" says no appliance is involved, and Q506's fix was the same. The v1.3.0 dogfood validation runs against github.com, so it says nothing about GHES either. Kept to one clause per entry because check-roadmap caps a features.md line at 45 words and the fuller version pushed both past it — which is the gate working: the detail belongs in the linked troubleshooting page, not the index. GHES is named in the clause itself rather than "a real appliance", so the warning survives being read out of context on a page that gets scanned.
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
1 participant
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.
What
Adds a one-clause caveat to both GHES entries in
docs/features.md.Why
Both entries read as finished support:
The end-to-end claim has never been observed. From
q536-ghes-private-ca-trust.md, its own "What this plan will not verify" section:The
v1.3.0dogfood validation gate runs against github.com, so it says nothing about GHES either. What is covered: the GHES acquire flow has e2e coverage against a fake that models it, and the API-base and CA-bundle plumbing have unit and integration tests. What is not: a real host behind a real private CA completing a handshake.features.mdis what a prospective adopter reads. Advertising unvalidated support there is the overclaim worth fixing before it is frozen into thev1.3.0versioned docs.Why one clause and not more
check-roadmapcaps afeatures.mdentry at 45 words. The fuller wording pushed both entries to 52 and 56, and the gate refused it with "Move the detail into the linked doc." That is the gate working as intended — the index stays scannable, the detail lives in the linked troubleshooting page and in thev1.3.0release notes.GHES is named inside the bolded clause rather than "a real appliance", so the warning still reads correctly when skimmed or quoted out of context.
Timing
Landing before the
v1.3.0tag deliberately. Released versions of the docs site are frozen builds, so a caveat added afterwards never reaches1.3.0— the site would advertise GHES uncaveated at that version permanently, while the release notes for the same version carry the warning.Testing
make roadmap-checkgreen (was failing on the word cap before the trim).make doc-linksgreen, 5259 links/anchors checked. Docs only, nothing shipped changes.