From ac4c68e06afe3e7230701f72c96d3f506167c1a0 Mon Sep 17 00:00:00 2001 From: mrbobbytables Date: Wed, 16 Sep 2026 20:05:30 +0000 Subject: [PATCH] docs: fix README deployment section to reflect GitHub Pages target The README claimed the site deploys to endusers.cncf.io, but that domain is NXDOMAIN and has no CNAME configured. The workflow actually builds for GitHub Pages (cncf.github.io/endusers). Update the Deployment section to describe the real target and note the pending custom-domain cutover tracked by issue #46 and ADR 0001. Fixes cncf/endusers#171 Signed-off-by: mrbobbytables --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3dcadbd9..d41d0b3d 100644 --- a/README.md +++ b/README.md @@ -45,13 +45,18 @@ 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: - -- `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 +The site currently deploys to GitHub Pages, served at +[cncf.github.io/endusers](https://cncf.github.io/endusers/), built by +[`.github/workflows/deploy-gh-pages.yml`](.github/workflows/deploy-gh-pages.yml) with: + +- `SITE_URL=https://castrojo.github.io` +- `BASE_URL=/endusers/` + +`endusers.cncf.io` is the intended production domain, but it does not yet resolve (no DNS +record and no `static/CNAME` file). Once the custom domain is verified and active, the +build should switch to `SITE_URL=https://endusers.cncf.io` / `BASE_URL=/` so the site +configuration matches. The long-term ownership and CNCF-org cutover path is tracked by +[issue #46](https://github.com/cncf/endusers/issues/46) and is not yet decided; see [ADR 0001](./adr/0001-site-ownership-and-cutover-path.md). ## Metrics data