From 8f49aad999a9a73d9863f4659b6f33da5af1f250 Mon Sep 17 00:00:00 2001 From: mrbobbytables Date: Mon, 21 Sep 2026 13:27:42 +0000 Subject: [PATCH] docs: correct README Deployment section to reflect actual GitHub Pages target The README stated the site deploys to endusers.cncf.io, but that domain is currently NXDOMAIN (does not resolve). The actual deployment target is GitHub Pages at cncf.github.io/endusers, with temporary SITE_URL and BASE_URL overrides set in the CI workflow. Update the Deployment section to: - Correctly identify GitHub Pages as the current target - Note the temporary SITE_URL/BASE_URL values and where they are set - Clarify that endusers.cncf.io is the long-term target (pending DNS cutover) - Reference ADR 0001 and issue #46 for the ownership/cutover plan Resolves: #171 Signed-off-by: mrbobbytables --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3dcadbd9..0904a5c8 100644 --- a/README.md +++ b/README.md @@ -45,14 +45,22 @@ npm run docusaurus start -- --host 0.0.0.0 --port 3000 --poll 10000 ## Deployment -The site deploys to [endusers.cncf.io](https://endusers.cncf.io/). Site configuration: +The site currently deploys to GitHub Pages at [cncf.github.io/endusers](https://cncf.github.io/endusers/). +The build process is configured with: + +- `SITE_URL: 'https://castrojo.github.io'` (temporary override; see below) +- `BASE_URL: '/endusers/'` (temporary override; see below) + +(These are set in `.github/workflows/deploy-gh-pages.yml` and will be updated when a custom domain is active.) + +The long-term target is [endusers.cncf.io](https://endusers.cncf.io/), which is currently a pending DNS +cutover. When that domain is verified and active, the workflow will update the configuration to: - `url: 'https://endusers.cncf.io'` - `baseUrl: '/'` -The source repository is [castrojo/endusers](https://github.com/castrojo/endusers). The -long-term ownership and CNCF-org cutover path for this site is not yet decided; see -[ADR 0001](./adr/0001-site-ownership-and-cutover-path.md). +See [ADR 0001](./adr/0001-site-ownership-and-cutover-path.md) and [issue #46](https://github.com/cncf/endusers/issues/46) +for the ownership and cutover plan. ## Metrics data