Skip to content

DOC-7104: Migrate content/operate/rs/7.8/ (excl. references) to render hooks - #4099

Merged
andy-stark-redis merged 2 commits into
mainfrom
DOC-7104-7.8-rest
Sep 24, 2026
Merged

andy-stark-redis merged 2 commits into
mainfrom
DOC-7104-7.8-rest

Conversation

@andy-stark-redis

@andy-stark-redis andy-stark-redis commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Unit 13 of 15 in the DOC-6909/DOC-7104 shortcode-to-render-hook migration: converts every relref and note/tip/warning/alert callout shortcode under content/operate/rs/7.8/ (clusters/, databases/, installing-upgrading/, monitoring/, networking/, security/, and the top-level pages) to the render-hook equivalents.
  • content/operate/rs/7.8/references/ is out of scope (already done in unit 12, PR DOC-7104: Migrate content/operate/rs/7.8/references/ (incl. rest-api) to render hooks #4096).
  • Ran build/migrate_shortcode_links.py over the 171 in-scope files: 932 relref, 153 callout shortcodes (125 note, 26 warning, 2 tip, 0 alert). 153 files changed, 18 had nothing to convert.
  • Hand-fixed the recurring gotcha from prior units: callout shortcodes indented inside a list item lose their indentation on continuation/closing lines, detaching them from the enclosing <li> and leaving a stray whitespace-only > line. 28 files, 42 blocks affected — fixed by re-indenting every continuation line to match its header's indent and normalizing the trailing blank line to a bare indented >.
  • 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 seen in this file's 7.4 snapshot in the prior unit.
  • Verified 0 rendered href diffs across all 435 pages under operate/rs/7.8 (including references/, untouched but in the fingerprint scope), using the patched build/diff_rendered_hrefs.py from DOC-7104-diff-hrefs-fix (not merged into this diff — confirmed build/ has no changes in this PR).

Flagged, not fixed

new-features-redis-enterprise.md carries 6 relrefs that don't resolve to any real content page (/operate/rs/7.8/developing/crdbs, /operate/modules/{redisbloom,redisjson,redisearch}, /operate/rs/7.8/installing-upgrading/get-started-docker.md, /operate/rs/7.8/security/passwords-users-roles.md#setting-up-ldap). These were already broken before this migration and are left equivalently broken after it. The page also has draft: true, so it never renders. Per content/operate/rs/AGENTS.md "flag rather than decide" — out of mechanical scope.

Test plan

  • build/migrate_shortcode_links.py all run over all 171 in-scope files
  • Hand-verified rendered <li> nesting for indented-callout fixes (add-node.md's tip, create.md's nested-list note) matches before/after
  • Hugo build before/after (no --minify, full site, foreground) both succeed except the known unrelated jupyter-example/develop/clients/* error, reproducing identically on both sides
  • build/diff_rendered_hrefs.py (patched) reports 0 href diffs across all 435 pages under operate/rs/7.8
  • Confirmed git diff --stat origin/main -- build/ is empty (diff-hrefs fix not included in this PR)
  • Team review

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only link and callout syntax changes with zero rendered href diffs reported for the 7.8 tree; no runtime or product behavior changes.

Overview
This PR completes unit 13 of the RS 7.8 shortcode migration (excluding references/, already migrated). Across clusters, databases, and related 7.8 pages, internal relref shortcodes become plain markdown links under /content/..., and Hugo note/tip/warning callouts become GitHub-style > [!NOTE] (and similar) blocks.

The change is largely mechanical; reviewers should spot-check that list-nested callouts still render correctly after re-indentation fixes for continuation lines. image and embed-md shortcodes are unchanged. Pre-existing broken links in draft new-features-redis-enterprise.md were left as-is per team guidance.

Reviewed by Cursor Bugbot for commit b2f1d53. Bugbot is set up for automated code reviews on this repo. Configure here.

…r hooks

Convert every relref and note/tip/warning/alert callout shortcode under
content/operate/rs/7.8/ (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.8/references/ is out of scope (unit 12, PR #4096).

- Ran build/migrate_shortcode_links.py over the 171 in-scope files (932
  relref, 153 callout shortcodes: 125 note, 26 warning, 2 tip, 0 alert;
  153 files changed, 18 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.
  28 files, 42 blocks affected. Fixed by re-indenting every continuation
  line to match its header's indent, and normalizing the trailing
  whitespace-only line to a bare indented `>`.
- 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 this exact file's 7.4 snapshot in the prior unit; did not
  recur in 7.8/references/ (unit 12) but does recur here).
- Verified 0 rendered href diffs across all 435 pages under
  operate/rs/7.8 (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).
- Spot-checked rendered <li> nesting for the indented-callout fixes
  (add-node.md's tip, create.md's 8-space-indented note inside a nested
  list) -- both match between before/after.

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.8/developing/crdbs,
/operate/modules/{redisbloom,redisjson,redisearch},
/operate/rs/7.8/installing-upgrading/get-started-docker.md,
/operate/rs/7.8/security/passwords-users-roles.md#setting-up-ldap) --
already broken before this migration and left equivalently broken after
it (the page also has draft: true, so it never renders), per AGENTS.md
"flag rather than decide."

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

DOC-7104

@github-actions

Copy link
Copy Markdown
Contributor

Staging links:
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/add-node/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/cluster-recovery/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/configure/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/configure/cluster-settings/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/configure/license-keys/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/configure/rack-zone-awareness/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/configure/sync-clocks/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/logging/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/logging/log-security/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/logging/redis-slow-log/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/logging/rsyslog-logging/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/maintenance-mode/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/new-cluster-setup/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/optimize/disk-sizing-heavy-write-scenarios/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/optimize/memtier-benchmark/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/optimize/optimization/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/optimize/oss-cluster-api/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/optimize/turn-off-services/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/optimize/wait/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/remove-node/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/clusters/replace-node/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/databases/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/databases/active-active/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/databases/active-active/connect/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/databases/active-active/create/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/databases/active-active/delete/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/databases/active-active/develop/
https://redis.io/docs/staging/DOC-7104-7.8-rest/operate/rs/7.8/databases/active-active/develop/app-failover-active-active/

@dwdougherty dwdougherty left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few things to fix, but I'll go ahead and approve.

Port 9443 is the default [port configuration]({{< relref "/operate/rs/7.8/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.8/networking/port-configurations.md#https://docs.redis.com/latest/rs/networking/port-configurations#ports-and-port-ranges-used-by-redis-enterprise-software).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bantha poodoo. 💩

Comment on lines +30 to +84
@@ -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.8/installing-upgrading/get-started-docker.md" >}})
on Docker.](/operate/rs/7.8/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.8/security/passwords-users-roles.md#setting-up-ldap" >}}).
Integration](/operate/rs/7.8/security/passwords-users-roles.md#setting-up-ldap).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/content...

…ix, malformed anchor (same as #4095)

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@andy-stark-redis

Copy link
Copy Markdown
Contributor Author

Fixed all three: the bare /commands links (_index.md, security/access-control/redis-acl-overview.md), the new-features-redis-enterprise.md dead-link prefixes (cosmetic — confirmed none of the 6 targets exist regardless of prefix, so this doesn't make them work, just brings them into the same form as the rest of the corpus), and the flush.md malformed anchor (a stray old absolute URL concatenated into the fragment, predating this migration — replaced with the real heading slug from this version's own port-configurations.md). Verified via build/diff_rendered_hrefs.py: only the flush.md anchor changes the rendered href, everything else is confirmed cosmetic.

@andy-stark-redis
andy-stark-redis merged commit d5e8237 into main Sep 24, 2026
99 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-7104-7.8-rest branch September 24, 2026 10:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants