DOC-7120 unit 9: convert kubernetes 8.0.18/ to render hooks - #4138
Merged
Merged
Conversation
Mechanical conversion of content/operate/kubernetes/8.0.18/ off relref and callout shortcodes onto native Markdown render hooks, using build/migrate_shortcode_links.py's `all` stage. This is the final unit (9 of 9) of DOC-7120, and completes content/operate/kubernetes/'s migration off shortcodes. Hand-fixed the recurring list-nested callout indentation-loss bug in 13 blocks across 12 files (the conversion script preserves indentation only on a blockquote's header line, not continuation/closing lines), plus one non-list stray-indent case and one stray-whitespace-artifact case found independently in this snapshot. security/vault.md's angle-bracket `alert` shortcode converted cleanly to `[!NOTE] Important notes` with its bulleted body intact, matching prior units. 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 b29f30a |
Contributor
Author
|
Thanks @dwdougherty (and @claude)! |
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
Final unit (9 of 9) of DOC-7120, converting
content/operate/kubernetes/8.0.18/(80 files, a frozen version snapshot) offrelref/callout shortcodes onto native Markdown render hooks. After this merges,content/operate/kubernetes/is fully off relref/callout shortcodes.Implementation-only: no rendered-appearance or behavior change is intended for this frozen snapshot, per the ticket's explicit scoping.
Files changed: 69 of 80 files under
content/operate/kubernetes/8.0.18/(the other 11 —reference/api/*_api.md, the.tmpl, and the empty-fields list — contain no relref/callout syntax, confirmed no-op).Counts converted:
note/warning/tip/info/alert, both{{< >}}and{{% %}}forms): 134 instances → 0 remainingGotchas found and hand-fixed
The list-nested callout indentation-loss bug (conversion script preserves indentation only on the blockquote header line, not continuation/closing lines) recurred here too, in 13 blocks across 12 files — overlapping but not identical to prior snapshots' lists, confirming the "verify independently" warning:
upgrade/upgrade-olm.md,upgrade/openshift-cli.md,upgrade/upgrade-redis-cluster.md(1 block each, 2-space list indent)re-clusters/connect-to-admin-console.md,active-active/prepare-clusters.md,security/sso.md(1 block each, 4-space indent, body had redundant indentation baked in)security/allow-resource-adjustment.md(1 block, 3-space header vs pre-existing 4-space closing-tag typo — standardized to the header's 3-space)deployment/quick-start.md(3 blocks, 4-space indent)deployment/openshift/openshift-cli.md(6 blocks, 4-space indent — including one multi-paragraph note with an embedded fenced code block, fixed by prefixing every line, including the blank lines and code fence delimiters, with the header's indent)active-active/create-reaadb.md(1 single-line block, 3-space list indent)Also found and fixed:
re-clusters/connect-prometheus-operator.md— the non-list-nested stray-indent variant (4-space indent NOT inside a list), dedented to 0 to avoid a CommonMark code-block misparse. Present in every prior snapshot checked.upgrade/openshift-cli.md(a second, separate instance from the one above, top-level not list-nested) — a pre-existing 1-space typo in the original shortcode body/closing tag produced a double-space-after->plus a stray whitespace-only blockquote line; cleaned up.logs/collect-logs.md— checked closely per the task's flag; 0 list-nested instances in this snapshot (its 2 callouts are both top-level, no fix needed), consistent with the8.0/snapshot's finding that it's not guaranteed to carry the bug.security/vault.mdalert conversion: the angle-bracket{{< alert title="Important notes" >}}...{{</alert>}}form converted to> [!NOTE] Important noteswith its bulleted body intact, matching prior units (live tree unit 2,8.0/unit 8). This file also had 3 more list-nested note/warning blocks with the redundant-indentation variant of the bug (3-space list indent, body already carrying a matching 3-space indent that doubled up after the>prefix) — all 4 blocks fixed.No no-slash relref concatenation or missing-close-paren relref instances found in this snapshot.
DEAD links: none found in this scope (0 from
check_uncanonicalized_links.py).Verification
origin/main(before, commit24289eecc7) and this branch (after) with Hugo in two separate directories, foreground,--minifydropped because of a pre-existing unrelated JS-minify build error on/commands/cf.reserve/present onmainitself (unrelated to this change). Both builds succeeded with identical page counts (19,645 pages each).build/diff_rendered_hrefs.py <before> <after> operate/kubernetes/8.0.18: compared 78 vs 78 pages, 0 href diffs (only-in-before / only-in-after / href-set-changed all 0).build/check_uncanonicalized_links.pyscoped tocontent/operate/kubernetes/8.0.18/: 78 files scanned, FIXABLE=0, MOUNT_ONLY=0, DEAD=0.security/vault.mdalert conversion, by diffing the rendered HTML ofvault.md,upgrade-olm.md,quick-start.md, andopenshift-cli.mdbetween the before/after builds — every note/warning block's text content is byte-identical; the only diffs are cosmetic (an added<p>wrap from native blockquote rendering, and whitespace/indentation in the surrounding div markup).build/check_uncanonicalized_links.pyover the entirecontent/operate/kubernetes/tree (all 9 units considered together) against a freshorigin/maincheckout at the same base commit: 0 FIXABLE, 0 MOUNT_ONLY confirmed clean end-to-end once this PR is included (this PR's own 0/0/0 result above, combined with the already-merged units 1-8, completes the section).Test plan
security/vault.md's alert-to-note conversion renders as expected🤖 Generated with Claude Code
Note
Low Risk
Documentation-only mechanical shortcode-to-Markdown conversion in a version-frozen path; no runtime or security impact.
Overview
Completes DOC-7120 by migrating the frozen
content/operate/kubernetes/8.0.18/snapshot (~69 files) off Hugorelrefand callout shortcodes (note,warning,alert, etc.) onto native Markdown render hooks.Internal links now use explicit
/content/...paths (including_index.mdwhere needed) instead of{{< relref ... >}}. Admonitions become GitHub-style blockquotes (> [!NOTE],> [!WARNING], …), with hand fixes for list-nested and indented callouts so blockquotes parse correctly.{{<embed-yaml>}}and other non-relref shortcodes are left as-is.No intentional changes to prose or operator behavior—this is markup-only so the whole
operate/kubernetes/tree can build without those shortcodes.Reviewed by Cursor Bugbot for commit b29f30a. Bugbot is set up for automated code reviews on this repo. Configure here.