DOC-7104: Migrate content/operate/rs/references/ (excl. rest-api) to render hooks - #4091
Open
andy-stark-redis wants to merge 1 commit into
Open
andy-stark-redis wants to merge 1 commit into
andy-stark-redis wants to merge 1 commit into
Conversation
…render hooks
Converts relref link shortcodes to plain Markdown links and note/tip/warning/
alert callout shortcodes to blockquote-form render hooks across the 85 files
under content/operate/rs/references/, excluding references/rest-api/ (OpenAPI-
generated, out of scope for this ticket).
Unusual profile for this unit: unlike prior units in this ticket, this
directory is relref-heavy (685 relref calls across 55 files) and callout-light
(9 callouts across 8 files) -- the reverse of what the ticket anticipated.
Hand-fixes beyond the mechanical script run:
- 1 indentation fix: cli-utilities/rladmin/_index.md had a `{{<note>}}`
shortcode indented inside a numbered list item. The converter preserved the
4-space indent only on the blockquote's `> [!NOTE]` header line, leaving the
continuation and closing lines unindented and detached from the `<li>`.
Verified via rendered HTML that the fix restores identical <li> nesting
to the pre-conversion build.
- 7 relref trailing-slash fixes: compatibility/commands/{cluster,connection,
generic,pub-sub,scripting,server,transactions}.md each had one
`{{< relref "/commands" >}}?group=<x>` link. Relref implicitly appends a
trailing slash before the query string (`/commands/?group=x`, matching the
established convention in content/develop/data-types/_index.md), but the
converter concatenated without it (`/commands?group=x`). Fixed by hand.
Verified with the patched build/diff_rendered_hrefs.py (from
DOC-7104-diff-hrefs-fix, not merged into this branch) plus manual rendered-
HTML spot checks of callout nesting: 0 href diffs across all 289 pages under
operate/rs/references after both hand-fixes.
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 77e4cb4 |
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
Unit 6 of 15 for the DOC-7104 (RS
references/) render-hook migration. Convertsrelreflink shortcodes to plain Markdown links, andnote/tip/warning/alertcallout shortcodes to> [!NOTE]-style blockquotes, across all 85 files undercontent/operate/rs/references/exceptreferences/rest-api/(generated from an engineering-owned OpenAPI spec, explicitly out of scope and untouched).Purely mechanical syntax migration — no prose, terminology, or fact changes.
Profile flag: this unit inverted the ticket's expectation. The ticket described this unit as callout-heavy (~663 callouts) and nearly relref-free (~7 calls). The actual content is the opposite: 685
relrefcalls across 55 files, and only 9 callouts across 8 files (8note, 1warning; notiporalertshortcodes present). Verification effort was reallocated toward relref gotchas accordingly, though both known indentation and relref issues were checked.Hand-fixes beyond the mechanical script run
cli-utilities/rladmin/_index.mdhad a{{<note>}}shortcode indented 4 spaces inside a numbered list item (1. Run: \rladmin`). The converter preserved the 4-space indent only on the blockquote's> [!NOTE]header line, leaving the continuation/closing lines unindented and detached from the. Fixed by hand; verified via rendered HTML that the closingcompatibility/commands/{cluster,connection,generic,pub-sub,scripting,server,transactions}.mdeach had one{{< relref "/commands" >}}?group=<x>link. Hugo'srelrefimplicitly appends a trailing slash before the query string (/commands/?group=x), matching the established convention already live incontent/develop/data-types/_index.md. The converter's stage-1 unwrap concatenated without that slash (/commands?group=x). Fixed by hand to restore/commands/?group=x.title=attributes on callouts found (0 instances) — nothing to verify there.Verification
hugo --minify) into separate output dirs. Both builds hit the same 4 pre-existing, unrelated errors (jupyter-examplereadFileondevelop/clients/*and a JS-minify failure oncommands/cf.reserve, both reproducible on unmodifiedmainunder this sandbox — not caused by this change). All 289 pages underoperate/rs/referencesrendered in both builds.build/diff_rendered_hrefs.py(fromDOC-7104-diff-hrefs-fix/ PR DOC-7104: Fix diff_rendered_hrefs.py to catch unquoted href attributes #4087, pulled in for verification only and not included in this branch) comparing before/after: 0 href diffs across all 289 pages, after both hand-fixes above.Test plan
references/rest-api/is untouched (git diff --statshows no files under that path)rladmin/_index.mdnote still renders nested under its list itemcompatibility/commands/*.mdcommand-reference links still filter the commands index page correctly🤖 Generated with Claude Code
Note
Low Risk
Documentation-only mechanical shortcode-to-Markdown migration with Hugo build and href parity verification; no runtime or API changes.
Overview
Migrates Redis Software
references/docs (excludingrest-api/) from Hugo shortcodes to render-hook–friendly Markdown:{{< relref >}}→/content/...links across alerts, CLI utilities (crdb-cli,redis-cli,rladmin), compatibility pages, and related reference topics, plus{{< note >}}/{{<warning>}}→> [!NOTE]/> [!WARNING]blockquotes.No product or prose changes—syntax only. Follow-up fixes restore list-nested callout indentation in
rladmin/_index.mdand/commands/?group=trailing slashes in seven compatibility command pages so links match prior Hugo behavior.Reviewed by Cursor Bugbot for commit 77e4cb4. Bugbot is set up for automated code reviews on this repo. Configure here.