Skip to content

fix(docs): restore the website build - #6007

Merged
norman-abramovitz merged 4 commits into
cloudfoundry:developfrom
nabramovitz:norm/fix/website-docs-link
Oct 15, 2026
Merged

norman-abramovitz merged 4 commits into
cloudfoundry:developfrom
nabramovitz:norm/fix/website-docs-link

Conversation

@nabramovitz

Copy link
Copy Markdown
Contributor

The documentation website stopped publishing after #6004: the contributing guide gained a relative link to ../CONTRIBUTING.md, and the site build, which renders only docs/, could not resolve it (onBrokenMarkdownLinks: 'throw'). The deploy on develop failed at 07:24Z, so the live site is still the 10-08 build.

Two checks should have caught it before merge and did not:

  • The PR website-build job ran only when website/ changed, while the deploy also runs on docs/ changes. It now runs on either.
  • The docs lint's link-resolves rule accepted the link because the file exists, just outside docs/. A new link-in-docs rule rejects relative page links that leave docs/ (images are left alone).

The link itself now uses its GitHub URL, as other docs do for repo files outside docs/.

Tried: with the old link, make build website fails with the same error as the deploy, and the docs lint reports link-in-docs on that line; with the fix, the site builds and the lint reports 0 problems across 60 files.

Changelog fragment: changelog.d/0008-website-docs-builds.md.

AI disclosure (RFC-0047): prepared with AI coding assistance; reviewed by the author.

The website renders only docs/, so the relative ../CONTRIBUTING.md
link added to the contributing guide could not be resolved and the
site build failed on develop. Link the file by its GitHub URL, as the
other docs do for repo files outside docs/.
A relative link out of docs/ works on GitHub but cannot be resolved
by the website build, which renders only docs/. link-resolves passed
such a link because the file exists. The new link-in-docs rule flags
page links that resolve outside docs/; images are left alone.
The PR website build ran only when website/ changed, but the deploy
also runs on docs/ changes, so a docs-only PR that broke the site
merged green and the deploy failed. Run the build on either.

@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

@norman-abramovitz
norman-abramovitz merged commit abdb750 into cloudfoundry:develop Oct 15, 2026
24 checks passed
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