Skip to content

DOC-7118 unit 1: convert rc top-level/accounts/billing/logs-reports to render hooks - #4118

Merged
andy-stark-redis merged 1 commit into
mainfrom
DOC-7118-unit1-top-level
Sep 25, 2026
Merged

andy-stark-redis merged 1 commit into
mainfrom
DOC-7118-unit1-top-level

Conversation

@andy-stark-redis

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

Copy link
Copy Markdown
Contributor

Summary

Unit 1 of DOC-7118: migrates Hugo relref shortcode links and note/warning/tip/info callout shortcodes to the DOC-6909 render-hook equivalents (plain Markdown links + > [!NOTE] blockquotes) for the top-level, accounts, billing-and-payments, and logs-reports pages under content/operate/rc/ (Redis Cloud). Part of the ongoing DOC-6909→7047→...→7104 shortcode-migration series; this ticket covers content/operate/rc/ specifically.

  • Files changed: 13 of the unit's 16 assigned files (3 files — cloud-archive.md, logs-reports/_index.md, troubleshoot.md — had no relref/callout syntax to convert and are correctly untouched)
  • relref links converted: 137 (0 remaining in the unit's files)
  • Callout shortcodes converted: 9 (note/warning/tip/info → > [!NOTE] etc. blockquotes)
  • Gotchas checked (per prior units' findings):
    • 3 callouts nested inside list items lost their continuation-line indentation during mechanical conversion, detaching them from their <li>. Hand-fixed all 3 (2 in billing-and-payments/_index.md, 1 in rc-quickstart.md) and confirmed correct <li> nesting in the rendered HTML output.
    • No relref-shortcode/trailing-text concatenation defects (>}}[a-zA-Z]) found.
    • build/check_uncanonicalized_links.py --fix content/operate/rc/ found and fixed 2 bare /commands links (in _index.md and rc-quickstart.md); confirmed 0 FIXABLE remain across all of content/operate/rc/ afterward.

Verification

  • Built public/ from origin/main and from this branch with hugo (non-minified; both trees given a real npm install so PostCSS asset hashing doesn't produce false-positive href noise from a missing node_modules).
  • build/diff_rendered_hrefs.py <before> <after> operate/rc: 0 href-set changes across all 278 compared pages.
  • Manually confirmed rendered <li> nesting for all 3 hand-fixed callouts.

Test plan

  • Reviewer spot-checks a few converted pages for readability of the resulting Markdown links/blockquotes
  • Reviewer confirms the 3 hand-fixed nested callouts render correctly on a preview/staging build

Refs DOC-7118.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only link and callout syntax changes; PR verification reports no rendered href diffs for operate/rc.

Overview
Unit 1 of the Redis Cloud shortcode migration (DOC-7118): Hugo relref internal links and note callouts in the first batch of content/operate/rc/ pages are replaced with plain Markdown links (/content/... paths, including anchors and _index.md targets) and > [!NOTE] blockquotes, aligned with the DOC-6909 render-hook approach.

Touched areas include the RC hub (_index.md), accounts, billing-and-payments (including cost report), logs-reports, plus related top-level pages such as quick start, compatibility, resilient apps, supported regions, and Radar. {{< image >}} / embed-md shortcodes are unchanged.

Callouts that lived inside list items were re-indented so they stay nested under the correct <li> (notably in billing and quick start). A couple of Redis commands links were normalized to /content/commands.

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

…o render hooks

Migrate relref shortcode links and note/warning/tip/info callout
shortcodes to DOC-6909 render-hook equivalents (plain Markdown links,
> [!NOTE] blockquotes) across the first unit of content/operate/rc/.

- 137 relref links converted to canonical /content/<path>.md[#anchor] form
- 9 callout shortcodes converted to blockquote callouts
- 3 files had nothing to convert (cloud-archive.md, logs-reports/_index.md,
  troubleshoot.md) and are correctly untouched
- Hand-fixed 3 callouts nested inside list items where the mechanical
  converter dropped continuation-line indentation, detaching them from
  their <li>; verified correct nesting in rendered HTML after the fix
- No missing-slash relref-concatenation defects found
- build/check_uncanonicalized_links.py: 0 FIXABLE remaining
- build/diff_rendered_hrefs.py origin/main vs this branch, scoped to
  operate/rc: 0 href-set changes across 278 pages

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

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

DOC-7118

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

LGTM.

@andy-stark-redis
andy-stark-redis merged commit 3da2cb9 into main Sep 25, 2026
100 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-7118-unit1-top-level branch September 25, 2026 13:59
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