DOC-7104: Migrate content/operate/rs/7.4/ (excl. references) to render hooks - #4097
Conversation
…r hooks Convert every relref and note/tip/warning/alert callout shortcode under content/operate/rs/7.4/ (clusters/, databases/, installing-upgrading/, monitoring/, networking/, security/, and the top-level pages) to the 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. content/operate/rs/7.4/references/ is out of scope (unit 10, PR #4094). - Ran build/migrate_shortcode_links.py over the 162 in-scope files (936 relref, 155 callout shortcodes; 145 files changed, 17 had nothing to convert). - Hand-fixed the by-far-most-common gotcha from prior units: callout shortcodes indented inside a list item lose their indentation on continuation/closing lines (not just the header), which detaches them from the enclosing <li> and can leave a stray whitespace-only `>` line. 27 files, ~30 blocks affected. Fixed by re-indenting every continuation line to match its header's indent. - Fixed a pre-existing broken relref in databases/connect/troubleshooting-guide.md (the HGETALL link was missing its closing paren, `>}}:` instead of `>}}):` -- the same bug found in a different frozen version's copy of this exact file in an earlier unit). - Verified 0 rendered href diffs across all 408 pages under operate/rs/7.4 (including references/, untouched but in the fingerprint scope) via the patched build/diff_rendered_hrefs.py from DOC-7104-diff-hrefs-fix (not merged into this diff). Flagged, not fixed (pre-existing content facts, out of mechanical scope): new-features-redis-enterprise.md carries 6 relrefs that don't resolve to any real content page (/operate/rs/7.4/developing/crdbs, /operate/modules/{redisbloom,redisjson,redisearch}, /operate/rs/7.4/installing-upgrading/get-started-docker.md, /operate/rs/7.4/security/passwords-users-roles.md#setting-up-ldap) -- already broken before this migration and left equivalently broken after it, per AGENTS.md "flag rather than decide." Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
🧠 Redis MemoryFound 7 related items from repository history (2 new this commit):
Memory updated at 52842f2 |
dwdougherty
left a comment
There was a problem hiding this comment.
A few things to fix. I'll go ahead and approve.
| Port 9443 is the default [port configuration]({{< relref "/operate/rs/7.4/networking/port-configurations#https://docs.redis.com/latest/rs/networking/port-configurations#ports-and-port-ranges-used-by-redis-enterprise-software" >}}). | ||
| {{< /note >}} | ||
| > [!NOTE] | ||
| > Port 9443 is the default [port configuration](/content/operate/rs/7.4/networking/port-configurations.md#https://docs.redis.com/latest/rs/networking/port-configurations#ports-and-port-ranges-used-by-redis-enterprise-software). |
There was a problem hiding this comment.
Not your fault, but it needs to be fixed.
| @@ -41,17 +41,17 @@ Enterprise is known for. | |||
|
|
|||
| Redis developed and certified these modules for use with Redis Enterprise Software: | |||
|
|
|||
| - [RedisBloom]({{< relref "/operate/modules/redisbloom" >}}) | |||
| - [RedisBloom](/operate/modules/redisbloom) | |||
| - Enables Redis to have a scalable bloom filter as a data type. Bloom | |||
| filters are probabilistic data structures that quickly determine if something is contained within a set. | |||
| - RedisGraph | |||
| - RedisGraph is the first queryable Property Graph database to use sparse | |||
| matrices to represent the adjacency matrix in graphs and linear algebra to query the graph. | |||
| RedisGraph uses [Cypher](https://www.opencypher.org/) as its query language. | |||
| - [RedisJSON]({{< relref "/operate/modules/redisjson" >}}) | |||
| - [RedisJSON](/operate/modules/redisjson) | |||
| - Now you have the convenience JSON as a built-in data type and easily | |||
| able to address nested data via a path. | |||
| - [RediSearch]({{< relref "/operate/modules/redisearch" >}}) | |||
| - [RediSearch](/operate/modules/redisearch) | |||
| - This module turns Redis into a distributed in-memory | |||
| full-text indexing and search beast. | |||
|
|
|||
| @@ -70,7 +70,7 @@ easily and quickly test several containers to build the scalable | |||
| and highly available cluster Redis Enterprise Software is famous for. | |||
|
|
|||
| For more information go to [quick start with Redis Enterprise Software | |||
| on Docker.]({{< relref "/operate/rs/7.4/installing-upgrading/get-started-docker.md" >}}) | |||
| on Docker.](/operate/rs/7.4/installing-upgrading/get-started-docker.md) | |||
|
|
|||
| ## LDAP integration | |||
|
|
|||
| @@ -81,4 +81,4 @@ accounts can be used for administering resources on the cluster via | |||
| command line, Rest API, or admin console. | |||
|
|
|||
| For more information see [LDAP | |||
| Integration]({{< relref "/operate/rs/7.4/security/passwords-users-roles.md#setting-up-ldap" >}}). | |||
| Integration](/operate/rs/7.4/security/passwords-users-roles.md#setting-up-ldap). | |||
…ix, malformed anchor (same as #4095) Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
Fixed all three: the bare |
Summary
Unit 11 of 15 in the DOC-7104 shortcode-to-render-hook migration. Converts every
relrefandnote/tip/warning/alertcallout shortcode undercontent/operate/rs/7.4/—clusters/,databases/,installing-upgrading/,monitoring/,networking/,security/, and the top-level pages (_index.md,troubleshooting.mdn/a here,new-features-redis-enterprise.md,rs-archive.md) — to the render-hook equivalents already in use across units 1-10:relrefshortcode links → plain Markdown links, resolved bylayouts/_default/_markup/render-link.htmlnote/tip/warning/alertcallout shortcodes →> [!NOTE]etc. blockquotes, resolved bylayouts/_default/_markup/render-blockquote.htmlcontent/operate/rs/7.4/references/is explicitly out of scope (already done in unit 10, PR #4094).This is purely mechanical. No prose, terminology, or facts were touched, including the pre-rebrand "Redis Enterprise Software" wording throughout (per
content/operate/rs/AGENTS.md).Real counts (re-grepped, not estimated)
find content/operate/rs/7.4 -name '*.md' | grep -v '/references/')relrefshortcode occurrences → 0 residual> [!TYPE]blockquotes produced (127 NOTE, 3 TIP, 25 WARNING)Findings / hand-fixes
<li>and leaving stray whitespace-only>lines. Found in 27 files (~30 blocks). Hand-fixed by re-indenting every continuation line to match its header's indent, then re-verified via a scripted re-scan (0 remaining mismatches) and the rendered-HTML href diff.databases/connect/troubleshooting-guide.mdhad the same missing-closing-paren HGETALL bug found in a different frozen version's copy of this file in an earlier unit —[HGETALL]({{< relref "/commands/hgetall" >}}:(missing), stray trailing:). Fixed trivially by inserting the missing).new-features-redis-enterprise.mdcarries 6 relrefs that don't resolve to any real content page:/operate/rs/7.4/developing/crdbs,/operate/modules/redisbloom,/operate/modules/redisjson,/operate/modules/redisearch,/operate/rs/7.4/installing-upgrading/get-started-docker.md,/operate/rs/7.4/security/passwords-users-roles.md#setting-up-ldap. These were already broken (targets don't exist undercontent/) before this migration and are left equivalently broken — as plain unresolved paths — after it. PerAGENTS.md, "flag rather than decide": not fixing a content/navigation fact as part of a mechanical shortcode conversion.Verification
--minify, full site, synchronous) before and after, to/tmpscratch dirs.operate/rs/7.4in both builds (this count includesreferences/, untouched but within the fingerprint scope).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 into the worktree for verification only — not part of this diff) scoped tooperate/rs/7.4: 0 pages only-in-before, 0 only-in-after, 0 href-set changes.git diff --stat origin/main -- build/is empty before pushing.Test plan
databases/recover.md,databases/create.md) renders with correct list nestingdatabases/connect/troubleshooting-guide.mdHGETALL link resolves correctly🤖 Generated with Claude Code
Note
Low Risk
Documentation-only link and callout syntax changes with verification that rendered hrefs under
operate/rs/7.4are unchanged; no application or security impact.Overview
Mechanically converts Redis Enterprise Software 7.4 docs (everything under
content/operate/rs/7.4/exceptreferences/) from Hugo shortcodes to Markdown patterns handled by existing render hooks.Internal links:
relrefshortcodes become plain Markdown paths (typically under/content/...), whichrender-link.htmlresolves the same way as before.Callouts:
note,tip, andwarningshortcodes become GitHub-style blockquotes (> [!NOTE], etc.) forrender-blockquote.html. Indented callouts inside list items were re-indented so list nesting still renders correctly.Scope: ~145 files touched; prose and facts unchanged. One trivial relref syntax fix on
databases/connect/troubleshooting-guide.md(HGETALL). Pre-existing broken targets innew-features-redis-enterprise.mdwere left as unresolved paths, per migration rules.Reviewed by Cursor Bugbot for commit 52842f2. Bugbot is set up for automated code reviews on this repo. Configure here.