Repository navigation
DOC-7120 unit 3: convert kubernetes networking/deployment/recommendations/re-databases/flex/upgrade/logs/architecture/top-level to render hooks - #4132
Merged
Conversation
…ions/re-databases/flex/upgrade/logs/architecture/top-level to render hooks Converts relref and callout shortcodes to native Markdown render-hook syntax across 37 files (of 40 in scope; 3 -- networking/routes.md, recommendations/pod-stability.md, kubernetes-archive.md -- had zero occurrences and are no-ops) using build/migrate_shortcode_links.py's all-stages pipeline. 280 relref links and 76 callout shortcodes converted mechanically. Hand-fixed 12 list-nested callout indentation-loss instances (the known gotcha where the script preserves the blockquote header's leading whitespace but drops it on continuation/closing lines, detaching the callout from its enclosing list item) across 5 files: deployment/openshift/openshift-cli.md (6), deployment/quick-start.md (3), upgrade/openshift-cli.md (1), upgrade/upgrade-olm.md (1), upgrade/upgrade-redis-cluster.md (1). Also cleaned one related whitespace artifact in upgrade/openshift-cli.md (a doubled leading space and a trailing blank blockquote line) left by a source callout whose closing tag had a single leading space before it -- same root cause, non-list-nested so it slipped past the indentation-mismatch detector; fixed to match the corpus's existing single-line-callout style. No no-slash relref concatenations, no missing-close-paren relrefs, and no dead links found in this batch. 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 e6c94a8 |
6 tasks done
This was referenced Sep 28, 2026
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 3 of DOC-7120 (continuing the DOC-6909 render-hook migration series). Converts
relrefand callout shortcodes to native Markdown render-hook syntax across the followingcontent/operate/kubernetes/directories plus two top-level files (40 files in scope):networking/(7),deployment/(7, incl.openshift/subdir),recommendations/(6),re-databases/(5),flex/(5),upgrade/(4),logs/(2),architecture/(2), plus_index.mdandkubernetes-archive.md.Ran
build/migrate_shortcode_links.py all <file>...(all 3 stages: relref-to-plain, callouts-to-blockquote, linkify) over all 40 files.Results
networking/routes.md,recommendations/pod-stability.md,kubernetes-archive.md) had zero relref/callout occurrences and are no-ops, confirmed by hand grep before conversion./content/<path>.md[#anchor]form.note/warning/tip/info, both{{< >}}and unspaced{{<>}}forms) converted to> [!TYPE]blockquotes.Gotchas found and hand-fixed
List-nested callout indentation loss (gotcha 1): the conversion script only preserves indentation on the blockquote header line, not on continuation/closing lines, which detaches the callout from its enclosing list item. Found and hand-fixed 12 instances across 5 files:
content/operate/kubernetes/deployment/openshift/openshift-cli.md(6 instances)content/operate/kubernetes/deployment/quick-start.md(3 instances)content/operate/kubernetes/upgrade/openshift-cli.md(1 instance)content/operate/kubernetes/upgrade/upgrade-olm.md(1 instance)content/operate/kubernetes/upgrade/upgrade-redis-cluster.md(1 instance)Each was fixed by re-indenting every
>continuation line to match its header's leading whitespace (verified against the existing corpus style in e.g.content/operate/rs/databases/create.md), and normalizing the script's>trailing-whitespace artifact (produced when a source callout's closing tag itself had leading indentation) to a clean>.Also cleaned one related whitespace artifact in
content/operate/kubernetes/upgrade/openshift-cli.md: a non-list-nested warning whose closing tag had a single leading space, producing a doubled leading space (> text) and a trailing blank>line with trailing whitespace. Not caught by the indentation-mismatch detector (it's top-level, not list-nested), but same root cause — cleaned to match the single-line-callout style used elsewhere in this batch.No-slash relref concatenation, missing-close-paren relrefs: none found in this batch (checked by hand before and after conversion).
Dead links: none found —
build/check_uncanonicalized_links.pyreports 0 DEAD (see verification below).Verification
Built
origin/main(before, at24289eecc) and this branch (after) with Hugo in two separate directories, foreground. Both builds succeeded with identical page counts (19645 pages). RequireddangerouslyDisableSandboxfor theexternal-jsonshortcode'sraw.githubusercontent.comfetch on an unrelated page (operate/rc/subscriptions/bring-your-own-cloud/iam-resources/aws-console.md), per the known sandbox-network gotcha — unrelated to this migration.build/diff_rendered_hrefs.pyrun once per touched directory, plus once unscoped tooperate/kubernetes(686 pages, covers the top-level_index.mdandkubernetes-archive.md): 0 href diffs everywhere.build/check_uncanonicalized_links.pyscoped to all 40 files:40 files scanned. FIXABLE=0 MOUNT_ONLY=0 DEAD=0.Manually confirmed indentation preservation for all 12 list-nested callout instances via a script that walks every
> [!blockquote header and checks each subsequent>continuation line carries the same leading whitespace — 0 mismatches after fixes.Notes
content/operate/kubernetes/AGENTS.md: no legacy-name ("Redis Enterprise for Kubernetes") renames, no custom-resource-identifier changes. This is purely a shortcode-syntax conversion; no prose, terminology, or identifier was touched.Test plan
diff_rendered_hrefs.pyreports 0 diffs for every touched directory and the wholeoperate/kubernetestreecheck_uncanonicalized_links.pyreports 0 FIXABLE / 0 MOUNT_ONLY / 0 DEAD🤖 Generated with Claude Code
Note
Low Risk
Documentation-only shortcode-to-Markdown conversion; PR verification reports zero href diffs and no dead links in the touched files.
Overview
Continues the DOC-6909 render-hook migration for Redis Enterprise on Kubernetes docs (~40 files under
content/operate/kubernetes/): networking, deployment (incl. OpenShift), recommendations, re-databases, flex, upgrade, logs, architecture, and the section_index.md.Internal links: Hugo
{{< relref "..." >}}shortcodes are replaced with canonical Markdown paths (/content/.../*.md, including#anchors). Callouts:{{< note >}},{{< warning >}}, etc. become GitHub-flavored> [!NOTE]/> [!WARNING]blockquotes (including list-nested cases where indentation was corrected).No product or operator behavior changes—only source syntax so links and admonitions render via Markdown hooks instead of shortcodes.
Reviewed by Cursor Bugbot for commit e6c94a8. Bugbot is set up for automated code reviews on this repo. Configure here.