Skip to content

DOC-7118 unit 5: convert rc subscriptions/ to render hooks - #4123

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

andy-stark-redis merged 1 commit into
mainfrom
DOC-7118-unit5-subscriptions

Conversation

@andy-stark-redis

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

Copy link
Copy Markdown
Contributor

Summary

  • Unit 5 of DOC-7118: migrates content/operate/rc/subscriptions/ (16 files) off relref shortcode links and note/warning/tip/info callout shortcodes to the DOC-6909 render-hook equivalents (plain Markdown links + > [!TYPE] blockquotes), matching the pattern established across every other content/operate/ and content/develop/ directory in prior units. Units 1-4 of this ticket are open as PRs DOC-7118 unit 1: convert rc top-level/accounts/billing/logs-reports to render hooks #4118, DOC-7118 unit 2: convert rc api/cloud-integrations/context-engine to render hooks #4119, DOC-7118 unit 4: convert rc security/ to render hooks #4120, DOC-7118 unit 3: convert rc databases/ to render hooks #4121.
  • 16 files changed: 88 relref links converted, 17 callouts converted (4 note, 7 warning, 1 tip, plus the rest already-plain).
  • Two list-nested callouts (bring-your-own-cloud/iam-resources/aws-console.md, maintenance/set-maintenance-windows.md) hit the known indentation-loss bug in the callout-to-blockquote conversion, which detaches the blockquote's continuation/closing lines from their parent <li> and leaves a spurious trailing-whitespace > line. Hand-fixed both so every continuation/closing line matches the header's indent, closing with a bare > at that indent, matching the established convention (verified against content/operate/rs/databases/recover.md). Confirmed correct <li> nesting in the rendered HTML for set-maintenance-windows.md; aws-console.md's canonical page doesn't render its full content in either the before or after build in this environment due to a pre-existing, unrelated network-dependent shortcode (external-json/GetRemote) limitation — confirmed identical in both builds, so not a regression from this change.
  • Checked for the other known unit gotchas: no {{< relref ... >}}suffix (no separating slash) instances, no unusual closing-tag spacing ({{< /warning >}} etc. all matched the converter's regex correctly in this unit's files).

Verification

  • 0 remaining relref/callout shortcodes across all 16 files (grep confirmed).
  • build/check_uncanonicalized_links.py --fix content/operate/rc/: 185 files scanned, FIXABLE=0 MOUNT_ONLY=0 DEAD=0.
  • Real Hugo build comparison (build/diff_rendered_hrefs.py) of origin/main vs this branch, both with npm install run and a working postcss pipeline (fixed a sandboxed-npm-cache permission issue that had silently broken the CSS minification pipeline in earlier verification attempts):
    • Full site: 7235 vs 7235 pages, 0 href diffs.
    • operate/rc scope: 277 vs 277 pages, 0 href diffs.

Test plan

  • python3 build/migrate_shortcode_links.py all <file> run on all 16 files, each confirmed changed via diff against pre-conversion state.
  • Grepped for spaced/unspaced callout forms, list-nested indentation loss, relref-plus-suffix, and unusual closing-tag spacing across the 16 files.
  • build/check_uncanonicalized_links.py --fix content/operate/rc/ — 0 findings.
  • Full-site Hugo build of origin/main (before) and this branch (after), build/diff_rendered_hrefs.py — 0 href diffs, both full-site and operate/rc-scoped.
  • git status/git diff --stat confirm exactly the 16 target files changed, nothing else.

Refs DOC-7118.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only shortcode-to-Markdown migration with verified zero rendered href diffs; no application or runtime code changes.

Overview
Unit 5 of DOC-7118 updates 16 pages under content/operate/rc/subscriptions/ to match the render-hook pattern used elsewhere in operate/ and develop/.

Internal links: Hugo relref shortcodes are replaced with plain Markdown links using canonical /content/operate/... paths (including _index.md, .md, and fragment anchors). Callouts: note, warning, and tip shortcodes become GitHub-style blockquotes (> [!NOTE], > [!WARNING], > [!TIP]).

Two list-nested callouts in bring-your-own-cloud/iam-resources/aws-console.md and maintenance/set-maintenance-windows.md were hand-adjusted so blockquote continuation lines stay aligned with their parent list items after conversion.

Prose and behavior are unchanged; this is a linking/callout format migration only.

Reviewed by Cursor Bugbot for commit 91787ea. 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 the DOC-6909 render-hook equivalents (plain Markdown
links + `> [!TYPE]` blockquotes) across content/operate/rc/subscriptions/.

88 relref links and 17 callouts converted via build/migrate_shortcode_links.py.
Two list-nested callouts (aws-console.md, set-maintenance-windows.md) hit the
known indentation-loss bug in the callout-to-blockquote conversion; hand-fixed
so every continuation/closing line matches the header's indent, closing with
a bare `>` at that indent, per the established convention (verified against
content/operate/rs/databases/recover.md).

Verified: 0 remaining relref/callout shortcodes, 0 uncanonicalized-link
findings via check_uncanonicalized_links.py across all of content/operate/rc/,
and 0 href diffs between a real Hugo build of origin/main vs this branch
(full site: 7235 vs 7235 pages; operate/rc scope: 277 vs 277 pages).

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

Staging links:
https://redis.io/docs/staging/DOC-7118-unit5-subscriptions/operate/rc/subscriptions/
https://redis.io/docs/staging/DOC-7118-unit5-subscriptions/operate/rc/subscriptions/bring-your-own-cloud/
https://redis.io/docs/staging/DOC-7118-unit5-subscriptions/operate/rc/subscriptions/bring-your-own-cloud/cloud-account-settings/
https://redis.io/docs/staging/DOC-7118-unit5-subscriptions/operate/rc/subscriptions/bring-your-own-cloud/iam-resources/
https://redis.io/docs/staging/DOC-7118-unit5-subscriptions/operate/rc/subscriptions/bring-your-own-cloud/iam-resources/aws-console/
https://redis.io/docs/staging/DOC-7118-unit5-subscriptions/operate/rc/subscriptions/bring-your-own-cloud/iam-resources/cloudformation/
https://redis.io/docs/staging/DOC-7118-unit5-subscriptions/operate/rc/subscriptions/bring-your-own-cloud/iam-resources/terraform/
https://redis.io/docs/staging/DOC-7118-unit5-subscriptions/operate/rc/subscriptions/bring-your-own-cloud/resource-tags/
https://redis.io/docs/staging/DOC-7118-unit5-subscriptions/operate/rc/subscriptions/bring-your-own-cloud/subscription-whitelist/
https://redis.io/docs/staging/DOC-7118-unit5-subscriptions/operate/rc/subscriptions/delete-subscription/
https://redis.io/docs/staging/DOC-7118-unit5-subscriptions/operate/rc/subscriptions/maintenance/
https://redis.io/docs/staging/DOC-7118-unit5-subscriptions/operate/rc/subscriptions/maintenance/set-maintenance-windows/
https://redis.io/docs/staging/DOC-7118-unit5-subscriptions/operate/rc/subscriptions/upgrade-essentials-pro/
https://redis.io/docs/staging/DOC-7118-unit5-subscriptions/operate/rc/subscriptions/view-essentials-subscription/
https://redis.io/docs/staging/DOC-7118-unit5-subscriptions/operate/rc/subscriptions/view-essentials-subscription/essentials-plan-details/
https://redis.io/docs/staging/DOC-7118-unit5-subscriptions/operate/rc/subscriptions/view-pro-subscription/

@github-actions

Copy link
Copy Markdown
Contributor

@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 0841216 into main Sep 25, 2026
99 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-7118-unit5-subscriptions 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