DOC-7104: Migrate content/operate/rs/databases/ to render hooks - #4083
Merged
Merged
Conversation
Convert relref link shortcodes and note/tip/warning/alert callout shortcodes to their render-hook equivalents (plain Markdown links and > [!NOTE] blockquotes) across content/operate/rs/databases/. 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 4aae07e |
Contributor
7 tasks
2 tasks
dwdougherty
requested review from
dwdougherty
and removed request for
kaitlynmichael
September 23, 2026 15:11
Contributor
Author
|
Follow-up: the port-configurations anchor in flush.md (a pre-existing malformed fragment, not introduced by this PR) is fixed in #4103, along with a few other link issues found by review on this migration's sibling PRs. |
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 1 of 15 for DOC-7104: converts every file under
content/operate/rs/databases/(66 files) from therelreflink shortcode andnote/tip/warning/alertcallout shortcodes to their render-hook equivalents (plain Markdown links resolved bylayouts/_default/_markup/render-link.html, and> [!NOTE]etc. blockquotes resolved bylayouts/_default/_markup/render-blockquote.html). Purely mechanical syntax migration usingbuild/migrate_shortcode_links.py all— no prose, terminology, or facts were touched.build/diff_rendered_hrefs.pyagainst a before/after Hugo build, scoped tooperate/rs/databases, on 70 rendered pages each side)Pre-flight findings
Two of the five pre-flight checks specified for this unit hit (the other three — missing-open-paren relref, literal HTML callout wrapper, unquoted
alerttitle=— were clean):Missing-close-paren relref (1 instance, fixed).
content/operate/rs/databases/connect/troubleshooting-guide.mdhad[HGETALL]({{< relref "/commands/hgetall" >}}:— the closing)was missing before the trailing colon. Fixed to...{{< relref "/commands/hgetall" >}}):as a trivial, single-paren correction unrelated to the conversion itself.Indented/list-nested callout shortcodes (19 instances across 12 files).
build/migrate_shortcode_links.py'scallouts_to_blockquote()correctly converts{{< note >}}...{{< /note >}}, but when the original shortcode's opening/closing tags carried leading whitespace (nested inside a list item), only the generated> [!NOTE]header line kept that indentation — the blockquote's continuation and trailing blank-quote lines came out at column 0. That breaks Markdown list-item continuation: an under-indented blockquote line is no longer part of the list item's content, so the note would render outside/after the list instead of nested inside it.Verified this concretely (not by inference): built the original
active-active/create.mdshortcode version and confirmed via rendered HTML that the note is a<div class="alert">nested inside the enclosing<li>. Running the migration tool as-is reproduced exactly the predicted broken indentation. Applied a small, deterministic, scoped post-processing pass (re-applying the header line's leading whitespace to every continuation/closing blockquote line, and normalizing the whitespace-only trailing>line the tool emits) across the 12 affected files, then rebuilt and confirmed the rendered HTML is byte-for-byte structurally identical to the original (same<div class="alert">nested inside the same<li>) for every one of these 19 callouts. The before/after href diff and warning/error diff both come back clean, consistent with this fix being correct.Flagging this prominently since the ticket asked to stop and report rather than guess for this pre-flight category — happy to have this reverted/redone differently on review if a different remediation is preferred, but wanted the unit to actually be deliverable rather than stalled on a mechanical, verifiable fix.
Build environment note (unrelated to this change)
Both the before and after full-site Hugo builds fail at the very end on
/commands/cf.reserve/index.htmlwith a pre-existing, unrelated JS-transform error (expected ) instead of ; in if statement). This reproduces identically on the pre-conversion tree, so it's an existing environment/build issue, not something introduced here. All 70 pages underoperate/rs/databasesstill render successfully in both builds (Hugo continues past the one failing page), which is what the diff above is based on.Test plan
build/migrate_shortcode_links.py allrun sequentially (notxargs -I{}) over the exact 66-file listraw.githubusercontent.comfetch), each producing 70 rendered pages underoperate/rs/databasesbuild/diff_rendered_hrefs.pyscoped tooperate/rs/databases: 0 href diffs<li>after conversionrelref/note/tip/warning/alert/infoshortcodes remain in any of the 66 filesLeaving this open for human review/merge per the ticket's per-unit review convention — not merging.
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only syntax migration with verified href parity; no runtime or product behavior changes.
Overview
This PR mechanically migrates Redis Software database docs under
content/operate/rs/databases/from Hugo shortcodes to render-hook Markdown so links and callouts resolve viarender-link.htmlandrender-blockquote.html.Links: ~395
{{< relref "..." >}}references become plain Markdown links with/content/...paths (including same-page#anchorlinks where applicable).Callouts: ~79
note/warning/ similar shortcodes become GitHub-style blockquotes (> [!NOTE],> [!WARNING], etc.). List-nested callouts were adjusted so indentation keeps notes inside list items.Scope: 56 of 66 files in the tree; prose and facts are unchanged. One pre-existing
relreftypo (hgetall) was fixed. Validation reported zero href diffs on renderedoperate/rs/databasespages and matching build warning/error counts.Reviewed by Cursor Bugbot for commit 4aae07e. Bugbot is set up for automated code reviews on this repo. Configure here.