DOC-7118 unit 6: convert rc changelog/ to render hooks - #4122
Merged
Merged
Conversation
…codes to render hooks Convert content/operate/rc/changelog/** (41 of 47 files had relref/callout syntax to convert; 6 had none and are unchanged no-ops) from Hugo relref shortcode links and note/warning/tip/info callout shortcodes to the DOC-6909 render-hook equivalents: plain Markdown links resolved by render-link.html, and > [!NOTE] etc. blockquotes resolved by render-blockquote.html. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
Contributor
Contributor
🧠 Redis MemoryFound 5 related items from repository history (5 new this commit):
Memory updated at 080f408 |
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
2 participants
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.
Summary
Unit 6 of DOC-7118: converts
content/operate/rc/changelog/**from Hugorelrefshortcode links andnote/warning/tip/infocallout shortcodes to the DOC-6909 render-hook equivalents (plain Markdown links +> [!NOTE]blockquotes). Part of the ongoing series that has already converted every other product directory undercontent/operate/andcontent/develop/. Units 1-4 are open as PRs #4118, #4119, #4120, #4121. Unit 7 (rdi/) is intentionally parked for later._index.md/month pages had no relref or callout syntax and are legitimate no-ops, confirmed by direct grep — not silent tool failures)./content/<path>.md[#anchor]links.notecallouts converted to> [!NOTE]blockquotes (all inmay-2026.mdx2 and2023/august-2023.mdx1).build/check_uncanonicalized_links.py --fixon the unit: found and fixed 12 bare-link instances, all incontent/operate/rc/changelog/2023/march-2023.md— the{{< relref "/commands" >}}?group=Xno-separating-slash idiom (relref's implicit trailing slash followed by a literal?group=suffix), whichmigrate_shortcode_links.py'slinkifystage doesn't canonicalize on its own. Re-ran after fixing: 0 FIXABLE / 0 MOUNT_ONLY / 0 DEAD remain across all 47 files.{{<note>}}), no unusual closing-tag spacing ({{</ note >}}), and spot-checked cross-changelog links (e.g.july-2025.md→version-release-notes/8-0.md,2023/august-2023.md→2024/may-2024.md,2024/november-2024.md→2023/june-2023.md#redis-72-breaking-changes) — all resolve to the correct month/version page and existing anchor.Build verification (the changelog-specific caveat)
build/diff_rendered_hrefs.pyexcludesoperate/rc/changelog/**from href comparison by default because the Hugo build is non-deterministic there even with zero input change. Per the task's required procedure, ran with--no-ignore-noisyand characterized baseline noise first:Step 2 — mainA vs mainB (
origin/mainbuilt twice, no code change),--no-ignore-noisy operate/rc/changelog:Root cause:
2023/march-2023.mdhas headings that embed a Markdown link (e.g.#### [Cluster management commands](...)). Hugo's heading-slug generator bakes the link's rendered href text into the anchor ID, and in the pre-conversion source that text included Hugo's internal per-build raw-shortcode placeholder counter (hugoshortcode3759vshugoshortcode3760between the two identical builds) — i.e., the anchor ID was already unstable build-to-build before any change here.Step 3 — before (mainA) vs after (this branch), same scope:
Same single page, same root cause: converting
{{< relref "/commands" >}}?group=clusterto the literal/content/commands?group=clusterremoves the shortcode-placeholder residue from the anchor slug, so the ID changes from one unstable/garbled form to a stable-but-different one (e.g.#cluster-management-commandshahahugoshortcode3760s1hbhbgroupcluster→#cluster-management-commandscontentcommandsgroupcluster). Confirmed via direct grep of the fullmainAbuild that nothing else in the site links to the old anchor (only the page's own rendered HTML and its owndocs.ndjsonentry contain that string) — so this is accounted-for noise, not a regression, and matches exactly the page/mechanism flagged by the step-2 baseline.No other page in either diff shows a href-set change. Full-site
make cibuilds (page counts, for confirmation) succeeded cleanly fororigin/main(built twice) and this branch — all three builds rendered 19642 pages with no errors, run as separate foreground builds (an earlier attempt to run two builds concurrently caused a spurious template timeout from CPU contention ondevelop/data-types/streams/_index.md, unrelated to this unit's content — resolved by rerunning that build alone).Test plan
build/migrate_shortcode_links.py allrun on all 47 files; diffed each against pre-conversion snapshot to confirm real changes (not silent no-ops) on the 41 that had shortcode syntaxbuild/check_uncanonicalized_links.py --fix— found and fixed 12 bare-link instances, confirmed 0 remain after--no-ignore-noisy operate/rc/changelog, and reconciled (single page, fully explained root cause)make cibuilds succeeded (19642 pages) for bothmainand this branchgit statusconfirms only the 47 files in scope were touched (41 with actual diffs)Refs DOC-7118.
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only link and callout syntax changes under
operate/rc/changelog/; no runtime or security impact beyond possible link/anchor resolution in the new renderer.Overview
Migrates
content/operate/rc/changelog/**to DOC-6909 render hooks: ~202 Hugorelrefshortcodes become canonical Markdown links (/content/.../*.mdwith anchors), and three{{< note >}}callouts become> [!NOTE]blockquotes (2023/august-2023.md,may-2026.md).Coverage spans monthly changelogs (2023–2026) and
version-release-notes/(7.2–8.6).embed-md/imageshortcodes are unchanged.check_uncanonicalized_links --fixadditionally normalized 12 command-group links in2023/march-2023.md(relref+?group=→/content/commands?group=...), which can change heading anchor IDs on that page (already noisy in Hugo builds).Reviewed by Cursor Bugbot for commit 080f408. Bugbot is set up for automated code reviews on this repo. Configure here.