Skip to content

Publish documentation website to GitHub Pages - #5586

Merged
norman-abramovitz merged 2 commits into
cloudfoundry:developfrom
nabramovitz:norm/docs/website-modernize
Jul 6, 2026
Merged

Publish documentation website to GitHub Pages#5586
norman-abramovitz merged 2 commits into
cloudfoundry:developfrom
nabramovitz:norm/docs/website-modernize

Conversation

@nabramovitz

Copy link
Copy Markdown
Contributor

Adds the publishing leg of the docs/website work merged in #5583.

  • New website-deploy.yml workflow: builds the Docusaurus site and deploys it to GitHub Pages on every develop push touching docs/ or website/ (plus manual dispatch). Uses the official upload/deploy-pages actions; node/bun versions match pr.yml.
  • Until the stratos.cloudfoundry.org custom domain exists, the site is built for project Pages (<owner>.github.io/stratos/). docusaurus.config.js gains SITE_URL/SITE_BASE_URL env overrides (defaults unchanged); the workflow derives them from the repository owner, so the same workflow also deploys fork previews. Once the CNAME lands, set them to https://stratos.cloudfoundry.org and /.
  • website/manifest.yml: the built site can also be pushed to any Cloud Foundry as a staticfile app (make build website && cf push -f website/manifest.yml).
  • README documents both deploy paths.

Requires a repo admin to enable Pages (Settings → Pages → source "GitHub Actions") before the deploy job succeeds. Verified end to end on a fork: the workflow run deploys and the site renders correctly under the /stratos/ base path.

@norman-abramovitz norman-abramovitz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM - Deploying to my cloned Stratos repo

@norman-abramovitz
norman-abramovitz merged commit e19cd71 into cloudfoundry:develop Jul 6, 2026
18 checks passed
@nabramovitz
nabramovitz deleted the norm/docs/website-modernize branch July 6, 2026 20:17
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.

2 participants