DOC-7120 unit 1: convert kubernetes/release-notes/ to render hooks - #4125
Open
andy-stark-redis wants to merge 1 commit into
Open
andy-stark-redis wants to merge 1 commit into
andy-stark-redis wants to merge 1 commit into
Conversation
Run build/migrate_shortcode_links.py all over content/operate/kubernetes/release-notes/ (122 files) to replace relref and callout shortcodes with native Markdown render-hook equivalents (DOC-6909 series). Hand-fixes beyond the mechanical conversion: - 7-2-4-releases/7-2-4-12-jan25.md: pre-existing broken relref syntax ((text){{<relref ...>}} instead of a markdown link) rendered as literal text with no href; rewrote as a proper [text]({{< relref ... >}}) link before conversion. - previous-releases/k8s-5-4-10-8.md and previous-releases/k8s-6-2-10-34-2022-05.md: list-nested callouts lost their continuation-line indentation during the mechanical callout-to-blockquote conversion, detaching the blockquote from its enclosing <li>; restored the original list-item indentation on the blockquote body/closing lines. 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 1d3a629 |
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 1 of DOC-7120 (https://redislabs.atlassian.net/browse/DOC-7120), continuing the DOC-6909 render-hook migration series. Runs
build/migrate_shortcode_links.py allover every file undercontent/operate/kubernetes/release-notes/(122 files) to replacerelrefand callout shortcodes with native Markdown render-hook equivalents.]( )markdown links + 1 pre-existing broken/bare relref, hand-fixed — see below)note/warning, both{{< >}}and unspaced{{<>}}delimiter forms)Hand-fixed gotchas
Pre-existing broken relref (gotcha 3 — fix trivially in this PR):
content/operate/kubernetes/release-notes/7-2-4-releases/7-2-4-12-jan25.mdhad(7.2.4-12 release notes){{<relref "...">}}.— a bare shortcode call glued onto plainparenthesized text instead of a markdown link, so it rendered as literal text with no
href. Rewrote as
[7.2.4-12 release notes]({{< relref "..." >}}).before running theconverter; it now converts and canonicalizes normally. Confirmed via href diff that
this is the only page whose rendered href set changed (a new href appears where
there was none before — an intentional fix, not a regression).
List-nested callout indentation loss (gotcha 1): two files had a callout nested
inside a list item, with all lines (header, body, close) indented to match. The
mechanical converter only preserves indentation on the blockquote header line, losing
it on continuation/closing lines and detaching the blockquote from its
<li>. Hand-restoredthe original indentation on the blockquote body:
content/operate/kubernetes/release-notes/previous-releases/k8s-5-4-10-8.md(4-space nested{{< note >}})content/operate/kubernetes/release-notes/previous-releases/k8s-6-2-10-34-2022-05.md(2-space nested{{<warning>}})Verified by diffing rendered HTML for both pages: the
</li><li>boundaries around thecallout are identical before/after (list nesting unaffected).
No-slash relref concatenation (gotcha 2): checked programmatically for
]({{< relref "X" >}}literal)with no/,#, or?separator across all 389in-link relrefs in this tree — none found.
Angle-bracket
alertshortcode form: not present in this tree (onlynote/warningcallouts occur here); no special handling was needed.
Known pre-existing issue (not fixed, out of scope for this ticket)
content/operate/kubernetes/release-notes/previous-releases/k8s-5-4-10-8.mdhas two{{< embed-md "force-delete-pods.md" >}}shortcode calls pointing at a file that doesnot exist in this tree. This is an
embed-mdshortcode, not arelref/callout, so it'soutside this ticket's scope — flagging per house style rather than silently fixing.
Verification
origin/mainand this branch in separate worktrees/directories,ran
build/diff_rendered_hrefs.py <before> <after> operate/kubernetes/release-notes:158 vs 158 pages compared, 0 only-in-before, 0 only-in-after, 1 href-set change
(the intentional broken-relref fix above; every other page's href set is byte-identical).
Note: both before/after builds hit a pre-existing, unrelated Hugo error on
content/develop/clients/*(jupyter-exampleshortcodereadFilefailure) — identicalin both builds, confirmed environment/sandbox-related and not caused by this change; the
full
operate/kubernetes/release-notes/output rendered successfully in both regardless.build/check_uncanonicalized_links.py content/operate/kubernetes/release-notes/→
122 files scanned. FIXABLE=0 MOUNT_ONLY=0 DEAD=0.<li>nesting is unchanged for bothlist-nested-callout fixes (see above), and spot-checked several other converted files'
diffs for clean, correct link/callout conversion.
Test plan
build/diff_rendered_hrefs.py— 0 unexpected href diffsbuild/check_uncanonicalized_links.py— 0 FIXABLE, 0 MOUNT_ONLYcontent/operate/kubernetes/AGENTS.md)🤖 Generated with Claude Code
Note
Low Risk
Documentation-only link and callout syntax changes with href verification; no runtime or product behavior changes.
Overview
Migrates ~115 files under
content/operate/kubernetes/release-notes/from Hugorelrefshortcodes to canonical/content/operate/...Markdown paths (including_index.mdwhere needed), and replaces{{< warning >}}/{{< note >}}callouts with> [!WARNING]/> [!NOTE]blockquotes.One pre-existing broken link in
7-2-4-12-jan25.mdis corrected so the “previous release notes” reference is a real markdown link instead of plain text glued to a shortcode.{{< table-children >}}and other non-link shortcodes in these pages are unchanged.This is a render-hook / DOC-6909 mechanical pass only; release-note wording and product naming are not edited.
Reviewed by Cursor Bugbot for commit 1d3a629. Bugbot is set up for automated code reviews on this repo. Configure here.