docs: consolidate README deployment section and ADR 0001 status - #246
Open
mrbobbytables wants to merge 1 commit into
Open
mrbobbytables wants to merge 1 commit into
mrbobbytables wants to merge 1 commit into
Conversation
Three open PRs (#167, #201, #203) independently rewrite the same README Deployment section and ADR 0001 status, and would strand each other on merge (issue #233). This picks a single, fact-checked source of truth instead: - README: document the actual current deployment (GitHub Pages at cncf.github.io/endusers) rather than the aspirational endusers.cncf.io domain, which has no DNS record or CNAME yet (verified against the live GitHub Pages API response). - ADR 0001: record that Option A (transfer to the cncf GitHub org) has been executed, per repository metadata, without asserting an unverified formal TOC/TAB vote. The remaining DNS cutover is tracked as still open. - adr/README.md: update the status table to match. - package.json: repository.url now points at cncf/endusers. Note: the .github/workflows/deploy-gh-pages.yml SITE_URL fix (still pointing at the old castrojo.github.io host) and docusaurus.config.js (already covered by #245) are intentionally left out of this PR — the former needs a token/PR with 'workflow' scope, tracked as a fast follow so it isn't lost. Once this lands, PRs #167, #201, and #203 should be closed or rebased to drop their now-redundant README/ADR hunks. Fixes #233 Signed-off-by: mrbobbytables <mrbobbytables@users.noreply.github.com>
This was referenced Sep 19, 2026
test: cover root-level *.md relative link and anchor integrity (tests/root-docs-links.test.mjs)
#309
Open
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.
Fixes #233.
Problem
PRs #167, #201, and #203 all rewrite the same README
## Deploymentsection and/or ADR 0001'sStatusfield, with different (sometimes contradictory) wording. #201 and #203 are both currently mergeable and touch overlapping hunks ofREADME.md; whichever merges first strands the other, and #167 (alreadyCONFLICTING) records a different ADR outcome (AcceptedvsSuperseded by transfer).What this does
Picks one, fact-checked version of each contested section as the single source of truth:
## Deployment: documents what is actually true right now — the site is served by GitHub Pages atcncf.github.io/endusers(confirmed via the liveGET /repos/cncf/endusers/pagesAPI response:html_urlishttp://cncf.github.io/endusers/,cnameisnull) rather than the aspirationalendusers.cncf.io, which has no DNS record orstatic/CNAMEyet.cncfGitHub org) has been executed — provable from the repo now living atcncf/endusers— without asserting an unverified formal CNCF TOC/TAB vote (this addresses @castrojo's review comment on docs: record CNCF org transfer decision in ADR 0001 and project plans (issue #46) #167 asking to narrow the ADR to facts GitHub metadata proves, or cite a real decision source). Remaining DNS cutover toendusers.cncf.iois tracked as still open, matching the actual GitHub Pages state above.adr/README.md: status table updated to match (Proposed→Accepted).adr/0001-stakeholder-outreach-draft.md: marked historical, since the transfer already happened.package.json:repository.urlnow points atcncf/endusers.Intentionally left out
.github/workflows/deploy-gh-pages.yml'sSITE_URL(stillhttps://castrojo.github.io, should behttps://cncf.github.io) — this is a real, separate user-visible bug flagged in [scanner] PRs #167, #201, #203 overlap on the same README Deployment section and ADR 0001 status — merging any one strands the others #233, but pushing a workflow-file change needs a token withworkflowscope that isn't available here. Filing/landing that fix is a fast follow so it doesn't get lost.docusaurus.config.js— already covered by fix(config): point editUrl at cncf/endusers, not castrojo #245 (open, mergeable), so not duplicated here.Follow-up
Once this merges, #167, #201, and #203 should be closed or rebased to drop their now-redundant README/ADR hunks (#167 also carries other independent changes — LAUNCH.md/ROADMAP.md/MAINTAINERS.md updates and the SITE_URL workflow fix — which can be rebased on top of this if still wanted).
— hive: backend=copilot
🐝 Hive Agent:
contributor| SHA:f43da47