Skip to content

Backport MicroCloud 3 release notes to MicroCloud 2 docs (v2-edge) - #1482

Draft
elijahgreenstein wants to merge 4 commits into
canonical:v2-edgefrom
elijahgreenstein:microcloud-3-release-notes
Draft

Backport MicroCloud 3 release notes to MicroCloud 2 docs (v2-edge)#1482
elijahgreenstein wants to merge 4 commits into
canonical:v2-edgefrom
elijahgreenstein:microcloud-3-release-notes

Conversation

@elijahgreenstein

Copy link
Copy Markdown
Contributor

This PR:

Motivation: if a user is viewing the default version of the docs and navigates to the 3.1 or 3.2 release notes, then the user jumps to the latest version. If the user then uses the version selector flyout menu to navigate back to default, the user lands on a 404 page.

We could, alternatively, put in place a redirect for the /reference/release-notes/release-notes-3.{1|2}/ path back to latest, but if that additional step of adding a redirect is required anyway, it seems simpler to backport the MicroCloud 3 release notes. This also ensures that users do not unintentionally switch from the default to latest docs versions.

roosterfish and others added 4 commits August 10, 2026 10:20
Signed-off-by: Julian Pelizäus <julian.pelizaeus@canonical.com>
(cherry picked from commit a966f46)
Signed-off-by: Julian Pelizäus <julian.pelizaeus@canonical.com>
(cherry picked from commit 134715a)
Signed-off-by: Julian Pelizäus <julian.pelizaeus@canonical.com>
(cherry picked from commit ec3c406)
MicroCloud 3.1 and 3.2 release notes have been backported to MicroCloud
2. This commit updates the TOC to use those pages rather than linking
out to the `latest` version.

Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
@github-actions github-actions Bot added the Documentation Documentation needs updating label Aug 10, 2026
@elijahgreenstein
elijahgreenstein marked this pull request as draft August 10, 2026 17:34
@elijahgreenstein

Copy link
Copy Markdown
Contributor Author

@roosterfish -- another option is to simply limit the MicroCloud 2 docs release notes to MicroCloud 2 and earlier. This is the approach in Juju and Snapcraft for example:

@elijahgreenstein

Copy link
Copy Markdown
Contributor Author

RTD build is failing, since the release notes include links to MicroCloud 3 content that is unavailable in MicroCloud 2. Possibly further supports the approach of limiting release notes to past versions, rather than adding future versions. Or adding redirects to latest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Documentation needs updating

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants