From fe83137c2864a589e0f2ccf5c469375b046675d9 Mon Sep 17 00:00:00 2001 From: mrbobbytables Date: Thu, 17 Sep 2026 14:24:30 +0000 Subject: [PATCH] docs: consolidate README deployment section and ADR 0001 status 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 --- adr/0001-site-ownership-and-cutover-path.md | 81 ++++++++++----------- adr/README.md | 2 +- adr/stakeholder-outreach-draft-for-0001.md | 6 ++ package.json | 2 +- 4 files changed, 48 insertions(+), 43 deletions(-) diff --git a/adr/0001-site-ownership-and-cutover-path.md b/adr/0001-site-ownership-and-cutover-path.md index c8a15fb1..2d7e33ba 100644 --- a/adr/0001-site-ownership-and-cutover-path.md +++ b/adr/0001-site-ownership-and-cutover-path.md @@ -1,28 +1,35 @@ # ADR 0001: Site ownership and cutover path for endusers.cncf.io -- **Status**: Proposed +- **Status**: Accepted +- **Status note**: Option A — the repository has been transferred to the + `cncf` GitHub org, which is the fact GitHub's own repository metadata now + confirms. This ADR is not aware of a separate, minuted CNCF TOC/TAB vote; + if one exists, link it here. The remaining DNS cutover to + `endusers.cncf.io` is still open — see "Consequences" below. - **Date**: 2026-08-08 -- **Decision deadline**: 2026-08-17 (LAUNCH.md week W-12; see "Decision" below) -- **Tracking issue**: [#46](https://github.com/castrojo/endusers/issues/46) +- **Tracking issue**: [#46](https://github.com/cncf/endusers/issues/46) ## Context The README describes this site as "the home of the CNCF End User Community" and -the build deploys content branded `endusers.cncf.io`. In practice today: +the build deploys content branded `endusers.cncf.io`. At the time this ADR was +originally written: -- The source repository lives in a personal account (`castrojo/endusers`), not a +- The source repository lived in a personal account (`castrojo/endusers`), not a CNCF-owned GitHub org. -- The repository's GitHub Pages homepage is `castrojo.github.io/endusers`, not +- The repository's GitHub Pages homepage was `castrojo.github.io/endusers`, not the `endusers.cncf.io` domain. - Content is derived from authoritative CNCF sources (cncf/architecture, cncf/landscape, cncf/tab), so alignment with CNCF is already a stated - requirement (see `AGENTS.md`), but there is no CNCF org ownership, no DNS - cutover, and no documented governance decision. + requirement (see `AGENTS.md`). -Until this is resolved, every investment in content, SEO, and metrics -accumulates in a property whose long-term home is undecided. This is a -strategic risk for adoption and for contributor recruitment, and it blocks -Phase 2/3 of the roadmap (see `ROADMAP.md`, PR #50). +Since then, the repository has been transferred: it now lives at +[cncf/endusers](https://github.com/cncf/endusers), with GitHub Pages served at +`cncf.github.io/endusers`. The `endusers.cncf.io` domain itself is still not +wired up (no DNS record, no `static/CNAME`), so every investment in content, +SEO, and metrics still accumulates under a staging URL rather than the +intended production domain. This remaining DNS cutover is what blocks +Phase 3 of the roadmap (see `ROADMAP.md`). ## Decision drivers @@ -74,43 +81,35 @@ contributor-site or cncf.io) instead of standing up a new one. ## Decision -Not yet made. This ADR exists to record the options and their tradeoffs so -that CNCF end-user/TAB stakeholders and the repo owner can make an informed -decision. The decision itself belongs to the owner and CNCF stakeholders, not -to automated tooling. - -To keep this from stalling silently (see issue #99), a decision deadline is -recorded above: **2026-08-17**. This date is not a default answer — it is the -point by which the owner and CNCF stakeholders should have picked among -Options A, B, and C (or explicitly extended the deadline in a follow-up PR to -this ADR). `LAUNCH.md` treats this ADR's decision as its W-12 gating -milestone, since the announcement plan cannot name the site's permanent home -until this is resolved. - -If the deadline passes without a decision, the fallback is Option B (stay -personal) by default, purely to avoid blocking Phase 1/2 content work — this -default does not close the ADR or set Status to Accepted, it just documents -what "no decision yet" means operationally for downstream work. +**Option A (transfer to the `cncf` GitHub org) has been executed.** The +repository now lives at [cncf/endusers](https://github.com/cncf/endusers) +instead of `castrojo/endusers`, which resolves the ownership question this +ADR was tracking. This section records that fact as it is verifiable from +GitHub's repository metadata; it does not assert that a specific CNCF +TOC/TAB meeting or vote produced this outcome. If such a record exists, +please link it here in a follow-up PR. ## Proposed next step -1. Open a discussion with CNCF end-user community and TAB stakeholders on the - intended long-term home for this content (see options above). A - ready-to-send outreach draft, with suggested venues and stakeholders, is - available at [stakeholder-outreach-draft-for-0001.md](./stakeholder-outreach-draft-for-0001.md) - (proposed in PR #113). +1. ~~Open a discussion with CNCF end-user community and TAB stakeholders on + the intended long-term home for this content~~ — superseded by the + transfer. The outreach draft at + [stakeholder-outreach-draft-for-0001.md](./stakeholder-outreach-draft-for-0001.md) + is retained for historical context on the options considered. 2. Land the prerequisites shared by every option regardless of outcome: LICENSE (done: #32 / PR #40) and a governance/MAINTAINERS note (#47). -3. By the decision deadline above, update this ADR's Status and Decision - sections, link the outcome from `ROADMAP.md` Phase 2, and open the - follow-up issues/PRs needed to execute it (org transfer, DNS cutover, or - content merge). +3. Execute the DNS cutover to `endusers.cncf.io` (add `static/CNAME`, verify + the custom domain in GitHub Pages settings, and switch the deploy + workflow's `SITE_URL`/`BASE_URL`), then update `ROADMAP.md` Phase 3 + accordingly. ## Consequences -- Until a decision is recorded here, roadmap items that depend on ownership - (DNS cutover, cross-linking with contribute.cncf.io/cncf.io) remain blocked - by design. +- The ownership question is resolved: `cncf/endusers` is the canonical, + CNCF-owned repository. +- The remaining roadmap item that depends on ownership — DNS cutover to + `endusers.cncf.io` and cross-linking with contribute.cncf.io/cncf.io — + stays open until that cutover is executed. - This ADR should be superseded (not silently edited into a different decision) if the chosen path changes after being recorded, so the history of the decision stays auditable. diff --git a/adr/README.md b/adr/README.md index 7f1f1d23..2e730068 100644 --- a/adr/README.md +++ b/adr/README.md @@ -11,7 +11,7 @@ still pending) so future contributors understand why, not just what. | ADR | Title | Status | | ------------------------------------------------- | ---------------------------------------------------- | -------- | -| [0001](./0001-site-ownership-and-cutover-path.md) | Site ownership and cutover path for endusers.cncf.io | Proposed | +| [0001](./0001-site-ownership-and-cutover-path.md) | Site ownership and cutover path for endusers.cncf.io | Accepted | | [0002](./0002-peoplehub-fleet-status.md) | peoplehub fleet status — pause agent work | Accepted | Supporting material is not part of the numbered ADR sequence and is not diff --git a/adr/stakeholder-outreach-draft-for-0001.md b/adr/stakeholder-outreach-draft-for-0001.md index e9745ae3..5ec72b4d 100644 --- a/adr/stakeholder-outreach-draft-for-0001.md +++ b/adr/stakeholder-outreach-draft-for-0001.md @@ -1,5 +1,11 @@ # Stakeholder outreach draft for ADR 0001 +> **Historical note:** the repository has since been transferred to the +> `cncf` GitHub org, resolving the ownership question this draft was written +> to help discuss (see [ADR 0001](./0001-site-ownership-and-cutover-path.md), +> "Decision"). This draft is kept for historical context on the options that +> were considered; it does not need to be sent. + This is a ready-to-send draft supporting [ADR 0001](./0001-site-ownership-and-cutover-path.md) "Proposed next step" #1: opening a discussion with CNCF end-user/TAB stakeholders on the long-term home for this site. It exists so a maintainer diff --git a/package.json b/package.json index 1c1f6819..70f6022e 100644 --- a/package.json +++ b/package.json @@ -60,7 +60,7 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/castrojo/endusers.git" + "url": "git+https://github.com/cncf/endusers.git" }, "author": "CNCF", "license": "CC-BY-4.0",