Skip to content

DOC-7118 unit 3: convert rc databases/ to render hooks - #4121

Merged
andy-stark-redis merged 1 commit into
mainfrom
DOC-7118-unit3-databases
Sep 25, 2026
Merged

andy-stark-redis merged 1 commit into
mainfrom
DOC-7118-unit3-databases

Conversation

@andy-stark-redis

@andy-stark-redis andy-stark-redis commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Unit 3 of DOC-7118: migrates relref shortcode links and note/warning/tip/info callout shortcodes to the DOC-6909 render-hook equivalents (plain Markdown links + > [!NOTE] blockquotes) across content/operate/rc/databases/. Wave 1 of this ticket (units 1-2) is in PRs #4118 and #4119; this is unit 3.

  • Files changed: 30 of the 31 files in this unit's scope (content/operate/rc/databases/configuration/_index.md had no relref/callout syntax to convert, so it's untouched).
  • Converted: 351 relref occurrences and 35 callout shortcode blocks, via build/migrate_shortcode_links.py all <files>.
  • Hand-fixed: 8 callout instances nested inside list items (across 6 files) where the converter dropped the continuation-line indent and left a spurious trailing > artifact at the old closing-tag position. Re-indented to match the established rs/ convention (4- or 8-space indent on every blockquote line, terminating > line), then verified against a real Hugo build that the affected pages' <li> nesting still renders correctly.
  • Verification:
    • build/check_uncanonicalized_links.py --fix run scoped to content/operate/rc/databases/: fixed 2 bare /commands links (now /content/commands), confirmed 0 FIXABLE remaining. The only other findings are 3 expected MOUNT_ONLY hits under active-active/develop/_index.md and active-active/_index.md pointing at the rs/-mounted develop-for-aa/data-types//app-failover-active-active files — those are physically in content/operate/rs/databases/active-active/develop/, already converted via DOC-7104, and out of scope here per the ticket's mount scoping note.
    • Full-site Hugo builds of origin/main (before) and this branch (after), diffed with build/diff_rendered_hrefs.py ... operate/rc: 0 href diffs across all 278 operate/rc pages compared.

Note: to get a clean full-site build in this environment, the 5 unrelated pages under content/develop/clients/{nodejs,redis-py,ruby,hiredis} that use the jupyter-example shortcode had to have that shortcode call temporarily stripped in both the before and after checkouts (the shortcode's readFile needs a generated examples/ directory that isn't present in a fresh checkout) — this was reverted before committing and touches no file in this PR's diff.

Test plan

  • build/migrate_shortcode_links.py all <files> run on all 31 unit files; diffed each against pre-conversion state
  • Grepped for known gotchas (indented callouts, >}}-without-slash relrefs, malformed closing-tag spacing) before and after conversion
  • Hand-fixed and re-verified the 8 indented-callout instances found
  • build/check_uncanonicalized_links.py --fix scoped to this unit: 0 FIXABLE remaining
  • Full before/after Hugo build + build/diff_rendered_hrefs.py ... operate/rc: 0 href diffs

Ref: DOC-7118

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only link and callout syntax changes; PR verification reports zero rendered href diffs for operate/rc after full Hugo builds.

Overview
Unit 3 (DOC-7118) updates Redis Cloud databases docs under content/operate/rc/databases/ for DOC-6909 render hooks: Hugo relref links become canonical Markdown paths (mostly /content/...), and note/warning/tip-style shortcodes become GitHub-flavored > [!NOTE] / > [!WARNING] blockquotes.

Roughly 30 pages are touched (indexes, Active-Active, create/view/migrate/monitor, configuration, connect, version management, etc.). Prose and Hugo embeds ({{< image >}}, {{< embed-md >}}, multitabs) are unchanged. A few list-nested callouts were re-indented manually so list markup still renders correctly. A small number of links to rs-mounted Active-Active develop paths stay as site paths (e.g. /operate/rc/...) rather than /content/..., per existing mount scoping.

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

Migrate relref shortcode links and note/warning/tip/info callout
shortcodes to plain Markdown links and > [!NOTE] blockquotes across
content/operate/rc/databases/ (30 of 31 listed files changed; the
31st, configuration/_index.md, had nothing to convert).

Hand-fixed 8 callout instances nested inside list items where the
converter dropped the continuation-line indent and left a spurious
trailing '>' artifact at the old closing-tag position, matching the
established rs/ convention (4/8-space indent on every blockquote
line, terminating '    >' line).

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

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

DOC-7118

@github-actions

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

Staging links:
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/active-active/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/active-active/create-active-active-database/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/active-active/develop/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/active-active/manage-regions/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/back-up-data/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/configuration/advanced-capabilities/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/configuration/clustering/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/configuration/data-eviction-policies/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/configuration/data-persistence/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/configuration/high-availability/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/configuration/sizing/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/connect/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/connect/insight-cloud/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/create-database/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/create-database/create-essentials-database/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/create-database/create-flex-database/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/create-database/create-free-database/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/create-database/create-pro-database-existing/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/create-database/create-pro-database-new/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/delete-database/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/flush-data/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/import-data/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/migrate-databases/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/monitor-performance/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/redirect-endpoints/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/tag-database/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/version-management/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/version-management/upgrade-version/
https://redis.io/docs/staging/DOC-7118-unit3-databases/operate/rc/databases/view-edit-database/

[Learn more about
synchronization for
each supported data type]({{< relref "/operate/rc/databases/active-active/develop/data-types/" >}}) and [how to develop applications]({{< relref "/operate/rc/databases/active-active/develop/develop-for-aa" >}}) with them on Redis Cloud. No newline at end of file
each supported data type](/operate/rc/databases/active-active/develop/data-types/) and [how to develop applications](/operate/rc/databases/active-active/develop/develop-for-aa) with them on Redis Cloud. No newline at end of file

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.

I'm surprised these links work (no .md extension). 🤔

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Both targets (active-active/develop/data-types/ and develop-for-aa) are mount-only — they're a Hugo module mount of content/operate/rs/databases/active-active/develop/ (see config.toml), so there's no real file under content/operate/rc/ for the converter to resolve to a /content/<path>.md target. build/check_uncanonicalized_links.py correctly reports these as MOUNT_ONLY and leaves them as bare paths rather than guessing — same rationale as its own mount-avoidance for _find_content_file. Confirmed functionally fine: the site-wide href diff for this exact page came back 0 changes, so the rendered link target is byte-identical to the pre-conversion relref output. Every other link on this page that resolves to a real content file did get the full /content/...md treatment.

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

Just one comment (nothing to fix). LGTM.

@andy-stark-redis
andy-stark-redis merged commit 522fedc into main Sep 25, 2026
100 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-7118-unit3-databases branch September 25, 2026 14:00
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