DOC-7104: Migrate content/operate/rs/installing-upgrading/ to render hooks - #4089
Merged
Merged
Conversation
…hooks Converts the relref and note/tip/warning/alert callout shortcodes under content/operate/rs/installing-upgrading/ (unit 4 of 15) to the DOC-6909 render-hook equivalents: plain Markdown links resolved by layouts/_default/_markup/render-link.html, and `> [!NOTE]` etc. blockquotes resolved by layouts/_default/_markup/render-blockquote.html. Purely mechanical -- no prose, terminology, or fact changes. 281 relref shortcodes and 24 callout shortcodes converted across 31 of the section's 33 files (configuring/_index.md and install/plan-deployment/supported-platforms.md had none to convert). Ran build/migrate_shortcode_links.py all over the full file list in one invocation, then verified with a before/after `hugo --minify` build and the DOC-7104-diff-hrefs-fix patched build/diff_rendered_hrefs.py, scoped to operate/rs/installing-upgrading: 0 href diffs, and no new build warnings/errors (the log diff was pure WARN-ordering/tempfile-name nondeterminism, plus the same pre-existing unrelated commands/cf.reserve fatal error in both builds). Found and hand-fixed 8 indented/list-nested callouts (a known gotcha from the earlier units of this ticket): the mechanical converter preserves indentation only on the callout's opening `> [!TYPE]` line, dropping it on every continuation line and leaving a stray trailing `>` line of pure whitespace. Verified by comparing rendered `<li>` nesting before/after (not just the href set) for each of the 6 affected files (configuring/change-location-socket-files.md, install/_index.md, install/install-on-linux.md [2 instances], quickstarts/redis-enterprise-software-quickstart.md, upgrading/upgrade-active-active.md, upgrading/upgrade-cluster.md [2 instances]): nesting is identical, and in 3 of the 6 files the fixed markup renders byte-identical HTML to the pre-conversion shortcode. Also confirmed a distinct pre-existing pattern is harmless here: several relref paths end in `.md` (e.g. file-locations.md, manage-installation-questions.md), which the linkify stage can't canonicalize to /content/... form, but render-link.html strips a trailing `.md` before its own GetPage lookup, so these resolve identically pre- and post-conversion (confirmed via the 0-diff href comparison). No missing-paren relrefs, no no-slash-concatenation relrefs, and no literal HTML callout wrappers were found in this unit. build/diff_rendered_hrefs.py's own unquoted-href-attribute fix (DOC-7104-diff-hrefs-fix, PR #4087) was pulled into the worktree to run verification but is not part of this change and is excluded from this commit. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
Contributor
🧠 Redis MemoryFound 5 related items from repository history (5 new this commit):
Memory updated at feebedd |
Contributor
This was referenced Sep 23, 2026
Merged
andy-stark-redis
requested review from
dwdougherty
and removed request for
kaitlynmichael
September 23, 2026 15:21
This was referenced Sep 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Unit 4 of 15 in the DOC-7104 shortcode-to-render-hook migration (extending DOC-6909 into Redis Software docs). Converts every file under
content/operate/rs/installing-upgrading/from therelreflink shortcode andnote/tip/warning/alertcallout shortcodes to their render-hook equivalents: plain Markdown links resolved bylayouts/_default/_markup/render-link.html, and> [!NOTE]etc. blockquotes resolved bylayouts/_default/_markup/render-blockquote.html.Purely mechanical syntax migration — no prose, terminology, or fact changes.
configuring/_index.mdandinstall/plan-deployment/supported-platforms.mdhad no relref/callout shortcodes to convert)hugo --minifybuild, diffed with the patchedbuild/diff_rendered_hrefs.py(see DOC-7104-diff-hrefs-fix / DOC-7104: Fix diff_rendered_hrefs.py to catch unquoted href attributes #4087) scoped tooperate/rs/installing-upgrading— 0 href diffs. Build warning/error logs diffed too: no new warnings or errors (only WARN-ordering/tempfile-name nondeterminism, and the same pre-existing unrelatedcommands/cf.reservefatal build error present in both the before and after builds — not caused by this change).Findings
> [!TYPE]line, dropping it on every continuation line and leaving a stray trailing>line of pure whitespace. Fixed in 6 files (2 had two instances each):configuring/change-location-socket-files.md,install/_index.md,install/install-on-linux.md,quickstarts/redis-enterprise-software-quickstart.md,upgrading/upgrade-active-active.md,upgrading/upgrade-cluster.md. Verified by comparing rendered<li>nesting before/after for each instance, not just the href set — nesting is identical in every case, and 3 of the 6 files render byte-identical HTML pre- and post-fix..md(e.g.file-locations.md,manage-installation-questions.md), which the linkify stage can't canonicalize to/content/...form and leaves as a plain link with the.mdsuffix intact.render-link.htmlstrips a trailing.mdbefore its own page lookup, so these resolve identically pre- and post-conversion — confirmed by the 0-diff href comparison.Test plan
title=) — only the indented-callout pattern hit, hand-fixed as above.build/migrate_shortcode_links.py allrun once over the full 33-file list.hugo --minifybuild,diff_rendered_hrefs.pyscoped tooperate/rs/installing-upgrading— 0 diffs.<li>nesting verified structurally (not just hrefs) for every indented-callout fix.🤖 Generated with Claude Code
Note
Low Risk
Documentation-only syntax migration with verified equivalent link rendering; no product or runtime behavior changes.
Overview
Migrates the Redis Software install and upgrade docs (
content/operate/rs/installing-upgrading/) from Hugorelrefshortcodes to plain Markdown internal links (resolved byrender-link.html) and fromnote/warning/ similar callout shortcodes to> [!NOTE]-style blockquotes (resolved byrender-blockquote.html).Across 31 files, internal cross-links now use
/content/...paths instead of{{< relref ... >}}, and callouts use GitHub-flavored alert syntax. Eight list-nested callouts in six files were hand-adjusted so continuation lines keep correct list indentation after conversion.multitabs,embed-md, and other shortcodes are unchanged.Reviewed by Cursor Bugbot for commit feebedd. Bugbot is set up for automated code reviews on this repo. Configure here.