Skip to content

DOC-7120 unit 4: convert kubernetes 7.22/ to render hooks - #4133

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

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

Conversation

@andy-stark-redis

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

Copy link
Copy Markdown
Contributor

Summary

Unit 4 of DOC-7120 (continuing the DOC-6909→7047→…→7118 shortcode-migration series). Converts every file under content/operate/kubernetes/7.22/ (the frozen 7.22 version snapshot) from relref/callout shortcodes to native Markdown render-hook syntax, using build/migrate_shortcode_links.py all.

  • 61 of 70 markdown files changed (61/70 had relref or callout syntax; the remaining 9 — including the 4 reference/api/*_api.md files and 2 non-content files — no-op as expected).
  • 453 relref links converted from ]({{< relref "X" >}}) to canonicalized ](/content/<path>.md[#anchor]) form.
  • 95 callout blocks (note/warning/tip/info/alert, both {{< >}} and {{% %}} forms) converted to > [!TYPE] blockquote form.

Gotcha instances found and hand-fixed

List-nested callout indentation loss (the conversion only preserves indentation on the blockquote header line, not continuation/closing lines) — found and fixed in 9 instances across 7 files:

  • re-clusters/connect-to-admin-console.md (1)
  • active-active/prepare-clusters.md (1)
  • security/allow-resource-adjustment.md (1)
  • active-active/create-reaadb.md (1)
  • deployment/openshift/openshift-cli.md (6 instances)
  • deployment/quick-start.md (3 instances)

These four files match unit 3's live-tree findings for the same file basenames (deployment/openshift/openshift-cli.md, deployment/quick-start.md) — confirming this frozen snapshot carries the same pre-migration byte-for-byte content and thus the same bug instances, needing independent fixing here since fixing the live tree doesn't propagate to the frozen copy.

One additional case, re-clusters/connect-prometheus-operator.md, had a stray 4-space indent on its {{<note>}} that was not inside a list (just leftover formatting). Matching that indent would have made CommonMark treat the blockquote as an indented code block, so it was dedented to 0 instead of indent-matched.

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

DEAD links

None found. check_uncanonicalized_links.py reported 0 FIXABLE, 0 MOUNT_ONLY, 0 DEAD.

Verification

  • Built origin/main (before) and this branch (after) with Hugo in two separate directories, both foreground/blocking (19,645 pages each).
  • build/diff_rendered_hrefs.py before after operate/kubernetes/7.22: 70 vs 70 pages compared, 0 pages only-in-before, 0 only-in-after, 0 href-set changes.
  • build/check_uncanonicalized_links.py scoped to content/operate/kubernetes/7.22/: 0 FIXABLE, 0 MOUNT_ONLY, 0 DEAD.
  • Manually inspected every list-nested callout instance found above to confirm continuation-line indentation now matches the header line and the enclosing list item.

This is purely a shortcode-syntax conversion — no prose, terminology, or identifier changes. content/operate/kubernetes/AGENTS.md was reviewed; legacy product name and all custom-resource identifiers/field paths were left untouched.

Test plan

  • build/migrate_shortcode_links.py all run over all 70 files in scope
  • 0 remaining relref or callout shortcodes in content/operate/kubernetes/7.22/
  • Hand-fixed all list-nested callout indentation regressions found
  • Before/after Hugo builds succeeded
  • diff_rendered_hrefs.py: 0 diffs
  • check_uncanonicalized_links.py: 0 FIXABLE / 0 MOUNT_ONLY / 0 DEAD

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only link and callout syntax migration with no runtime or product behavior changes; main risk is broken links if paths were wrong, which the PR claims was verified with Hugo diff and link checks.

Overview
Converts the frozen content/operate/kubernetes/7.22/ snapshot from Hugo relref links and note/warning shortcodes to native Markdown: canonical /content/.../*.md hrefs (including anchors) and > [!NOTE] / > [!WARNING] blockquotes.

The change is mechanical across the 7.22 tree (index pages, Active-Active, deployment, networking, re-clusters, etc.); prose and API identifiers are unchanged. A follow-up pass re-indents list-nested callouts in a handful of files (e.g. quick-start.md, openshift-cli.md, prepare-clusters.md) so blockquotes stay inside list items after conversion.

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

Runs build/migrate_shortcode_links.py all over every file under
content/operate/kubernetes/7.22/ (the frozen version snapshot), converting
relref shortcodes to plain canonicalized Markdown links and note/warning/
tip/info/alert callout shortcodes to native blockquote render-hook syntax.

Hand-fixed list-nested callout indentation loss (the conversion only
preserves indentation on the blockquote header line, not continuation
lines) in 7 files: re-clusters/connect-to-admin-console.md,
active-active/prepare-clusters.md, security/allow-resource-adjustment.md,
deployment/openshift/openshift-cli.md (6 instances),
deployment/quick-start.md (3 instances), active-active/create-reaadb.md,
and re-clusters/connect-prometheus-operator.md. The last one was not
list-nested but had a stray 4-space indent unrelated to any enclosing
list, which would make CommonMark treat the blockquote as an indented
code block; dedented it to 0 instead of matching it.

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.22/operate/kubernetes/7.22/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/active-active/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/active-active/create-aa-crdb-cli/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/active-active/create-reaadb/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/active-active/edit-clusters/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/active-active/edit-rerc/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/active-active/global-config/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/active-active/global-db-secret/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/active-active/prepare-clusters/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/architecture/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/architecture/deployment-options/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/deployment/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/deployment/container-images/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/deployment/helm/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/deployment/openshift/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/deployment/openshift/openshift-cli/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/deployment/openshift/openshift-operatorhub/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/deployment/quick-start/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/logs/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/logs/collect-logs/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/networking/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/networking/database-connectivity/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/networking/ingress/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/networking/ingressorroutespec/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/networking/istio-ingress/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/re-clusters/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/re-clusters/auto-tiering/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/re-clusters/cluster-recovery/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/re-clusters/connect-prometheus-operator/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.22/operate/kubernetes/7.22/re-clusters/connect-to-admin-console/

@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. (Looks good to Claude.)

@andy-stark-redis
andy-stark-redis merged commit 3d822c6 into main Sep 28, 2026
100 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-7120-kubernetes-7.22 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