chore: add canonical-gen make targets and backfill canonical links - #733
chore: add canonical-gen make targets and backfill canonical links#733Iheanacho-ai wants to merge 1 commit into
Conversation
|
Review pass, tooling findings only. The canonical-target question below is the one that needs a decision, the rest are mechanical. 1. The red 2. A compiled binary got committed. 3. The canonical target is v1.13 and should be v1.14, so 52 v1.14 pages now point backward. The tool derives its target from Fix is either 4. Release-notes pages need a tool exclusion. 5. 6. Nit. Worth saying: the self-canonical fallback is fixing a live bug and it's the strongest part of this PR. On current |
sterlingkoch
left a comment
There was a problem hiding this comment.
See inline comments (most are agent-to-agent comments).
48af4dd to
e042216
Compare
Signed-off-by: Amarachi Iheanacho <amarachi.iheanacho@siderolabs.com>
e042216 to
85b8954
Compare
|
fixed @sterlingkoch |
What
Add Make targets to run
tools/canonical-gen, which fills in or corrects thecanonical:frontmatter field on Talos doc pages, and use it to fix all pages currently missing/stale on that field.Why
Auto-generated Talos pages (e.g. from
talosctl docs, version upgrades) don't always get acanonical:link, and older versioned pages need to point at the equivalent page in the current Talos version rather than their own. There was no way to run the existing (but unwired)canonical-gentool.Change
Makefile: addbuild-canonical-gen-container,canonical-links(container),canonical-links-local(local Go build)make canonical-links-local: added/corrected thecanonical:field on 121.mdxfiles underpublic/talos/Testing
make canonical-links-local, by handgo test ./...intools/canonical-gen(8 tests) passes