DOC-7104: Migrate content/operate/rs/7.4/references/ (incl. rest-api) to render hooks - #4094
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
… to render hooks
Unit 10 of 15: converts the frozen 7.4 references tree (246 files, 167
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.
The rest-api/ subtree (169 of the 246 files) is explicitly in scope per
the ticket: it was generated once when 7.4 was frozen and never
regenerated since, so a one-time conversion is safe and permanent.
Real counts (re-measured by grep, not taken from the ticket estimate):
1029 relref shortcodes across 165 files, 20 callouts (16 note, 4 warning,
0 tip/info/alert) across 16 files; 14 files carried both. Post-conversion
grep confirms 0 remaining shortcode-form relref/callout instances except
one pre-existing defect (see below), and 167/246 files touched overall.
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), plus a stray whitespace-only `>` artifact
line left by the closing tag's indentation. Fixed by re-indenting all
blockquote lines to match the list item and dropping the stray line;
verified via rendered HTML that the <li> nesting is unchanged before/after
(alert div closes inside the same <li>, immediately before </ol>, in both
builds).
Flagging, not fixing, a pre-existing defect: cli-utilities/redis-cli/_index.md
line 153 has `[Redis commands reference]({{< relref "/commands/" >}}` with
no closing `)` -- the link was already malformed before this migration
(confirmed via `git show HEAD` on the original), so the relref-to-plain
regex correctly left it unconverted rather than guessing. Left as-is per
"a missed rewrite is fine, a wrong one is not" and the AGENTS.md rule to
flag technical defects rather than silently fix them.
No relref-missing-slash 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.4/references: 244/244 pages compared, 0 href-set
changes. The verification-only patched diff script was staged from
origin/DOC-7104-diff-hrefs-fix, then unstaged and reverted before this
commit; build/diff_rendered_hrefs.py carries no changes here.
Build note: `hugo --minify` currently fails site-wide on this checkout with
a pre-existing esbuild syntax error while minifying a script on
/commands/cf.reserve, unrelated to this unit's path (confirmed pre-existing
in unit 8). Verification builds ran without --minify; both before and after
used identical flags, and rendered hrefs are unaffected by minification, so
the comparison is still valid.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
Contributor
Contributor
🧠 Redis MemoryFound 7 related items from repository history (2 new this commit):
Memory updated at e46f70e |
…x.md The unit-10 subagent correctly left this pre-existing malformed relref (missing its closing paren) unconverted rather than guessing at a fix, per the migration script's by-design behavior. Fixing it here so this unit doesn't leave one relref shortcode behind in an otherwise fully converted file, matching the pattern already applied in units 1 and 2. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This was referenced Sep 23, 2026
3 tasks
7 tasks
andy-stark-redis
requested review from
dwdougherty
and removed request for
kaitlynmichael
September 23, 2026 15:19
dwdougherty
requested changes
Sep 23, 2026
dwdougherty
left a comment
dwdougherty
left a comment
Collaborator
There was a problem hiding this comment.
A few things to check...
| --- | ||
|
|
||
| The `redis-cli` command-line utility lets you interact with a Redis database. With `redis-cli`, you can run [Redis commands]({{< relref "/commands" >}}) directly from the command-line terminal or with [interactive mode](#interactive-mode). | ||
| The `redis-cli` command-line utility lets you interact with a Redis database. With `redis-cli`, you can run [Redis commands](/commands) directly from the command-line terminal or with [interactive mode](#interactive-mode). |
Collaborator
There was a problem hiding this comment.
Bad link. Suggestion is questionable.
Suggested change
| The `redis-cli` command-line utility lets you interact with a Redis database. With `redis-cli`, you can run [Redis commands](/commands) directly from the command-line terminal or with [interactive mode](#interactive-mode). | |
| The `redis-cli` command-line utility lets you interact with a Redis database. With `redis-cli`, you can run [Redis commands](/content/commands) directly from the command-line terminal or with [interactive mode](#interactive-mode). |
| - [Redis CLI documentation]({{< relref "/develop/tools/cli" >}}) | ||
| - [Redis commands reference]({{< relref "/commands/" >}} | ||
| - [Redis CLI documentation](/content/develop/tools/cli.md) | ||
| - [Redis commands reference](/commands/) |
| --- | ||
|
|
||
| The following tables show which Redis Open Source [connection management commands]({{< relref "/commands" >}}?group=connection) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. | ||
| The following tables show which Redis Open Source [connection management commands](/commands?group=connection) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. |
| --- | ||
|
|
||
| The following table shows which Redis Open Source [pub/sub commands]({{< relref "/commands" >}}?group=pubsub) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. | ||
| The following table shows which Redis Open Source [pub/sub commands](/commands?group=pubsub) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. |
| --- | ||
|
|
||
| The following table shows which Redis Open Source [scripting and function commands]({{< relref "/commands" >}}?group=scripting) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. | ||
| The following table shows which Redis Open Source [scripting and function commands](/commands?group=scripting) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. |
| --- | ||
|
|
||
| The following tables show which Redis Open Source [server management commands]({{< relref "/commands" >}}?group=server) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. | ||
| The following tables show which Redis Open Source [server management commands](/commands?group=server) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. |
| --- | ||
|
|
||
| The following table shows which Redis Open Source [transaction commands]({{< relref "/commands" >}}?group=transactions) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. | ||
| The following table shows which Redis Open Source [transaction commands](/commands?group=transactions) are compatible with standard and Active-Active databases in Redis Enterprise Software and Redis Cloud. |
| | Method | Path | Description | | ||
| |--------|------|-------------| | ||
| | [PUT]({{< relref "./backup_reset_status#put-bdbs-actions-backup-reset-status" >}}) | `/v1/bdbs/{uid}/actions/backup_reset_status` | Reset database backup status | | ||
| | [PUT](./backup_reset_status#put-bdbs-actions-backup-reset-status) | `/v1/bdbs/{uid}/actions/backup_reset_status` | Reset database backup status | |
Collaborator
There was a problem hiding this comment.
Bunch of bad/questionable links on this whole page.
Comment on lines
+25
to
+33
| | [GET](./all#get-all-debuginfo) | `/v1/debuginfo/all` | Gets debug info for all nodes | | ||
| | [GET](./all/bdb#get-all-debuginfo-bdb) | `/v1/debuginfo/all/bdb/{bdb_uid}` | Gets debug info for a database from all nodes | | ||
|
|
||
| ## Get debug info for the current node | ||
|
|
||
| | Method | Path | Description | | ||
| |--------|------|-------------| | ||
| | [GET]({{< relref "./node#get-debuginfo-node" >}}) | `/v1/debuginfo/node` | Gets debug info for the current node | | ||
| | [GET]({{< relref "./node/bdb#get-debuginfo-node-bdb" >}}) | `/v1/debuginfo/node/bdb/{bdb_uid}` | Gets debug info for a database from the current node | | ||
| | [GET](./node#get-debuginfo-node) | `/v1/debuginfo/node` | Gets debug info for the current node | | ||
| | [GET](./node/bdb#get-debuginfo-node-bdb) | `/v1/debuginfo/node/bdb/{bdb_uid}` | Gets debug info for a database from the current node | |
Collaborator
There was a problem hiding this comment.
Questionable links here.
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 10 of 15 in the DOC-7104 shortcode-to-render-hook migration: converts every file under
content/operate/rs/7.4/references/(includingrest-api/) from{{< relref >}}and{{< note >}}/{{< warning >}}shortcodes to plain Markdown links and> [!NOTE]/> [!WARNING]blockquotes resolved by the DOC-6909 render hooks (layouts/_default/_markup/render-link.htmlandrender-blockquote.html).The
rest-api/subtree (169 of the 246 files) is explicitly in scope per the ticket: this frozen 7.4 snapshot was generated once and never regenerated, so a one-time conversion is safe and permanent.content/operate/rs/7.4/references/relrefshortcodes across 165 files; 20 callouts (16note, 4warning, 0tip/info/alert) across 16 files; 14 files carried both.cli-utilities/rladmin/_index.mdhad a{{<note>}}indented inside a numbered list item, with only the header line indented by the converter and the continuation/closing lines left flush left, plus a stray whitespace-only>artifact line. Re-indented all blockquote lines to match the list item and dropped the stray line. Verified via rendered HTML (before vs. after) that the<li>nesting is unchanged.cli-utilities/redis-cli/_index.mdline 153 has a markdown link with a relref shortcode but no closing)— confirmed viagit show HEADthat this was already broken before this migration. Left unconverted per "a missed rewrite is fine, a wrong one is not."Verification
hugo --minifycurrently fails site-wide on an unrelated pre-existing esbuild error on/commands/cf.reserve, confirmed pre-existing in unit 8).build/diff_rendered_hrefs.py(patched version fromDOC-7104-diff-hrefs-fix, used for verification only and not included in this diff) scoped tooperate/rs/7.4/references: 244/244 pages compared, 0 href-set changes.build/diff_rendered_hrefs.pycarries no changes in this PR's diff.Test plan
cli-utilities/rladmin/_index.mdand therest-api/callout pages) render correctlycli-utilities/redis-cli/_index.mdis tracked separately if it needs a fix🤖 Generated with Claude Code
Note
Low Risk
Documentation-only link and callout format changes in a static 7.4 snapshot; site build verification reported no href changes in this subtree.
Overview
This PR completes a shortcode-to-Markdown migration for the frozen Redis Enterprise 7.4
references/tree (includingrest-api/), aligning docs with DOC-6909 render hooks instead of Hugo shortcodes.Links:
{{< relref "..." >}}is replaced with plain Markdown URLs (mostly/content/...paths with.mdwhere needed, plus site roots like/commands). Cross-links in CLI reference pages (crdb-cli,redis-cli,rladmin), client references, and compatibility command tables are updated the same way; rendered hrefs are intended to stay unchanged.Callouts:
{{< warning >}},{{< note >}}, and similar shortcodes become GitHub-flavored alert blockquotes (> [!WARNING],> [!NOTE]), including the internal-utilities warning on the CLI utilities index and notes inrladmin(e.g. shell usage, snapshot delete).Scope: Large mechanical sweep across ~167 files;
table-childrenand other shortcodes are left as-is. One nested-list callout inrladmin/_index.mdwas hand-fixed for correct indentation. A pre-existing broken link inredis-cli/_index.mdwas deliberately not touched.Reviewed by Cursor Bugbot for commit e46f70e. Bugbot is set up for automated code reviews on this repo. Configure here.