Skip to content

DOC-7118 unit 2: convert rc api/cloud-integrations/context-engine to render hooks - #4119

Merged
andy-stark-redis merged 1 commit into
mainfrom
DOC-7118-unit2-api-integrations
Sep 25, 2026
Merged

andy-stark-redis merged 1 commit into
mainfrom
DOC-7118-unit2-api-integrations

Conversation

@andy-stark-redis

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

Copy link
Copy Markdown
Contributor

Summary

Part of the DOC-7118 render-hook migration series (continuing DOC-6909 → 7047 → 7055 → 7059 → 7074 → 7079 → 7080 → 7086 → 7089 → 7104), converting content/operate/rc/ (Redis Cloud). This unit covers content/operate/rc/api/, content/operate/rc/cloud-integrations/, and content/operate/rc/context-engine/ — 31 files in scope.

  • 23 files changed (the remaining 8 had no relref/callout syntax to convert — confirmed by diffing every file against its pre-conversion state, not just trusting the tool's printed message).
  • 119 relref shortcode links converted to plain Markdown links.
  • 18 callout shortcodes (note/warning/tip/info) converted to > [!TYPE] blockquotes.
  • Ran build/migrate_shortcode_links.py all on every file, then hand-fixed two variants the mechanical converter can't parse:
    • content/operate/rc/cloud-integrations/vercel.md: a {{</ warning >}} closing tag with a space after the slash didn't match the converter's regex, leaving that callout unconverted. Normalized the closing tag and reran the converter.
    • content/operate/rc/cloud-integrations/aws-marketplace/_index.md and content/operate/rc/cloud-integrations/gcp-marketplace/_index.md: a note callout nested inside a 1. list item lost its continuation-line indentation after conversion, detaching it from the list. Re-indented the blockquote body to match the list item's continuation indent, and dropped a spurious empty > line caused by trailing whitespace before the original closing shortcode tag.
  • Ran build/check_uncanonicalized_links.py --fix scoped to the touched directories: 0 FIXABLE / 0 MOUNT_ONLY / 0 DEAD remain.
  • No bare /operate/... or un-canonicalized /commands links left behind (checked directly; the API pages' legitimate bare /commands references are expected and unaffected).

Verification

Built public/ from origin/main and from this branch with hugo --gc (no --minify, matching the documented pre-existing esbuild issue) and compared rendered href sets with build/diff_rendered_hrefs.py:

  • Restricted to operate/rc: 0 href diffs across all 278 compared pages.
  • Whole-site comparison: 0 href diffs across all 7231 compared pages (52 known-nondeterministic redisvl/changelog pages excluded per existing tooling).
  • Hit two environment artifacts along the way that are not real regressions and are called out here for the record: a fresh worktree's missing node_modules broke PostCSS the first time (fixed with npm install), and one unrelated page (operate/rc/subscriptions/bring-your-own-cloud/iam-resources/aws-console) flickered in/out of two consecutive builds of the identical after tree — confirmed as pre-existing Hugo build nondeterminism, not something this change caused.

References DOC-7118.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only shortcode-to-Markdown conversion with verified equivalent rendered links; no application or API behavior changes.

Overview
Continues the DOC-7118 render-hook migration for Redis Cloud docs under api/, cloud-integrations/, and context-engine/ (23 files touched).

Internal links: Hugo {{< relref "..." >}} shortcodes are replaced with plain Markdown links using /content/operate/... paths (including API reference anchors and section fragments).

Callouts: Hugo note / warning / info shortcodes become GitHub-style blockquotes (> [!NOTE], > [!WARNING], > [!INFO]). A few spots were fixed manually where the converter missed a malformed closing tag (vercel.md) or list indentation for nested notes (AWS/GCP marketplace pages).

Image, embed, and other shortcodes are unchanged. PR verification reports no rendered href diffs for the affected operate/rc pages.

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

…render hooks

Migrates relref shortcode links and note/warning/tip/info callout
shortcodes to render-hook equivalents (plain Markdown links and
> [!NOTE] blockquotes) across content/operate/rc/api/,
content/operate/rc/cloud-integrations/, and content/operate/rc/context-engine/.

Ran build/migrate_shortcode_links.py's all-stages pass, then hand-fixed
two variants the mechanical converter can't parse: a `{{</ warning >}}`
closing tag with a space after the slash (vercel.md), and two note
callouts nested inside `1.` list items whose continuation lines lost
list indentation after conversion (aws-marketplace/_index.md,
gcp-marketplace/_index.md).

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-unit2-api-integrations/operate/rc/api/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/api/examples/audit-system-logs/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/api/examples/back-up-and-import-data/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/api/examples/create-database/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/api/examples/dryrun-cost-estimates/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/api/examples/generate-cost-report/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/api/examples/manage-cloud-accounts/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/api/examples/manage-subscriptions/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/api/get-started/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/api/get-started/enable-the-api/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/api/get-started/manage-api-keys/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/api/get-started/manage-tasks/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/api/get-started/process-lifecycle/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/api/get-started/use-rest-api/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/cloud-integrations/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/cloud-integrations/aws-marketplace/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/cloud-integrations/gcp-marketplace/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/cloud-integrations/gcp-marketplace/team-management/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/cloud-integrations/vercel/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/context-engine/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/context-engine/agent-memory/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/context-engine/context-retriever/
https://redis.io/docs/staging/DOC-7118-unit2-api-integrations/operate/rc/context-engine/langcache/

@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 86775bb into main Sep 25, 2026
100 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-7118-unit2-api-integrations 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