Skip to content

DOC-7118 unit 4: convert rc security/ to render hooks - #4120

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

andy-stark-redis merged 1 commit into
mainfrom
DOC-7118-unit4-security

Conversation

@andy-stark-redis

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

Copy link
Copy Markdown
Contributor

Summary

Unit 4 of the DOC-7118 rollout: migrates content/operate/rc/security/ (31 files) off Hugo relref and note/warning/tip/info callout shortcodes to the DOC-6909 render-hook equivalents (plain Markdown links + > [!NOTE] blockquotes). Same pattern as wave 1 (units 1-2, #4118/#4119) and every other product directory already converted under content/operate/ and content/develop/.

  • 29/31 files changed (2 had no relref/callout syntax to convert — confirmed by direct grep, not just the tool's report).
  • 149 relref links and 52 callout shortcodes converted via build/migrate_shortcode_links.py.
  • Hand-fixed 18 nested-callout instances (inside list items, 1-2 levels deep) where the converter left continuation lines detached from the <li> and a spurious trailing > line — verified the fix against rendered HTML <li> nesting, not just the source diff.
  • Normalized one malformed closing tag ({{</ note >}}, space after slash) in saml-integration-auth0.md before conversion so it wouldn't silently survive unconverted.
  • Ran build/check_uncanonicalized_links.py --fix scoped to this unit's files: found and fixed 1 bare /commands link in configure-acls.md; confirmed 0 FIXABLE/MOUNT_ONLY/DEAD remain.
  • Verified all #anchor cross-references into security/access-control/ pages resolve to real headings.

Verification

Built public/ from origin/main and from this branch with real hugo (no --minify), npm install run in both worktrees first. Both builds hit the same pre-existing, unrelated fatal render error on content/develop/clients/hiredis/_index.md (a jupyter-example shortcode missing generated examples.json data) — identical on both sides, so it doesn't affect the comparison; both public/ trees were still fully populated for all pages under operate/rc.

build/diff_rendered_hrefs.py comparing before/after over the operate/rc prefix: 0 href diffs across all 277 pages.

Ref: DOC-7118

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only syntax migration with verified equivalent rendered links; no application or security product behavior changes.

Overview
DOC-7118 unit 4 updates content/operate/rc/security/ (~31 files) so internal links and admonitions use the DOC-6909 render-hook style instead of Hugo.

Links: {{< relref "..." >}} becomes explicit /content/... Markdown paths (including _index.md where needed and preserved #anchor fragments).

Callouts: note / warning / tip shortcodes become GitHub-style blockquotes (> [!NOTE], > [!WARNING], > [!TIP]). Embedded shortcodes such as {{< embed-md "..." >}} and images are unchanged.

Coverage spans the security hub, access control (RBAC, MFA, SAML IdP guides), database security, and network connectivity (VPC peering, PrivateLink, Transit Gateway, PSC, CIDR). The PR description notes bulk conversion via migrate_shortcode_links.py, hand fixes for nested callouts in lists, one /commands link fix, and 0 href diffs in rendered operate/rc output—so this is a markup migration, not a content rewrite.

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

Migrate content/operate/rc/security/ off the relref and note/warning/tip/info
shortcodes, to the DOC-6909 render-hook equivalents (plain Markdown links and
`> [!NOTE]` blockquotes), continuing the site-wide rollout.

Ran build/migrate_shortcode_links.py on all 31 files in this unit (29
changed; 2 had no shortcode syntax to convert). Converted 149 relref
instances and 52 callout shortcodes.

Hand-fixed beyond the automated pass:
- 18 nested callouts (inside list items, indent levels 1-2 deep) where the
  converter only indents the blockquote header line, detaching continuation
  lines from the enclosing <li> and leaving a spurious trailing `>` line at
  the old closing-tag position. Fixed across configure-acls.md,
  active-active-roles.md, create-assign-users.md, tls-ssl.md,
  private-service-connect.md (x3), saml-integration-auth0.md,
  saml-integration-azure-ad.md (x3), saml-integration-okta-generic.md (x4),
  saml-integration-okta-org2org.md, and saml-sso/_index.md (x2). Verified
  against rendered HTML, not just source diff, that each note/warning now
  nests correctly inside its <li>.
- One malformed closing tag `{{</ note >}}` (space after slash) in
  saml-integration-auth0.md, normalized before running the converter so it
  wouldn't silently survive unconverted.
- One bare-`/commands` link (configure-acls.md) caught by
  check_uncanonicalized_links.py --fix; 0 fixable/mount-only/dead findings
  remain afterward.

Verified with a full `hugo` build (no --minify) of both origin/main and this
branch: content/operate/rc has a pre-existing, unrelated fatal render error
on content/develop/clients/hiredis/_index.md (jupyter-example shortcode,
missing examples.json data) that occurs identically on both sides, so it
doesn't block the comparison. diff_rendered_hrefs.py over operate/rc reports
0 href diffs across all 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-unit4-security/operate/rc/security/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/access-management/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/data-access-control/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/data-access-control/active-active-roles/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/data-access-control/configure-acls/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/data-access-control/create-assign-users/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/data-access-control/create-roles/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/data-access-control/default-user/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/data-access-control/role-based-access-control/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/multi-factor-authentication/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/saml-sso/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/saml-sso/saml-integration-auth0/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/saml-sso/saml-integration-aws-identity-center/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/saml-sso/saml-integration-azure-ad/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/saml-sso/saml-integration-google/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/saml-sso/saml-integration-okta-generic/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/saml-sso/saml-integration-okta-org2org/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/saml-sso/saml-integration-ping-identity/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/access-control/social-login/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/aws-privatelink/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/aws-transit-gateway/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/cidr-whitelist/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/database-security/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/database-security/block-public-endpoints/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/database-security/network-security/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/database-security/tls-ssl/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/encryption-at-rest/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/private-service-connect/
https://redis.io/docs/staging/DOC-7118-unit4-security/operate/rc/security/vpc-peering/

@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 f91df62 into main Sep 25, 2026
100 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-7118-unit4-security 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