Skip to content

docs: fix README deployment section to reflect actual GitHub Pages target #203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mrbobbytables wants to merge 1 commit into from
Closed

docs: fix README deployment section to reflect actual GitHub Pages target #203

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading