Skip to content

DOC-7118 unit 7: convert rc rdi/ and the RDI embeds to render hooks - #4187

Merged
andy-stark-redis merged 1 commit into
mainfrom
DOC-7118-unit7-rdi
Oct 2, 2026
Merged

andy-stark-redis merged 1 commit into
mainfrom
DOC-7118-unit7-rdi

Conversation

@andy-stark-redis

@andy-stark-redis andy-stark-redis commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

DOC-7118 unit 7, the last unit. This was held back for the RDI terraform/dashboards work, which has now been cancelled.

Scope

111 relrefs and 18 callouts converted with build/migrate_shortcode_links.py all.

Hand fixes

The three list-nested callouts hit the known indentation-loss bug and were re-indented by hand: two in setup.md and one in use-cases/sql-server-failover.md. In setup.md, the indented {{< note >}} had been rendering outside its numbered list. It now renders inside the last step, which is what the indentation was for. Because of that, CommonMark treats those two lists as loose, so their steps are spaced slightly wider.

Verification

  • build/check_uncanonicalized_links.py on all 16 files: FIXABLE=0, MOUNT_ONLY=0, DEAD=0.
  • build/diff_rendered_hrefs.py, site-wide (not filtered to rc/rdi/, because the embeds appear on integrate/ and 1.19.1 pages too): 7,276 vs 7,276 pages, 0 href-set changes. Both builds came from the same worktree.
  • Rendered <li> nesting checked for the three re-indented callouts.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only link and callout syntax migration with verified href parity; no runtime or security impact.

Overview
Migrates Redis Cloud RDI docs (content/operate/rc/rdi/ and four shared embeds) off Hugo relref and shortcode callouts to the new render-hook style.

Internal links now use explicit /content/... paths (including .md / _index.md where needed) instead of {{< relref ... >}}. Note and warning blocks use GitHub-style > [!NOTE] / > [!WARNING] instead of {{< note >}} / {{< warning >}}.

Hand fixes restore indentation for three callouts nested inside numbered lists (setup.md, sql-server-failover.md) after the automated migration dropped it—so those notes render inside the list steps again (slightly looser list spacing where CommonMark requires it).

No product or procedural content changes beyond link/callout mechanics; embed updates also fix cross-links on already-converted integrate/RDI pages.

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

Converts the 12 tracked files under content/operate/rc/rdi/ (111 relrefs
across these and the embeds, 18 callouts) with build/migrate_shortcode_links.py all.
This unit was held back while the RDI terraform/dashboards work was in flight;
that work has been cancelled.

It also converts the four RDI embeds that still used relref:
rc-rdi-create-rdi-workspace.md, rc-rdi-secrets-permissions.md,
rdi-db-reqs.md and rdi-when-to-use.md. No file in content/embeds/ had been
converted before, because each rollout scoped by content directory. An embed's
relrefs therefore reached already-converted pages under
integrate/redis-data-integration/ and its 1.19.1 archive. The site-wide href
diff covers those pages too, and shows the render-link hook resolves
/content/...md links correctly from inside embed content.

The three list-nested callouts (two in setup.md, one in
use-cases/sql-server-failover.md) hit the known indentation-loss bug and were
fixed by hand. In setup.md the indented shortcode had actually rendered
outside its numbered list. The blockquote now sits inside the last step, as
the indentation intended, which makes those two lists loose (each step gets
a <p>).

Learned: content/embeds/ was outside every rollout's directory scope; render-hook links work inside embeds
Directive: when converting a page, also convert any content/embeds/ file it includes, or the embed's relrefs leak back in
Ticket: DOC-7118
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

DOC-7118

@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

Staging links:
https://redis.io/docs/staging/DOC-7118-unit7-rdi/embeds/rc-rdi-secrets-encryption-permissions
https://redis.io/docs/staging/DOC-7118-unit7-rdi/integrate/redis-data-integration/1.19.1/installation/install-k8s
https://redis.io/docs/staging/DOC-7118-unit7-rdi/integrate/redis-data-integration/1.19.1/installation/install-vm
https://redis.io/docs/staging/DOC-7118-unit7-rdi/integrate/redis-data-integration/1.19.1/installation/reqsummary
https://redis.io/docs/staging/DOC-7118-unit7-rdi/integrate/redis-data-integration/1.19.1/quick-start-guide
https://redis.io/docs/staging/DOC-7118-unit7-rdi/integrate/redis-data-integration/installation/install-k8s
https://redis.io/docs/staging/DOC-7118-unit7-rdi/integrate/redis-data-integration/installation/install-vm
https://redis.io/docs/staging/DOC-7118-unit7-rdi/integrate/redis-data-integration/installation/reqsummary
https://redis.io/docs/staging/DOC-7118-unit7-rdi/integrate/redis-data-integration/quick-start-guide
https://redis.io/docs/staging/DOC-7118-unit7-rdi/integrate/redis-data-integration/when-to-use
https://redis.io/docs/staging/DOC-7118-unit7-rdi/operate/rc/rdi/
https://redis.io/docs/staging/DOC-7118-unit7-rdi/operate/rc/rdi/create-workspace
https://redis.io/docs/staging/DOC-7118-unit7-rdi/operate/rc/rdi/create-workspace/
https://redis.io/docs/staging/DOC-7118-unit7-rdi/operate/rc/rdi/define/
https://redis.io/docs/staging/DOC-7118-unit7-rdi/operate/rc/rdi/faq/
https://redis.io/docs/staging/DOC-7118-unit7-rdi/operate/rc/rdi/networking/
https://redis.io/docs/staging/DOC-7118-unit7-rdi/operate/rc/rdi/networking/aws-privatelink/
https://redis.io/docs/staging/DOC-7118-unit7-rdi/operate/rc/rdi/quick-start
https://redis.io/docs/staging/DOC-7118-unit7-rdi/operate/rc/rdi/quick-start/
https://redis.io/docs/staging/DOC-7118-unit7-rdi/operate/rc/rdi/rds-proxy/
https://redis.io/docs/staging/DOC-7118-unit7-rdi/operate/rc/rdi/setup
https://redis.io/docs/staging/DOC-7118-unit7-rdi/operate/rc/rdi/setup/
https://redis.io/docs/staging/DOC-7118-unit7-rdi/operate/rc/rdi/use-cases/
https://redis.io/docs/staging/DOC-7118-unit7-rdi/operate/rc/rdi/use-cases/sql-server-failover/
https://redis.io/docs/staging/DOC-7118-unit7-rdi/operate/rc/rdi/view-edit/

@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

🧠 Redis Memory

Found 5 related items from repository history (5 new this commit):

Memory updated at 9cb70b6

@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.

LGTC

@andy-stark-redis
andy-stark-redis merged commit 4c69f50 into main Oct 2, 2026
100 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-7118-unit7-rdi branch October 2, 2026 13:53
andy-stark-redis added a commit that referenced this pull request Oct 2, 2026
Runs build/migrate_image_shortcodes.py over the 5 files in
content/operate/rc/rdi/ that use the image shortcode, converting all 51 to
Markdown images (51 bare paths rewritten to site-root /images/...). None
needed skipping, and there are no raw <img> tags in this tree. rdi/ was
deferred from the main rc/ rollout while Terraform/dashboards work was in
flight; that work has since been postponed.

Built under the production baseURL and compared img src/width/alt/class page by
page: no differences, and the rendered shortcode wrappers dropped by exactly
51. #4187 (DOC-7118 unit 7) converts links and callouts in the same five files;
the two merge cleanly in either order.

Ticket: DOC-7128
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
EliShteinman added a commit to EliShteinman/docs that referenced this pull request Oct 3, 2026
Converts the Redis Cloud RDI pages and four RDI embeds from relref and callout shortcodes to render-hook Markdown.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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