Repository navigation
Give each version of the unified release notes preview its own page - #4486
Merged
Merged
Conversation
The generated docset has a page per product and version, named after the version, so a version can be shared by its URL. The product page lists the versions, the pages group entries by area, the navigation names the product and the version instead of "Release notes", and every page warns that the version is unreleased. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
![infra-vault-gh-plugin-prod[bot]](https://avatars.githubusercontent.com/u/6764390?s=60&v=4){kind=small}
Contributor
Docs preview (local build)Handbook preview: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/4486/ |
theletterf
approved these changes
Oct 16, 2026
A bundle targeting a release tag like v9.5.0 generates a version page filtered by :version: 9.5.0, but ChangelogVersionMatch compared the bundle's target and file name without stripping 'v' from either side. With a product-prefixed bundle file name, neither side matched, so the version page silently omitted all of its release notes and warned. Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
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
2 participants
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.
The unified release notes preview now has a page for each version of a product, for example
/release-notes/kibana/9.6.0, so a version can be shared by its URL. Every page warns that the version is unreleased, the entries are grouped by area, and the navigation shows product and version names.Affects: Release notes
Prompt summary: Get the unified release notes preview ready to share with writers. The first publish shows every version on one page with a navigation that reads "Release notes" four times, no areas, and no hint that the versions are unreleased.
Why
The generated site renders all versions of a product on one page, so there is no URL for a single version. The navigation labels each product page "Release notes", which hides which product a page belongs to. The pages do not group entries by area as the published release notes do, and nothing tells a reader that the versions have not shipped.
What
A page per version
UnifiedReleaseNotesDocset.Generatetakes the versions of each product, read from the loaded bundles and ordered newest first. It writesrelease-notes/<product>/<version>.mdwith the changelog directive and:version:. The product page lists the versions and links to them. Known issues, breaking changes and deprecations stay one page per product, across versions.Areas and names
The version pages set
:subsections:, so Features and Fixes group by area. The product page is named after the product in the navigation, and a version page after the version.Unreleased notice
Every generated page opens with a warning admonition that this is a preview of an unreleased version.
Verify
Open
/tmp/site/release-notes/kibana/9.6.0/index.html: the warning is at the top, the sidebar lists the versions, and area names appear in bold above their entries.Out of scope: Which versions the site shows is decided by the workflow in docs-internal-workflows, which will bundle only
previewtargets.🤖 Generated with Claude Code