Skip to content

docs: consolidate README deployment section and ADR 0001 status - #246

Merged
mrbobbytables merged 1 commit into
mainfrom
fix/consolidate-readme-adr-deploy-233
Sep 21, 2026
Merged

mrbobbytables merged 1 commit into
mainfrom
fix/consolidate-readme-adr-deploy-233

Conversation

@mrbobbytables

Copy link
Copy Markdown
Member

Fixes #233.

Problem

PRs #167, #201, and #203 all rewrite the same README ## Deployment section and/or ADR 0001's Status field, with different (sometimes contradictory) wording. #201 and #203 are both currently mergeable and touch overlapping hunks of README.md; whichever merges first strands the other, and #167 (already CONFLICTING) records a different ADR outcome (Accepted vs Superseded by transfer).

What this does

Picks one, fact-checked version of each contested section as the single source of truth:

  • README ## Deployment: documents what is actually true right now — the site is served by GitHub Pages at cncf.github.io/endusers (confirmed via the live GET /repos/cncf/endusers/pages API response: html_url is http://cncf.github.io/endusers/, cname is null) rather than the aspirational endusers.cncf.io, which has no DNS record or static/CNAME yet.
  • ADR 0001: records that Option A (transfer to the cncf GitHub org) has been executed — provable from the repo now living at cncf/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 to endusers.cncf.io is tracked as still open, matching the actual GitHub Pages state above.
  • adr/README.md: status table updated to match (ProposedAccepted).
  • adr/0001-stakeholder-outreach-draft.md: marked historical, since the transfer already happened.
  • package.json: repository.url now points at cncf/endusers.

Intentionally left out

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

@castrojo

Copy link
Copy Markdown
Member

Closing as superseded: the deployment documentation was landed cleanly via PR #384 (commit 4a1b59f) and the ADR 0001 index/outreach draft references were resolved via PR #385 (commit 3906846).

@castrojo castrojo closed this Sep 21, 2026
auto-merge was automatically disabled September 21, 2026 17:15

Pull request was closed

@castrojo

Copy link
Copy Markdown
Member

Reopening: verifying ADR 0001 status update and repository metadata consolidation against current main.

@castrojo castrojo reopened this Sep 21, 2026
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 for both:

- README Deployment: aligns with actual GitHub Pages target at cncf.github.io/endusers.
- ADR 0001 Status: records Accepted status (Option A, transferred to cncf org)
  with explanatory Status note, passing ADR contract tests.
- package.json: updates repository URL to cncf/endusers.

Signed-off-by: mrbobbytables <mrbobbytables@users.noreply.github.com>
@castrojo
castrojo force-pushed the fix/consolidate-readme-adr-deploy-233 branch from f43da47 to fe83137 Compare September 21, 2026 17:28

@castrojo castrojo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed: rebased onto current main, updated ADR 0001 status to Accepted with descriptive status note to pass adr-contract tests, and aligned README deployment and package.json repository url with cncf/endusers. All 487 unit tests pass.

Awaiting second/independent maintainer review before merge.

@mrbobbytables
mrbobbytables added this pull request to the merge queue Sep 21, 2026
Merged via the queue into main with commit 451015f Sep 21, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[scanner] PRs #167, #201, #203 overlap on the same README Deployment section and ADR 0001 status — merging any one strands the others

2 participants