DOC-7104: Migrate content/operate/rs/7.22/references/ (incl. rest-api) to render hooks - #4093
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
…) to render hooks
Unit 8 of 15: converts the frozen 7.22 references tree (272 files, 189
carrying relref/callout shortcodes) from {{< relref >}} and
{{< note >}}/{{< warning >}} shortcodes to plain markdown links and
> [!NOTE]/> [!WARNING] blockquotes resolved by the DOC-6909 render hooks.
Unlike unit 6 (live tree), this unit's rest-api/ subtree is in scope per
Andy's explicit decision to include all frozen-version content.
Real counts (re-measured by grep, not taken from the ticket estimate):
1176 relref shortcodes, 29 callouts (19 note, 10 warning) across 189 files.
Post-conversion grep confirms 0 remaining shortcode-form instances and
1176+29 in the new forms.
One gotcha instance found and hand-fixed: cli-utilities/rladmin/_index.md
had a {{<note>}} indented inside a numbered list item, with only the
header line indented and the continuation/closing lines flush left (the
known converter limitation). Fixed by re-indenting all blockquote lines to
match the list item and dropping the stray blank `>` artifact line;
verified via rendered HTML that the <li> nesting is unchanged before/after.
No relref-missing-slash or missing-paren instances found in this unit.
Verification: full-site hugo builds before/after (non-minified -- see
below), diffed with the DOC-7104-diff-hrefs-fix build/diff_rendered_hrefs.py
scoped to operate/rs/7.22/references: 270/270 pages compared, 0 href-set
changes.
Build note: `hugo --minify` currently fails site-wide on this checkout with
an unrelated, pre-existing esbuild syntax error while minifying a script on
/commands/cf.reserve (nothing under this unit's path). Confirmed
pre-existing on unmigrated content too, so it isn't something introduced
here. Verification builds therefore ran without --minify; both before and
after used identical flags, and rendered hrefs are unaffected by
minification, so the comparison is still valid. Flagging so the underlying
build issue can be tracked separately.
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 82c1b2f |
Contributor
3 tasks
5 tasks
This was referenced Sep 23, 2026
andy-stark-redis
requested review from
dwdougherty
and removed request for
kaitlynmichael
September 23, 2026 15:19
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
1 participant
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 8 of 15 in the DOC-7104 shortcode-to-render-hook migration (extending DOC-6909 into
content/operate/rs/). This is the first of 8 units covering frozen version snapshots: converts every file undercontent/operate/rs/7.22/references/, includingreferences/rest-api/(in scope for this ticket, unlike unit 6's live-tree exclusion), per Andy's explicit decision that all frozen-version content is in scope.{{< relref "..." >}}→ plain markdown links resolved byrender-link.html{{< note >}}/{{< warning >}}→> [!NOTE]/> [!WARNING]blockquotes resolved byrender-blockquote.htmlcontent/operate/rs/AGENTS.md, this frozen tree still says "Redis Enterprise Software" deliberately).My own counts (re-measured by grep, not the ticket's estimate)
.mdfiles undercontent/operate/rs/7.22/references/(190 of them underrest-api/){{< relref >}}shortcodes → 1176 plain linksnote, 10warning)[!NOTE]/[!WARNING]blockquotes presentGotchas checked
cli-utilities/rladmin/_index.md— a{{<note>}}nested inside a numbered step, where the converter only indented the header line, leaving continuation/closing lines flush left plus a stray blank>artifact. Hand-fixed by re-indenting all blockquote lines to match the list item's nesting and removing the artifact line. Verified via rendered HTML that<li>nesting is identical before/after.?group=pattern present in 7 compatibility/commands pages is the already-handled house-style case (relref's own doc says this is expected), not this gotcha.](relref...)pattern.Build note
hugo --minifycurrently fails site-wide on this checkout with a pre-existing, unrelated esbuild syntax error minifying an inline script on/commands/cf.reserve(confirmed present before any change in this PR, on unmigrated content). Verification builds (before/after) therefore both ran without--minify, using identical flags on both sides — renderedhrefvalues aren't affected by minification, so the href-diff comparison is still valid. Flagging this separately since it blocks the standard--minifyrecipe for every unit until fixed.Test plan
find content/operate/rs/7.22/references -name '*.md' | wc -l→ 272 (190 underrest-api/)build/diff_rendered_hrefs.py(patched version from DOC-7104: Fix diff_rendered_hrefs.py to catch unquoted href attributes #4087, used for verification only, not included in this diff) scoped tooperate/rs/7.22/references: 270/270 pages compared, 0 href-set changesbuild/diff_rendered_hrefs.pyis not part of this PR's diff<li>nesting matches before/after🤖 Generated with Claude Code
Note
Low Risk
Documentation-only mechanical shortcode-to-markdown migration with no runtime or product behavior changes.
Overview
Mechanically migrates the frozen
content/operate/rs/7.22/references/tree (CLI utilities, compatibility tables, client references, andrest-api/) off Hugo shortcodes sorender-link.htmlandrender-blockquote.htmlhandle links and callouts instead.{{< relref >}}cross-references become plain markdown paths under/content/...(including anchors and command links).{{< note >}}/{{< warning >}}become> [!NOTE]/> [!WARNING]blockquotes; the internal-utilities warning on the CLI index and nestedrladminshell note follow the same pattern.No factual or wording edits—only syntax. Other shortcodes such as
table-childrenandembed-mdare unchanged.Reviewed by Cursor Bugbot for commit 82c1b2f. Bugbot is set up for automated code reviews on this repo. Configure here.