Docs: host Helm and SWCK docs on the website - #910
Merged
Conversation
Both repos carry docs/ with a menu.yml, so their docs can be rendered by the site rather than linked out to GitHub. Kubernetes Helm was GitHub-linked with a single v4.9.0 tree link. It is now website-hosted with Next / Latest / v5.0.0, Latest and v5.0.0 sharing the v5.0.0 tag commit so seo/doc-canonical-map.html points the versioned tree at /latest/. The old v4.9.0 entry is dropped rather than kept alongside: a component cannot mix hosted and GitHub-linked entries, because docs.js runs every entry through doc.sh once repoUrl is present and an external link dies at `cp ./docs/menu.yml` under set -o errexit. repo also moves from skywalking-kubernetes to skywalking-helm, matching the upstream rename that the old name now only reaches by redirect. That puts the docs at /docs/skywalking-helm/, which breaks nothing since this component had no website doc URLs before, and it gives the card a star count — apache/skywalking-kubernetes has no entry in data/stars.yml. SWCK moves Latest onto the v0.11.0 tag commit, adds a v0.11.0 entry on the same commitId, and drops v0.10.0 so the site recommends 0.11.0 only. Verified with npm run docs — the same generation CI runs — followed by a full hugo build. Both trees render, the cards read Next / v5.0.0 and Next / v0.11.0, the in-page version switchers offer next / latest / the release, the canonicals resolve to /latest/readme/, and no GitHub tree links remain on either card. Note for reviewers: v5.0.0 and v0.11.0 are git tags without published release artifacts — no GitHub release object, and the ASF dist still carries helm 4.9.0 and swck 0.10.0 — so the docs will run ahead of what the downloads page offers until those releases land. Removing swck v0.10.0 also retires 17 currently published pages under that tree.
❌ Deploy Preview for skywalking-website-preview failed.
|
wu-sheng
added a commit
that referenced
this pull request
Aug 31, 2026
releases.yml: add helm 5.0.0 and swck 0.11.0 at the top of their sections, dated Sep. 1st, 2026, and demote 4.9.0 and 0.10.0 to archive.apache.org. All 21 links verified to return 200. SWCK 0.11.0 ships its Helm chart as a signed, voted artifact for the first time (skywalking-swck-0.11.0.tgz, absent from 0.10.0), so it is listed beside the binary tarball using the "|" separator pattern the GraalVM distro card already uses. Without it the new artifact would be invisible on the site. Two event posts, each in its component's established style: the Helm one keeps the release's Breaking changes / Features / Corrections structure, the SWCK one the Features / Bugs / Chores shape its earlier posts use. Per the repo's rules the release-tooling, e2e and dependency-bump entries are left out of the SWCK post, which was most of its changelog's volume. docs.yml already points at these versions from #910, so the docs and downloads pages now agree — the gap noted there is closed. Note the posts are dated 2026-09-01. Hugo does not build future-dated content and buildFuture is unset, so merging before Sep 1 10:00 UTC leaves the two event pages ungenerated until the next daily scheduled build picks them up. The downloads page updates immediately either way, since its dates are plain display strings.
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
1 participant
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.
Both repos carry
docs/with amenu.yml, so their documentation can be rendered by the site instead of linking out to GitHub.v4.9.0treeNext/Latest/v5.0.0, website-hostedNext/Latest/v0.10.0Next/Latest/v0.11.0Latestand the versioned entry share a commitId in both cases, soseo/doc-canonical-map.htmlpoints the versioned tree at/latest/rather than letting the duplicate pair compete in search.Two changes that go beyond a version bump
Helm's
v4.9.0entry is dropped, not kept alongside. A component cannot mix hosted and GitHub-linked entries:docs.jsruns every entry throughdoc.shoncerepoUrlis present, and an externalhttps://github.com/…/tree/vXlink then yields a bogus local path and dies atcp ./docs/menu.ymlunderset -o errexit, taking the whole build with it.repomoves fromskywalking-kubernetestoskywalking-helm, matching the upstream rename that the old name now only reaches by redirect. That puts the docs at/docs/skywalking-helm/…, which breaks nothing because this component had no website doc URLs before. It also fixes a latent gap —apache/skywalking-kuberneteshas no entry indata/stars.yml, so that card has never shown a star count.Verification
Ran
npm run docs— the same generation CI performs, clones and all — then a fullhugobuild:next/latest/v5.0.0, swcknext/latest/v0.11.0.Next / v5.0.0andNext / v0.11.0, both with "Read docs" →/latest/readme/, and no GitHub tree links left on either.next / latest / <release>; canonicals resolve to/latest/readme/.v0.10.0is gone from the generated sidebars too, so nothing references it.Generated artifacts are not included —
layouts/projectdoc/baseof.htmlandstatic/images/*.pngwere reverted after the local build, sincebuild-with-docsregenerates them.Two things worth a reviewer's judgement
Neither tag is a published release.
v5.0.0andv0.11.0exist as git tags but have no GitHub release object, and the ASF dist still carries helm4.9.0and swck0.10.0. So the docs page will advertise v5.0.0 / v0.11.0 whilereleases.ymland the downloads page still offer 4.9.0 / 0.10.0. Coherent if those votes are in flight; worth a second look if not.Removing swck
v0.10.0retires 17 currently published pages./docs/skywalking-swck/v0.10.0/…is live and indexed today and will 404 after this deploys. Nothing on the site links to it, so there are no internal dead links, but external links and search results will break.