DOC-7128: convert the 28 screenshots that shared a paragraph with text - #4197
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
The codemod skipped these because each image line sat directly under a line of text, so the image was part of that paragraph and couldn't take an attribute line. A blank line now separates each image from the text around it, which makes it a standalone block image, and the default codemod mode then converts it. The AGENTS.md rule says screenshots are always their own paragraph, and these now follow it. 16 are outside lists: 14 dashboard screenshots in embeds/rs-observability.md, under their caption lines, and 2 in the kubernetes 7.4.6 and 7.8.4 FAQs. 12 are in list items, all indented 4 spaces, which keeps them inside their item after the blank line. A blank line between blocks in a list item makes the whole list loose (every item gets a <p>). Measured in a browser on both builds: every screenshot renders at exactly its old size, and every list keeps its old height except the bulleted feature list in rc/databases/connect/insight-cloud.md, which grows from 911 to 951px. The other lists were already loose, or their images' margins already set their spacing. Converting in place without a blank line was considered and rejected: an inline screenshot can't carry a width, five of these have one, and it would break the AGENTS.md rule. Learned: a blank line between blocks in a list item makes the whole list loose; measure the list before calling it a no-op Rejected: converting these screenshots in place as inline images | they couldn't keep their width, and screenshots must be their own paragraph Ticket: DOC-7128 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
Contributor
Contributor
🧠 Redis MemoryFound 5 related items from repository history (5 new this commit):
Memory updated at 2aeaf42 |
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
Converts the last 28 image shortcodes the codemod skipped because each image sat directly under a line of text, which made it part of that paragraph. A blank line now separates each image from the text around it, which makes it a standalone image, and the default codemod mode then converts it, keeping any
width. This follows theAGENTS.mdrule that screenshots are always their own paragraph. Part of DOC-7128.Counts: 28 images in 9 files, with 36 blank lines added.
embeds/rs-observability.md, which renders on three observability pages, and 2 in the Kubernetes 7.4.6 and 7.8.4 FAQs.rc/andrs/7.4/. All are indented 4 spaces, so they stay inside their list item after the blank line.One layout change: a blank line between blocks in a list item makes the whole list "loose", so every item gets a
<p>wrapper. I measured every affected screenshot and list in a browser on both builds:rc/databases/connect/insight-cloudrc/cloud-integrations/vercelrc/rc-quickstartrc/databases/import-datarc/security/database-security/block-public-endpointsrs/7.4/security/encryption/tls/enable-tlsThe other lists were already loose, or their images' own margins already set their spacing.
I rejected converting these in place as inline images. An inline image can't carry a
width(five of these have one), and it would break theAGENTS.mdrule.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: no differences, and no image gained the icon class.🤖 Generated with Claude Code
Note
Low Risk
Documentation-only markdown and image markup changes with no application, security, or data-handling logic affected.
Overview
Finishes DOC-7128 by converting 28 remaining Hugo
{{< image >}}shortcodes that sat on the same paragraph as adjacent text. Each screenshot now has a blank line before it (per AGENTS.md), then standard markdownwith existing alt text and{width=...}blocks preserved where they existed.16 dashboard figures in
embeds/rs-observability.md(shared embed used on observability pages) and OpenShift password screenshots in both Kubernetes FAQ versions are outside lists. The other 12 updates sit in numbered-list steps across Redis Cloud (Vercel, Redis Insight, import, quickstart, block public endpoints) and RS 7.4 TLS docs—images stay indented under their list items.Prose is unchanged aside from spacing; only markup format and paragraph boundaries differ. One noted layout side effect: on
insight-cloud, separating images can make that list “loose” and add a bit of vertical spacing between bullets.Reviewed by Cursor Bugbot for commit 2aeaf42. Bugbot is set up for automated code reviews on this repo. Configure here.