Skip to content

DOC-7089: Migrate remaining content/operate/oss_and_stack/stack-with-enterprise/ (install, timeseries, bloom, search, json) to render hooks - #4071

Merged
andy-stark-redis merged 1 commit into
mainfrom
DOC-7089-remaining-stack-with-enterprise
Sep 22, 2026
Merged

andy-stark-redis merged 1 commit into
mainfrom
DOC-7089-remaining-stack-with-enterprise

Conversation

@andy-stark-redis

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

Copy link
Copy Markdown
Contributor

Summary

  • Converts {{< relref >}} markdown links to plain canonical /content/<path>.md[#anchor] links, and {{< note >}}/{{< tip >}}/{{< warning >}} shortcodes (including the tight {{<note>}} form and {{% %}} variant) to native > [!NOTE]-style blockquote callouts.
  • Scope (24 files, unit 5 of 5 for DOC-7089): every *.md directly under content/operate/oss_and_stack/stack-with-enterprise/install/ (4), timeseries/ (3), bloom/ (3), search/ (7), json/ (3), plus the 4 top-level *.md files in stack-with-enterprise/. release-notes/ and deprecated-features/ were already migrated as separate units (5b5f64a31, 2b4e1fe2e).
  • Hand-fixed the migration tool's known list-nesting bug (lost indentation) in the 4 files that had an indented callout inside a list item: install/upgrade-module.md, install/add-module-to-database.md (2 instances), search/redisearch-2-upgrade.md, json/active-active.md. Verified in the built HTML that each callout still renders nested inside its <li>, not as a top-level block.
  • Checked for the two known malformed-relref-paren variants before running the tool. No missing-opening-paren instances found. Two relref-immediately-followed-by-literal-path instances were found (timeseries/config.md, bloom/config.md) but confirmed to be the known-safe implicit-trailing-slash pattern (relref's trailing slash bridging two path fragments), not the missing-closing-paren bug — left untouched, and confirmed unchanged by the href diff.
  • Checked for a claimed "legacy literal HTML <note> wrapper" in install/, json/, and search/: as in prior units, every match was the real shortcode in its tight no-space form {{<note>}}/{{<warning>}}, not a bare HTML tag. Converted normally.

Verification

  • Full-site Hugo build (twice: baseline origin/main @ 2b4e1fe2e, and this branch) diffed with build/diff_rendered_hrefs.py filtered to operate/oss_and_stack/stack-with-enterprise: 0 href diffs across 214 pages.
  • Build warning counts identical between baseline and after builds (17 pre-existing warnings, all unrelated to this scope; 0 new warnings).
  • File count unchanged: 24 files before and after conversion.

This is the last of 5 units for DOC-7089.

Test plan

  • Confirmed 24-file scope matches the ticket's directory list
  • Ran build/migrate_shortcode_links.py all over the 24 files
  • Hand-fixed and HTML-verified nested-callout indentation in 4 files
  • Full-site Hugo build twice (baseline + after) with 0 href diffs and 0 new warnings

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only link and callout formatting with build verification; no application or runtime behavior changes.

Overview
This PR finishes DOC-7089 unit 5/5 by migrating the remaining stack-with-enterprise docs (install, bloom, search, json, timeseries, plus four top-level pages) off Hugo {{< relref >}} and admonition shortcodes.

Links: Internal cross-references now use canonical markdown paths such as /content/operate/rs/_index.md and /content/commands/bf.add.md, including large command compatibility tables for Bloom, JSON, Search, and Time series.

Callouts: {{< note >}}, {{< warning >}}, and related shortcodes become GitHub-flavored > [!NOTE] / > [!WARNING] blockquotes. Nested callouts inside list items were hand-fixed where the migrator dropped indentation (upgrade-module, add-module-to-database, redisearch-2-upgrade, json/active-active).

Prose and Hugo embeds (for example {{<embed-md>}}, {{<multitabs>}}, images) are unchanged. The author reports 0 href diffs on a full-site Hugo build for this section versus baseline.

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

…enterprise/ to render hooks

Converts relref links to plain canonical markdown links and note/tip/warning
shortcodes to native blockquote callouts across install/, timeseries/,
bloom/, search/, json/, and the top-level pages of stack-with-enterprise/
(release-notes/ and deprecated-features/ were already migrated as separate
units). This is unit 5 of 5 for DOC-7089.

Hand-fixed list-nesting indentation lost by the migration tool's known
callout-conversion bug in the four files with an indented note/warning
inside a numbered or bulleted list item: install/upgrade-module.md,
install/add-module-to-database.md, search/redisearch-2-upgrade.md, and
json/active-active.md. Verified against the built HTML that each callout
still renders nested inside its list item.

Confirmed the two relref instances immediately followed by a literal path
segment before their closing paren (timeseries/config.md,
bloom/config.md) are the known-safe implicit-trailing-slash pattern, not
the missing-closing-paren bug — left untouched by the tool as expected.

Full-site Hugo build diff (build/diff_rendered_hrefs.py) shows 0 href
changes across 214 pages under this path, and 0 new build warnings vs a
baseline build of origin/main.
@github-actions

github-actions Bot commented Sep 21, 2026 •

Copy link
Copy Markdown
Contributor

DOC-7089

@github-actions

Copy link
Copy Markdown
Contributor

Staging links:
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/bloom/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/bloom/commands/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/bloom/config/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/enterprise-capabilities/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/install/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-cluster/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/install/add-module-to-database/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/json/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/json/active-active/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/json/commands/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/modules-lifecycle/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/search/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/search/commands/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/search/config/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/search/query-performance-factor/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/search/redisearch-2-upgrade/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/search/scalable-query-best-practices/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/search/search-active-active/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/stack-quickstart/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/timeseries/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/timeseries/commands/
https://redis.io/docs/staging/DOC-7089-remaining-stack-with-enterprise/operate/oss_and_stack/stack-with-enterprise/timeseries/config/

@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 self-assigned this Sep 22, 2026
@andy-stark-redis
andy-stark-redis merged commit 8d55000 into main Sep 22, 2026
100 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-7089-remaining-stack-with-enterprise branch September 22, 2026 09:15
@andy-stark-redis

Copy link
Copy Markdown
Contributor Author

Thanks @dwdougherty !

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