Skip to content

DOC-7120 unit 7: convert kubernetes 7.8.6/ to render hooks - #4136

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

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

Conversation

@andy-stark-redis

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

Copy link
Copy Markdown
Contributor

Summary

Unit 7 of DOC-7120 (part of the DOC-6909 render-hook migration series). Converts every file under content/operate/kubernetes/7.8.6/ (a frozen version snapshot) from relref/callout shortcodes to native Markdown render hooks. Implementation-only — no rendered appearance or behavior change, per this ticket's explicit scoping decision for version snapshots.

  • Files changed: 45 of 63 files under content/operate/kubernetes/7.8.6/ (the other 18 — *_api.md reference pages, the .tmpl/.patch template files, and a handful of pages with no relref/callout syntax — were correctly no-ops).
  • relref links converted: 215, canonicalized to /content/<path>.md[#anchor] form.
  • Callouts converted: 84 note/warning shortcodes to > [!NOTE]/> [!WARNING] blockquote form.

Gotcha instances found and hand-fixed

The recurring list-nested callout indentation-loss bug (continuation/closing lines lose the enclosing list's indentation) turned up again, in an overlapping-but-not-identical file set vs. prior units, as expected:

  • deployment/openshift/openshift-cli.md — 6 instances (matches every prior snapshot).
  • deployment/openshift/old-index.md — 3 list-nested instances (matches prior snapshots' count), entirely inside an unrendered {{% comment %}}...{{% /comment %}} block spanning the whole page body — converted anyway for consistency.
  • deployment/quick-start.md — 2 instances (within the 2-3 range seen before).
  • active-active/create-reaadb.md — 2 instances (matches prior snapshots).
  • re-clusters/connect-to-admin-console.md — 1 instance (matches prior snapshots).
  • logs/collect-logs.md — 1 instance (matches prior snapshots).
  • re-clusters/connect-prometheus-operator.md — 1 stray 4-space indent, NOT inside a list (matches every prior snapshot) — dedented to 0 rather than preserved, since a 4-space indent outside a list is read as a code block by CommonMark.
  • Additionally found and cleaned up one trailing-whitespace-only blockquote continuation line in upgrade/openshift-cli.md (top-level, not list-nested, so not a correctness bug, just a cosmetic leftover from the shortcode's original trailing whitespace).

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

DEAD links found (not fixed, per instructions)

check_uncanonicalized_links.py found 3 pre-existing broken relref targets, unresolvable both before and after this change (confirmed the target paths don't exist anywhere in the repo):

  • 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

All three are in draft: true, hidden: true legacy pages. Left as-is per instructions — not this migration's call to fix a content fact.

Verification

  1. Hugo build: both origin/main (before) and this branch (after) built successfully (19,645 pages each).
  2. build/diff_rendered_hrefs.py scoped to operate/kubernetes/7.8.6: 62 vs 62 pages compared, 0 pages only-in-before, 0 only-in-after, 0 href set changes.
  3. build/check_uncanonicalized_links.py scoped to content/operate/kubernetes/7.8.6/: 0 FIXABLE, 0 MOUNT_ONLY, 3 DEAD (pre-existing, noted above).
  4. Manually confirmed indentation is preserved for every list-nested callout instance by inspecting the diff directly, and re-verified programmatically (a script asserting every blockquote continuation line's leading whitespace matches its header line's) — 0 mismatches across the whole tree.

Test plan

  • Review diff for unintended prose/terminology changes (none found in spot checks — legacy "Redis Enterprise for Kubernetes" naming and all custom-resource identifiers preserved verbatim, per content/operate/kubernetes/AGENTS.md).
  • Confirm the 3 pre-existing DEAD links are acceptable to leave as a follow-up rather than blocking this PR.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only mechanical shortcode-to-Markdown conversion in a version snapshot; verified with Hugo build and href diff, no product or runtime impact.

Overview
Migrates the frozen Redis Enterprise for Kubernetes 7.8.6 doc tree from Hugo shortcodes to native Markdown so the site can use render hooks, without changing how pages should read or link.

Internal links: 215 relref usages become explicit /content/... paths (with .md and anchors where needed) across Active-Active, deployment, networking, upgrade, security, and related topics.

Callouts: 84 note/warning shortcodes become GitHub-style > [!NOTE] and > [!WARNING] blockquotes, including list-nested cases that were hand-fixed for indentation (e.g. OpenShift CLI, quick-start, create-reaadb).

Roughly 45 of 63 files under content/operate/kubernetes/7.8.6/ change; API reference and pages with no shortcodes are untouched. Hugo diff checks report no href changes; three pre-existing broken links on draft/hidden legacy OpenShift pages remain unchanged.

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

Converts content/operate/kubernetes/7.8.6/ (frozen version snapshot) from
relref/callout shortcodes to native Markdown render hooks, using
build/migrate_shortcode_links.py's `all` stage plus hand-fixes for the
recurring list-nested callout indentation bug seen in every prior unit of
this ticket.

- 215 relref links canonicalized to /content/<path>.md[#anchor] form.
- 84 note/warning callouts converted to > [!NOTE]/[!WARNING] blockquotes.
- 16 list-nested callout instances needed manual indentation fixes across
  6 files (openshift-cli.md x6, old-index.md x3, quick-start.md x2,
  create-reaadb.md x2, connect-to-admin-console.md x1, collect-logs.md x1),
  plus one stray-4-space non-list note in connect-prometheus-operator.md
  dedented to 0 (matching the pattern found in every prior snapshot), and
  one trailing-whitespace-only continuation line cleaned up in
  upgrade/openshift-cli.md.
- No relref no-slash-concatenation or missing-close-paren instances found
  in this snapshot.
- check_uncanonicalized_links.py reports 0 FIXABLE, 0 MOUNT_ONLY, 3
  pre-existing DEAD relref targets (unresolvable before and after this
  change) in old-index.md and old-getting-started-openshift-crdb.md.

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.6/operate/kubernetes/7.8.6/active-active/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/active-active/create-aa-crdb-cli/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/active-active/create-reaadb/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/active-active/edit-clusters/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/active-active/edit-rerc/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/active-active/global-config/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/active-active/global-db-secret/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/active-active/prepare-clusters/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/architecture/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/architecture/deployment-options/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/deployment/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/deployment/container-images/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/deployment/helm/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/deployment/openshift/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/deployment/openshift/old-getting-started-openshift-crdb/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/deployment/openshift/old-index/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/deployment/openshift/openshift-cli/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/deployment/openshift/openshift-operatorhub/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/deployment/quick-start/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/logs/collect-logs/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/networking/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/networking/ingress/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/networking/ingressorroutespec/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/networking/istio-ingress/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/re-clusters/auto-tiering/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/re-clusters/cluster-recovery/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/re-clusters/connect-prometheus-operator/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/re-clusters/connect-to-admin-console/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/re-clusters/delete-custom-resources/
https://redis.io/docs/staging/DOC-7120-kubernetes-7.8.6/operate/kubernetes/7.8.6/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 4fb2dac into main Sep 29, 2026
100 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-7120-kubernetes-7.8.6 branch September 29, 2026 08:45
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