Add permanent url for the latest Linkerd docs#2116
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>
| - 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. |
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?
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>
|
D'oh! I thought I'd approved this. I personally think it makes sense to index only the latest version and not older versions or the edge docs, but I'll defer to Willam's opinion there. |
@wmorgan could you give approval on the overall effect of these changes? (Do we want a permanent location for the latest docs, etc.) And could I get you to weigh in on these 2 questions?
|
I think indexing both /docs/ and /2-edge/ (which may have newer content) makes sense. Let's start with that. If it ends up confusing we can revisit. |
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.https://linkerd.io/{latestMajorVersion}/*https://linkerd.io/docs/*https://linkerd.io/docs/https://linkerd.io/docs/,https://linkerd.io/{latestMajorVersion}/https://linkerd.io/{latestMajorVersion}/https://linkerd.io/2/*https://linkerd.io/{latestMajorVersion}/*,https://linkerd.io/2/*(only used externally)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 versions of the docs, so onlylinkerd.io/docs/andlinkerd.io/2-edge/will be indexed (Currently, older versions do not show up in sitemap.xml). Do we want to do this?noindexmeta tag to2-edgedocs too, so onlylinkerd.io/docs/is indexed?