Repository navigation
Docs site: the Helm chart's, the Kubernetes manifests' and the monitoring READMEs as pages - #639
Merged
Merged
Conversation
…ring READMEs as pages The site built from docs/SUMMARY.md left out the guides under deploy/: a link to them went to the file on GitHub. SUMMARY.md and docs/README.md now list them under Running Forge, and the staging names a README other than the repository's after its directory (deploy-helm-forge.md, deploy-kubernetes.md, deploy-monitoring.md), so the site stays flat and their links resolve from it. CI's fmt job checks the links for a change to deploy/, whose files the READMEs link, and the Pages workflow deploys a change to them. Fixes #521 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012e6DJbEWF3MPtSyVBYSt2r
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #521
What
#623 (for #622, which duplicated this issue) built the site at https://forgepkg.github.io/forge/ with mdBook,
cargo xtask docsand the Pages workflow. That covers most of #521. Two items are still open: the READMEs underdeploy/should be pages of the site, and the repository's About section should link it. This PR does the first. A pull request can't make the second change (see below).docs/SUMMARY.mdlists the Helm chart's (deploy/helm/forge/README.md), the Kubernetes manifests' (deploy/kubernetes/README.md) and the monitoring examples' (deploy/monitoring/README.md) READMEs under Running Forge, after the deployment guide. The issue names the first two. The monitoring README is the same kind of operator guide (the deployment guide's Telemetry section links it), so it's included as well.xtask/src/docs.rs: a README other than the repository's is now named after its directory on the site:deploy-helm-forge.html,deploy-kubernetes.html,deploy-monitoring.html. Before, all three would have becomereadme.md. The site stays flat because the rewritten links name pages from its root. The READMEs' own links resolve from their directories, like any page's. A link to another page goes to that page (the deployment guide now links the chart and manifests pages instead of GitHub). A link to a file such asvalues.yaml,ci/oralerts.yamlgoes to GitHub. A new test covers this.docs/README.md, the index GitHub shows fordocs/, links the three pages, as the staging requires.ci-changes.shaddsdeployto the group that runsfmt, so a change todeploy/runscargo xtask docs --check. The READMEs link files there, so renaming e.g.values.yamlcan break a link.fmtbuilds only xtask. Pages also deploys on a push that changesdeploy/**/README.md.book.toml's comment and the module docs name the new pages.Repository settings (admin)
The About section's website field is still empty. The issue asks for it to point at the site. Setting it needs a repository administrator: on the repository's main page, the gear next to About → Website:
https://forgepkg.github.io/forge/.How it was checked
cargo xtask docs --check: 15 pages (12 + 3), every link resolves.cargo xtask changelog --check,cargo fmt --all --check,cargo clippy -p xtask --all-targets -- -D warningsandcargo test -p xtask(33 + 1) pass.CHANGELOG.md's raw<user>/<name>tags, as before. In the HTML, all 422 links between pages reach a page and anid, no.mdlink is left, and all 32 links into the source tree name a path that exists. A search forhonor_labelsfinds the monitoring page, and the sidebar shows the three pages under Running Forge.ci-changes.shon a probe commit that touches onlydeploy/monitoring/README.md:changelog=true(sofmtruns) andkubernetes=true, every other groupfalse.Changelog
docs/changes/2.2.0/521.docs.md, the issue's milestone.Generated by Claude Code