Skip to content

DOC-7120 unit 6: convert kubernetes 7.8.4/ to render hooks - #4135

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

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

Conversation

@andy-stark-redis

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

Copy link
Copy Markdown
Contributor

Summary

Unit 6 of DOC-7120: converts content/operate/kubernetes/7.8.4/ (frozen version snapshot, 62 files) from relref/callout shortcodes to the DOC-6909 render-hook equivalents, using build/migrate_shortcode_links.py all. Implementation-only — no rendered-appearance or behavior change.

  • Files changed: 44 of 62 files under content/operate/kubernetes/7.8.4/ (the other 18 — reference/api/*_api.md, the .tmpl/.patch template files, and a few plain pages — had no relref/callout syntax, as expected).
  • Relrefs converted: 215
  • Callouts converted: 82

Gotcha instances found and hand-fixed

The list-nested/stray-indent callout-continuation bug (script only preserves indentation on a blockquote's header line, not its continuation/closing lines) recurred here too. Fixed by hand in:

  • deployment/openshift/openshift-cli.md — 6 instances (matches every prior snapshot's count)
  • deployment/openshift/old-index.md — 3 instances
  • deployment/quick-start.md — 2 instances (this snapshot's count; prior snapshots varied 2-3)
  • active-active/create-reaadb.md — 2 instances
  • re-clusters/connect-to-admin-console.md — 1 instance
  • logs/collect-logs.md — 1 instance
  • re-clusters/connect-prometheus-operator.md — 1 instance of the non-list-nested stray-indent variant (a bare 4-space-indented callout after a plain paragraph, not inside a list). Per the known gotcha, this was dedented to 0 rather than matched to the header's indentation, since a 4-space indent outside a list is read as a code block in CommonMark, not a blockquote.

All match the pattern (and several the exact files) found in every prior version-snapshot unit of this ticket. No no-slash relref concatenation or missing-close-paren relref instances were found in this snapshot.

Pre-existing DEAD links (not fixed, per scope)

build/check_uncanonicalized_links.py flagged 3 pre-existing broken plain-Markdown links that don't resolve to a real content page (left untouched — a missed rewrite is fine, a wrong one is not):

  • 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

Note: deployment/openshift/old-index.md is entirely wrapped in a {{% comment %}}...{{% /comment %}} shortcode (never rendered), so none of its content — including these dead links and the 3 hand-fixed indentation instances in it — reaches the live site. Converted anyway per instructions to check that file for the recurring gotcha.

Verification

  • Built origin/main (before) and this branch (after) with Hugo in separate scratch directories, foreground, both succeeded cleanly (19645 pages each, identical warning set unrelated to this section).
  • build/diff_rendered_hrefs.py <before> <after> operate/kubernetes/7.8.4: 0 unintended href diffs (65 vs 65 pages compared, 0 added/removed, 0 href-set changes).
  • build/check_uncanonicalized_links.py scoped to content/operate/kubernetes/7.8.4/: 0 FIXABLE, 0 MOUNT_ONLY, 3 DEAD (pre-existing, noted above).
  • Manually inspected the diff for every list-nested/indented callout instance to confirm continuation-line indentation now matches the header line.

Per content/operate/kubernetes/AGENTS.md: no renaming of "Redis Enterprise for Kubernetes" legacy occurrences, no changes to custom-resource identifiers or field paths — this PR touches only relref/callout syntax.

Test plan

  • Hugo build succeeds for both before/after
  • diff_rendered_hrefs.py shows 0 unintended diffs
  • check_uncanonicalized_links.py shows 0 FIXABLE / 0 MOUNT_ONLY
  • Manual diff review of all list-nested callout fixes

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only shortcode-to-Markdown conversion with verified zero unintended href changes; no runtime or product behavior impact.

Overview
This PR migrates the frozen operate/kubernetes/7.8.4/ docs from Hugo relref and callout shortcodes to render-hook–friendly Markdown, without changing prose or operational guidance.

Internal links ({{< relref ... >}}) are rewritten to /content/... file paths (including anchors) across Active-Active, architecture, deployment, networking, clusters, databases, security, upgrade, and related pages.

Admonitions ({{< note >}}, {{< warning >}}, etc.) become GitHub-style blockquotes (> [!NOTE], > [!WARNING], …), with hand fixes where list nesting left continuation lines mis-indented so they would render as code blocks.

{{< image ... >}} and other non-link shortcodes in these files are unchanged. Scope is syntax only for DOC-7120 unit 6; pre-existing dead links in commented/legacy OpenShift pages are out of scope.

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

Converts relref and callout shortcodes under content/operate/kubernetes/7.8.4/
to the DOC-6909 render-hook equivalents (plain canonicalized Markdown links,
`> [!NOTE]`-style blockquotes), using build/migrate_shortcode_links.py's `all`
stage.

Hand-fixed the recurring list-nested/stray-indent callout-continuation-line
bug (the converter only preserves indentation on a blockquote's header line):
deployment/openshift/openshift-cli.md (6), deployment/openshift/old-index.md
(3), deployment/quick-start.md (2), active-active/create-reaadb.md (2),
re-clusters/connect-to-admin-console.md (1), logs/collect-logs.md (1), and
the non-list-nested stray-indent variant in re-clusters/connect-prometheus-operator.md
(1, dedented to 0 rather than matched, since 4-space indent outside a list
reads as a code block).

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

@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 16151b2 into main Sep 28, 2026
100 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-7120-kubernetes-7.8.4 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