Skip to content

DOC-7120 unit 5: convert kubernetes 7.4.6/ to render hooks - #4134

Merged
andy-stark-redis merged 1 commit into
mainfrom
DOC-7120-kubernetes-7.4.6
Sep 28, 2026
Merged

andy-stark-redis merged 1 commit into
mainfrom
DOC-7120-kubernetes-7.4.6

Conversation

@andy-stark-redis

@andy-stark-redis andy-stark-redis commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Unit 5 of DOC-7120 (continuing the DOC-6909→7047→7055→7059→7074→7079→7080→7086→7089→7104→7118 render-hook migration series). Converts every file under content/operate/kubernetes/7.4.6/ (64 files, 62 markdown) from relref/callout shortcodes to native Markdown render-hook syntax, using build/migrate_shortcode_links.py all.

This is a frozen version snapshot (per content/operate/kubernetes/AGENTS.md's "Versioned content" section) — this conversion is implementation-only syntax and does not change rendered appearance or behavior, matching the DOC-7104 (rs/) precedent for its own frozen snapshots. No prose, terminology, or identifier was reworded.

Changes

  • Files changed: 43 of 62 markdown files (the remaining 19, plus the 2 non-markdown files reference/kubernetes-api-reference-frontmatter.patch and reference/kubernetes-api-reference-template.tmpl, had no relref/callout syntax and the script correctly no-opped on them).
  • relref conversions: 168 occurrences unwrapped and canonicalized to /content/<path>.md[#anchor] form.
  • callout conversions: 81 note/warning/tip/info/alert shortcode instances converted to > [!TYPE] blockquote form.

Gotcha instances found and hand-fixed

The script doesn't preserve indentation on blockquote continuation/closing lines for list-nested callouts. Checked every indented callout in the snapshot by hand. Found and fixed:

  • deployment/openshift/openshift-cli.md — 6 instances (matches unit 3/4's exact file+count prior for this file).
  • deployment/quick-start.md — 2 instances (unit 3/4 found 3 in their copies of this file; this snapshot's copy only has 2 list-nested instances — verified independently rather than assuming the count carried over, per the task's own caution).
  • deployment/openshift/old-index.md — 3 instances (not previously flagged in this ticket; new find in this snapshot).
  • re-clusters/connect-to-admin-console.md — 1 instance.
  • active-active/create-reaadb.md — 2 instances.
  • security/manage-rec-credentials.md — 1 list-nested instance (plus 1 non-list-nested stray 2-space indent, dedented to 0 — see below).
  • logs/collect-logs.md — 1 instance.

Non-list-nested stray indents dedented to 0 (would otherwise become CommonMark indented code blocks, breaking the blockquote):

  • re-clusters/connect-prometheus-operator.md — 1 instance (4-space stray indent, not inside a list).
  • security/manage-rec-credentials.md — 1 instance (2-space stray indent, below the list-continuation threshold for its neighboring numbered list).

Also cleaned up several stray whitespace-only blockquote artifact lines (e.g. a leftover > or > line) that the callout-to-blockquote conversion leaves behind when the original shortcode body had leading/trailing whitespace directly against its closing tag — cosmetic, but tidied while already in the diff for the indentation fix.

No no-slash relref concatenation or missing-close-paren relref instances found in this snapshot.

DEAD links found (not fixed, per house style — flagging rather than deciding)

build/check_uncanonicalized_links.py found 3 pre-existing broken relrefs, unrelated to this conversion:

  • deployment/openshift/old-getting-started-openshift-crdb.md:48 → /operate/platforms/openshift/_index.md
  • deployment/openshift/old-index.md:30 → /operate/rs/installing-upgrading/hardware-requirements.md
  • deployment/openshift/old-index.md:333 → /operate/rs/administering/creating-databases/_index.md

Verification

  • Built origin/main (before) and this branch (after) with Hugo in two separate checkouts, foreground.
  • build/diff_rendered_hrefs.py <before> <after> operate/kubernetes/7.4.6 — 0 href diffs across all 62 pages.
  • build/check_uncanonicalized_links.py content/operate/kubernetes/7.4.6/ — 0 FIXABLE, 0 MOUNT_ONLY, 3 DEAD (listed above).
  • Manually confirmed indentation matches the header line for every list-nested callout instance found, by inspecting the diff directly.

Test plan

  • Confirm the rendered pages under /operate/kubernetes/7.4.6/ look identical to the previous shortcode-based rendering (blockquote callouts nested correctly inside numbered/bulleted list steps).
  • Spot-check deployment/openshift/openshift-cli.md and deployment/quick-start.md for the hand-fixed callout nesting.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only syntax migration in a versioned snapshot with rendered href parity checks; no runtime or product code changes.

Overview
Migrates the frozen operate/kubernetes/7.4.6/ docs snapshot from Hugo relref and callout shortcodes to native Markdown for render hooks—same pattern as earlier units in the DOC-7120 series.

Across 43 markdown files, internal links move from {{< relref ... >}} to canonical /content/... paths (with anchors preserved), and note/warning-style callouts become GitHub-flavored > [!NOTE] / > [!WARNING] blockquotes. Prose and behavior are unchanged; verification reported 0 href diffs when comparing Hugo renders before and after.

Hand-edits fix blockquote indentation where list-nested callouts would break (e.g. deployment/openshift/openshift-cli.md, deployment/quick-start.md, deployment/openshift/old-index.md, several active-active and security pages). A few stray-indented callouts were dedented so they are not treated as code blocks.

Not in scope: three pre-existing broken targets in legacy OpenShift draft pages remain flagged (not retargeted in this PR).

Reviewed by Cursor Bugbot for commit 4810840. Bugbot is set up for automated code reviews on this repo. Configure here.

Runs build/migrate_shortcode_links.py's all-stages pipeline over the
content/operate/kubernetes/7.4.6/ frozen version snapshot (64 files, 62
markdown), converting relref shortcode links and note/warning/tip/info/alert
callouts to native Markdown render-hook syntax. Implementation-only per the
DOC-7104 rs/ frozen-snapshot precedent -- no rendered appearance or behavior
change.

Hand-fixed the same list-nested callout indentation-loss bug found in this
ticket's earlier units, in the same two files the prior units flagged as a
strong prior (deployment/openshift/openshift-cli.md: 6 instances,
deployment/quick-start.md: 2 instances), plus 10 more instances the script
doesn't catch across old-index.md, connect-to-admin-console.md,
create-reaadb.md, manage-rec-credentials.md, and collect-logs.md. Also
dedented two non-list-nested stray indents to 0 (connect-prometheus-operator.md,
manage-rec-credentials.md) that would otherwise have become CommonMark code
blocks, and cleaned up a handful of stray whitespace-only blockquote artifact
lines the script's callout-to-blockquote conversion leaves behind when the
original shortcode's body had leading/trailing whitespace before its closing
tag.

Verified with a two-build Hugo href diff (0 changes across all 62 pages) and
build/check_uncanonicalized_links.py (0 FIXABLE, 0 MOUNT_ONLY, 3 pre-existing
DEAD links, unrelated to this conversion).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor

DOC-7120

@github-actions

Copy link
Copy Markdown
Contributor

Staging links:
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/active-active/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/active-active/create-aa-crdb-cli/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/active-active/create-reaadb/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/active-active/edit-clusters/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/active-active/edit-rerc/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/active-active/global-config/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/active-active/global-db-secret/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/active-active/prepare-clusters/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/delete-custom-resources/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/deployment/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/deployment/container-images/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/deployment/deployment-options/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/deployment/openshift/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/deployment/openshift/old-getting-started-openshift-crdb/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/deployment/openshift/old-index/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/deployment/openshift/openshift-cli/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/deployment/openshift/openshift-operatorhub/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/deployment/quick-start/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/faqs/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/logs/collect-logs/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/networking/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/networking/ingress/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/networking/ingressorroutespec/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/networking/istio-ingress/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/re-clusters/auto-tiering/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/re-clusters/cluster-recovery/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/re-clusters/connect-prometheus-operator/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/re-clusters/connect-to-admin-console/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/re-clusters/expand-pvc/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.4.6/operate/kubernetes/7.4.6/re-clusters/multi-namespace/

@github-actions

Copy link
Copy Markdown
Contributor

@dwdougherty dwdougherty left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTC.

@andy-stark-redis
andy-stark-redis merged commit c43e71b into main Sep 28, 2026
100 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-7120-kubernetes-7.4.6 branch September 28, 2026 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants