docs: fill missing description and canonical frontmatter fields - #735
docs: fill missing description and canonical frontmatter fields#735Iheanacho-ai wants to merge 1 commit into
Conversation
|
Reviewed alongside #733, since they overlap heavily. Two things worth knowing before this goes further. 1. All 114 canonical additions here are byte-identical to #733's generated output. I compared every overlapping file: 114 in common, zero disagreements on the value. So the canonical half of this PR is the hand-maintained version of something #733 makes a tool for. The 43 2. The v1.13 premise has expired, and 50 v1.14 pages point backward as a result. "v1.13 (latest stable)" and "v1.14 for pages that only exist in that unreleased version" were both true when this was written. v1.14.0 is final and in On the general question of pointing a canonical at an unreleased version: here it turned out harmless, because those v1.14 pages were already published and all 52 self-canonicals resolve 200. But the reasoning was fragile rather than correct. A canonical aimed at an unpublished page tells Google the indexable copy is something it can't fetch, which suppresses the page that does exist. Safer rule is that a page canonicalizes to itself until a published successor exists, which is what #733's 3. The conflicts are all against The descriptions themselves are clean. Across all 157 files I verified valid YAML frontmatter, zero duplicate keys, no unquoted colons, no apostrophe quoting hazards, and no content changes anywhere. The diff really is additive as described. Nit: quoting is inconsistent, bare at |
sterlingkoch
left a comment
There was a problem hiding this comment.
See inline comments (most are agent-to-agent comments).
Signed-off-by: Amarachi Iheanacho <amarachi.iheanacho@siderolabs.com>
19bd7ff to
dd4baf1
Compare
|
rebased and updated @sterlingkoch |
What
Backfilled missing
descriptionandcanonicalfrontmatter fields across Talos version pages, plus two unversioned pages missingdescription.Why
Several pages were missing SEO-relevant frontmatter that sibling versions of the same page already had.
Change
descriptionfields — 34 copied from a sibling version's frontmatter for the same page, 9 hand-written where no version had one (learn-more/talos-for-linux-admins,learn-more/talos-platform-configuration, and one Omni + one Kubernetes Guides page).canonicalfields (Talos only) — pointed at each page's v1.13 (latest stable) URL, or v1.14 for pages that only exist in that unreleased version.Testing
make broken-links,make validate-docs-nav,make docs.json(no diff),make style-check-changed-local— all pass, 0 new errors.description:/canonical:lines).