Add permanent url for the latest Linkerd docs#2116
Open
travisbeckham wants to merge 6 commits intomainfrom
Open
Add permanent url for the latest Linkerd docs#2116travisbeckham wants to merge 6 commits intomainfrom
travisbeckham wants to merge 6 commits intomainfrom
Conversation
Signed-off-by: Travis Beckham <travis@buoyant.io>
Signed-off-by: Travis Beckham <travis@buoyant.io>
Signed-off-by: Travis Beckham <travis@buoyant.io>
Signed-off-by: Travis Beckham <travis@buoyant.io>
Signed-off-by: Travis Beckham <travis@buoyant.io>
wmorgan
reviewed
May 6, 2026
| - Click on the `Rules`section | ||
| - Update the rule `https://linkerd.io/2/*` so that it points to | ||
| `https://linkerd.io/2.19/$1` | ||
| - Push, and hold the merge till after `2.20` is out. |
Member
There was a problem hiding this comment.
Is there a step we need in here to make the per-file 2.20 -> docs redirects? Or is that only needed as a one-time thing for 2.19?
Collaborator
Author
There was a problem hiding this comment.
All of the {latestVersion} -> docs redirects are generated at build time. You can see this in alias-latest-docs.html
(or am I not understanding your question?)
Signed-off-by: Travis Beckham <travis@buoyant.io>
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.
Overview
Add a permanent url for the latest Linkerd docs, making
/docs/a real url, and/{latestMajorVersion}/a redirect.For example, while 2.19 is the latest major version,
linkerd.io/2.19/will redirect tolinkerd.io/docs/, but once 2.20 is released,linkerd.io/2.19/would become an actual directory that is not indexed. Onlylinkerd.io/docs/andlinkerd.io/2-edge/will be indexed.With this change, we should not use the
/2/Cloudflare redirect in the content anymore, we can just use/docs/. We will leave the Cloudflare redirect in place for existing external links, but we should stop using it internally so our linting can check these links.Even though this is a major change, all existing links internally and externally should continue to work.
This change was motivated by comments in issue #1849.
High-level Changes
All of the latest docs are moved to
content/docs/.An alias is automatically generated for every page in the latest docs. E.g.:
linkerd.io/2.19/referenceredirects tolinkerd.io/docs/referenceAll older versions of docs are in directories named by their version (same as today), and now have a
noindexmeta tag set. E.g.:linkerd.io/2.18,linkerd.io/2.17, etcDocs images have been moved to the static directory
All internal links that used the Cloudflare
/2/redirect have been updated to point to/docs/, except links that are part of CLI output.Each version (
linkerd.io/docs,linkerd.io/2.17, etc) now redirects to the Getting Started page, instead of Overview.After this change is merged, the Cloudflare
/2/redirect should be updated to point to/docs/, which means we will not have to update this anymore where there's a new major version 🎉.Preview links
Question for reviewers
noindexmeta tag to older version of the docs, so onlylinkerd.io/docs/andlinkerd.io/2-edge/will be indexed? Currently, older versions do not show up in sitemap.xml.