linkerd / linkerd/website

fix canonical tags to not point to now-deprecated docs

Open
#1,481 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
60
Forks
221
Avg merge
4h 32m
Merged PRs (30d)
1

Description

When we deprecate specific docs in a version, the canonical tags that we set in the older versions of those docs are pointing to the non-existing doc for the latest version.

E.g. there is no /2.12/tasks/securing-your-cluster/ doc (in this case, we renamed it for this version, but the same is true in earlier versions), but the 2.11, 2.10, etc versions still point to it in their meta rel=canoncial tags.

We should not create a canonical tag if the corresponding doc doesn't exist. (And for renames, we could potentially try and follow it but I think it would be hard to do, and I'm not sure it's really worth it.) The point of these canonical tags is to help Google index the latest version of everything by default, and if the latest version does not include this doc then we don't have to care too much about how it is indexed.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not name a file or test. Start by locating the website logic that generates canonical tags for versioned documentation, then check how it handles a document missing from the latest version. Done means older versions no longer emit canonical tags pointing to nonexistent latest-version documents; add or update coverage if the project has tests for this behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, web-dev
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.