DOC-7104: Migrate content/operate/rs/clusters/ and top-level files to render hooks - #4090
Open
andy-stark-redis wants to merge 2 commits into
Open
andy-stark-redis wants to merge 2 commits into
andy-stark-redis wants to merge 2 commits into
Conversation
… render hooks Convert relref link shortcodes and note/tip/warning/alert callout shortcodes to render-hook equivalents (plain Markdown links resolved by layouts/_default/_markup/render-link.html, and > [!NOTE] etc. blockquotes resolved by layouts/_default/_markup/render-blockquote.html) across all 29 files under content/operate/rs/clusters/ plus the 4 top-level files _index.md, troubleshooting.md, new-features-redis-enterprise.md, and rs-archive.md. Purely mechanical syntax migration; no prose, terminology, or facts changed. 198 relref and 21 callout shortcodes converted. 3 of the 33 files (logging/alerts-events.md, optimize/_index.md, rs-archive.md) had no shortcodes to convert. Hand-fixed 10 callout instances (8 files) where the callout was indented inside a list item: the converter preserved indentation on the blockquote's header line only, not its continuation/closing lines, detaching it from the enclosing <li>. Re-indented every line of each affected blockquote to match, and dropped a stray artifact line the converter emitted from the shortcode's indented closing tag. Verified via rendered HTML that list nesting is unchanged before/after. new-features-redis-enterprise.md has draft: true, so Hugo never renders it and it's excluded from the href diff. Manually confirmed its 6 relref targets (/operate/rs/developing/crdbs, /operate/modules/redisbloom, /operate/modules/redisjson, /operate/modules/redisearch, .../get-started-docker.md, .../passwords-users-roles.md#setting-up-ldap) resolve to non-existent pages both before and after this change -- pre-existing broken relrefs the migration preserved verbatim, since a draft page's broken relrefs never trigger Hugo's build-time warning. Flagging rather than fixing, per this being a content/fact question, not a syntax one. diff_rendered_hrefs.py (with the unquoted-href regex fix from DOC-7104-diff-hrefs-fix, not part of this PR) reports 0 href diffs across both the operate/rs/clusters prefix (34 pages) and the full operate/rs prefix (2404 pages), confirming no unrelated pages were touched. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
That file's regex fix lives on branch DOC-7104-diff-hrefs-fix (PR #4087) and was pulled into this worktree for verification only, per the task instructions. git checkout origin/DOC-7104-diff-hrefs-fix -- <path> stages the file as a side effect, and it was swept into the previous commit by a follow-on git add of the content/ directory. This commit restores the file to its pre-existing (unfixed) state so this PR carries only the content/operate/rs/ shortcode migration. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
Contributor
🧠 Redis MemoryFound 5 related items from repository history (5 new this commit):
Memory updated at 97fad3e |
Contributor
4 tasks
This was referenced Sep 23, 2026
andy-stark-redis
requested review from
dwdougherty
and removed request for
kaitlynmichael
September 23, 2026 15:20
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
relreflink shortcodes andnote/tip/warning/alertcallout shortcodes to plain Markdown links and> [!NOTE]-style blockquotes across all 29 files undercontent/operate/rs/clusters/plus 4 top-level files (_index.md,troubleshooting.md,new-features-redis-enterprise.md,rs-archive.md).build/migrate_shortcode_links.py all— no prose, terminology, or facts touched.logging/alerts-events.md,optimize/_index.md,rs-archive.md) had no shortcodes and are unchanged.Findings
add-node.md,cluster-recovery.mdx3,configure/rack-zone-awareness.md,maintenance-mode.md,new-cluster-setup.md,remove-node.md,replace-node.mdx2): the converter preserved indentation on the blockquote's header line only, not its continuation/closing lines, detaching the callout from its enclosing<li>. Hand-fixed by re-indenting every line of each blockquote to match its header and dropping a stray artifact line the converter emitted from the shortcode's indented closing tag. Verified via rendered HTML that<li>nesting is unchanged before/after.content/operate/rs/new-features-redis-enterprise.mdhasdraft: true, so Hugo never renders it and it's excluded from the href diff below. Manually confirmed its 6 relref targets (/operate/rs/developing/crdbs,/operate/modules/redisbloom,/operate/modules/redisjson,/operate/modules/redisearch,/operate/rs/installing-upgrading/get-started-docker.md,/operate/rs/security/passwords-users-roles.md#setting-up-ldap) resolve to non-existent pages both before and after this change — pre-existing broken relrefs that a draft page's build never warns about. This PR preserves them verbatim; flagging rather than fixing since it's a content/fact question, not a syntax one.Verification
build/diff_rendered_hrefs.pypatched with the unquoted-href regex fix fromDOC-7104-diff-hrefs-fix(PR DOC-7104: Fix diff_rendered_hrefs.py to catch unquoted href attributes #4087, not included in this PR — pulled into the worktree for verification only).operate/rs/clustersprefix: 34 vs 34 pages, 0 href diffs.operate/rsprefix (covers the 4 top-level files and confirms no unrelated pages leaked in): 2404 vs 2404 pages, 0 href diffs.Test plan
hugo --minifybuilds the target pages cleanly (pre-existing, unrelated build errors incontent/develop/clients/*and/commands/cf.reserve/occur identically before and after, confirming they're not introduced by this change)build/diff_rendered_hrefs.pyreports 0 diffs for bothoperate/rs/clustersandoperate/rsprefixesrelrefor callout shortcode syntax remains in any of the 33 target filesnew-features-redis-enterprise.md(draft page, excluded from href diff)🤖 Generated with Claude Code
Note
Low Risk
Documentation-only syntax migration with verified equivalent rendered links; no runtime or product code changes.
Overview
This PR continues the DOC-7104 shortcode-to-render-hook migration for Redis Software docs under
content/operate/rs/clusters/plus a few top-level RS pages (_index.md,troubleshooting.md,new-features-redis-enterprise.md).relreflinks are replaced with plain Markdown paths under/content/...(including anchors and_index.mdwhere needed). Callout shortcodes (note,tip,warning) become GitHub-style alerts (> [!NOTE], etc.). In several procedure pages, indented callouts inside list items were re-indented so blockquotes stay nested correctly after conversion.Prose and product behavior are unchanged;
image,multitabs,embed-md, and similar shortcodes are left as-is. Hugo href diff checks reported 0 link changes for the affected sections.Reviewed by Cursor Bugbot for commit 97fad3e. Bugbot is set up for automated code reviews on this repo. Configure here.