DOC-7128: convert the last odd-case image shortcodes outside RedisVL - #4198
Open
andy-stark-redis wants to merge 1 commit into
Open
andy-stark-redis wants to merge 1 commit into
andy-stark-redis wants to merge 1 commit into
Conversation
Fixes the source quirks that stopped the codemod on 10 image shortcodes, then converts them: - manage-api-keys.md: three screenshots ended with a <br/> spacer, so they weren't alone in their paragraph. The <br/> is removed. In a browser this shrinks the gap below each from 56-76px to the 32px gap standalone screenshots get elsewhere. - kubernetes 7.4.6 architecture: two diagrams shared one line (they already rendered stacked), so they're now on separate lines. - oss_and_stack timeseries: two images in table cells, converted by hand to inline Markdown. An image alone in a table cell reaches the hook as a block image, so it renders the same unclassed <img>. - connect/_index.md: the width=50%" typo is fixed. It had rendered as width="50%"", which browsers tolerated as 50%. - migrate-databases.md, upgrade-essentials-pro.md: backticks are dropped from an alt text, because Markdown would have parsed them as a code span. Built main and this branch under the production baseURL and compared every image: the only changes are those alt and width values, plus 3 alts losing literal ** markers. In a browser every image renders at its old size. Ticket: DOC-7128 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
Contributor
🧠 Redis MemoryFound 5 related items from repository history (5 new this commit):
Memory updated at f5180f9 |
Contributor
Contributor
Author
|
Thanks for all your reviews @dwdougherty ! Have a nice weekend :-) |
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
Fixes the source quirks that stopped the codemod on the last 10 image shortcodes outside RedisVL, then converts them. Part of DOC-7128. Together with #4197, this leaves the RedisVL diagrams (which need a sync-script change) as the only image shortcodes on the site.
rc/api/get-started/manage-api-keys.md(3)<br/>spacer, so it wasn't alone in its paragraph<br/>, then convertedkubernetes/7.4.6/architecture/_index.md(2)oss_and_stack/stack-with-enterprise/timeseries/_index.md(2). An image alone in a cell reaches the hook as a block image, so it renders the same unclassed<img>.rc/databases/connect/_index.mdwidth=50%"typo, rendered aswidth="50%""width="50%", then convertedrc/databases/migrate-databases.md,rc/subscriptions/upgrade-essentials-pro.md`Synced`), which Markdown would parse as a code spanOne visible change: removing the
<br/>spacers shrinks the gap below those threemanage-api-keysscreenshots from 56–76px to 32px, the same gap standalone screenshots get elsewhere. The page is 112px shorter.Verification
mainand this branch under the production baseURL (/docs/latest/): both succeeded (19,664 pages), and the hook reported no missing images.src/width/alt/classfor every image on every page. The only changes are the intended ones: 2 alts lose their backticks, theconnectwidth loses the stray quote, and 3manage-api-keysalts lose literal**markers. No image gained the icon class.🤖 Generated with Claude Code
Note
Low Risk
Documentation-only Markdown/image markup changes with no runtime, auth, or data impact; the only user-visible effect is slightly tighter spacing below a few API key screenshots.
Overview
Completes DOC-7128 by replacing the last ten non-RedisVL Hugo
{{< image >}}shortcodes with standard Markdownimages (plus{width=…}attribute lines where needed) across six operate docs pages.Each conversion was preceded by a small source fix the codemod could not handle alone: splitting two inline K8s performance diagrams onto separate lines, hand-converting table-cell Time Series downsampling images, removing trailing
<br/>after API key screenshots, correcting a brokenwidth=50%"on the Essentials connect screenshot, and simplifying alt text that used backticks (e.g.`Synced`) so Markdown parses cleanly.Visible layout change: dropping the
<br/>spacers under threemanage-api-keysscreenshots tightens vertical gap (~56–76px → ~32px); image sizes and most alts stay the same aside from the noted alt/width cleanups.Reviewed by Cursor Bugbot for commit f5180f9. Bugbot is set up for automated code reviews on this repo. Configure here.