DOC-7120 unit 8: convert kubernetes 8.0/ to render hooks - #4137
Merged
Merged
Conversation
Convert relref and callout shortcodes to native Markdown render-hook syntax across content/operate/kubernetes/8.0/ (68 of 79 files changed; the rest have no relref/callout syntax to convert). Implementation-only: this is a frozen version snapshot, so the change is scoped to link/callout syntax and doesn't alter rendered appearance or behavior. Hand-fixed the known list-nested callout indentation-loss bug (the converter preserves indentation only on a blockquote's header line, not its continuation/closing lines) in 12 files, 24 instances total: deployment/openshift/openshift-cli.md (6), deployment/quick-start.md (3), security/vault.md (4, incl. the angle-bracket alert-with-title form), upgrade/openshift-cli.md (2), and one each in active-active/create-reaadb.md, active-active/prepare-clusters.md, re-clusters/connect-to-admin-console.md, security/allow-resource-adjustment.md, security/sso.md, upgrade/upgrade-olm.md, upgrade/upgrade-redis-cluster.md. Also dedented a stray non-list 4-space indent in re-clusters/connect-prometheus-operator.md (would otherwise render as a code block, not a blockquote) and cleaned a cosmetic trailing-whitespace continuation line plus a stray leading double-space in upgrade/openshift-cli.md. logs/collect-logs.md, which every prior snapshot flagged for this bug, has none here -- its only two callouts are unindented in this version. Verification: rebuilt origin/main and this branch with Hugo and diffed rendered hrefs (0 unintended diffs across 155 pages incl. flex/, and 0 site-wide); check_uncanonicalized_links.py reports 0 FIXABLE/MOUNT_ONLY/DEAD. Text-content diff (tags stripped) on the most heavily hand-edited pages confirms zero visible-text change. Gotcha along the way: the first "before" baseline build used a fresh `git clone --branch main` of the local repo, which resolved to that repo's local main branch tip (stale, months behind) rather than origin/main -- silently landing on a commit that predates a context-map feature. That missing feature's Tailwind classes were absent from the "before" CSS bundle, so its site-wide asset fingerprint differed from the "after" build's and made every single page look changed in the href diff. Fixed by checking out the exact commit this branch is based on rather than trusting a bare branch name against a local remote. 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 1e3efc5 |
3 tasks
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 8 of DOC-7120: converts
content/operate/kubernetes/8.0/(a frozen version snapshot, includingflex/) fromrelref/callout shortcodes to native Markdown render-hook syntax. Implementation-only — this doesn't change rendered appearance or behavior, which is the explicit scoping decision for this ticket on version snapshots.content/operate/kubernetes/8.0/(the other 11 —reference/api/*_api.md, the.tmpl, and the empty-fields list — have no relref/callout syntax to convert).]({{< relref "X" >}})→](/content/<path>.md[#anchor])).{{< note/warning/tip/info/alert >}}→> [!NOTE]etc. blockquote form).Gotchas found and hand-fixed
The migration script only preserves indentation on a blockquote's header line, not its continuation/closing lines — this bug has recurred in every prior version-snapshot unit of this ticket. Found and fixed 24 list-nested-indentation instances across 12 files:
deployment/openshift/openshift-cli.mddeployment/quick-start.mdsecurity/vault.md{{< alert title="Important notes" >}}form with a 3-line bulleted bodyupgrade/openshift-cli.mdactive-active/create-reaadb.mdactive-active/prepare-clusters.mdre-clusters/connect-to-admin-console.mdsecurity/allow-resource-adjustment.mdsecurity/sso.mdupgrade/upgrade-olm.mdupgrade/upgrade-redis-cluster.mdAlso found and fixed:
re-clusters/connect-prometheus-operator.md: the recurring non-list stray 4-space indent (would render as a code block, not a blockquote). Dedented to 0, matching every prior snapshot's fix.upgrade/openshift-cli.md: a cosmetic trailing-whitespace-only continuation line and a stray leading double-space in the "We recommend upgrading the REC" warning, both artifacts of the source's own pre-existing whitespace quirks.Did not recur here:
logs/collect-logs.md, flagged in every prior snapshot for this bug, has none in8.0/— its two callouts are both unindented (top-level) in this version.security/vault.mdalert conversion: confirmed clean.{{< alert title="Important notes" >}}converts to> [!NOTE] Important noteswith its 3-item bulleted list body intact (after the indentation hand-fix), matching the live tree's unit-2 result exactly.No no-slash relref concatenation or missing-close-paren relref instances found in this snapshot (gotchas 3/4 — checked by hand, none present).
DEAD links
None found —
check_uncanonicalized_links.pyreports 0 DEAD (and 0 FIXABLE, 0 MOUNT_ONLY).Verification
origin/main(before) and this branch (after) with Hugo in separate directories, foreground, both with real (non-symlinked)examples/copies.build/diff_rendered_hrefs.py <before> <after> operate/kubernetes/8.0→ 0 unintended href diffs across all 155 pages (79 files × the/8.0/and/8.0.18/alias forms), includingflex/. Also ran unscoped (whole site) → 0 diffs.build/check_uncanonicalized_links.py content/operate/kubernetes/8.0→ 0 FIXABLE, 0 MOUNT_ONLY, 0 DEAD.security/vault.md,deployment/openshift/openshift-cli.md,deployment/quick-start.md,re-clusters/connect-prometheus-operator.md,upgrade/openshift-cli.md) confirms byte-identical visible text before/after.Note: the first "before" baseline build attempt used a fresh
git clone --branch mainof the local repo, which silently resolved to that repo's stale localmainbranch tip rather thanorigin/main, missing a newer context-map feature — this made the site-wide CSS asset fingerprint differ and every page look "changed" in the href diff. Fixed by checking out the exact commit this branch is based on.Test plan
build/migrate_shortcode_links.py allrun over every file in scopevault.mdalert conversiondiff_rendered_hrefs.pycleancheck_uncanonicalized_links.pyclean🤖 Generated with Claude Code
Note
Low Risk
Documentation-only syntax migration on a version snapshot; no application or operator code changes, with verification aimed at identical rendered hrefs and link health.
Overview
Unit 8 of DOC-7120 updates the frozen
content/operate/kubernetes/8.0/snapshot (includingflex/) so links and callouts use native Markdown instead of Hugo shortcodes—implementation-only, intended to match existing rendered output.Links: ~530
{{< relref "…" >}}references become explicit/content/…paths (with.mdand_index.mdwhere needed, anchors preserved).Callouts: ~124
{{< note/warning/tip/info/alert >}}blocks become GitHub-style alerts (> [!NOTE],> [!WARNING], etc.), with hand fixes for list-nested indentation and a few whitespace quirks in heavily edited pages.Scope is 68 of 79 files under
8.0/; API reference pages and templates without relref/callout syntax are unchanged.Reviewed by Cursor Bugbot for commit 1e3efc5. Bugbot is set up for automated code reviews on this repo. Configure here.