Repository navigation
DOC-7128: fix four callouts that merged into the one above them - #4199
Merged
Merged
Conversation
Four pages rendered a callout as literal "[!NOTE]" text inside the callout above it. Three had a spacer line (<br/>, </br>, or ) directly after the first callout's last line. A line that doesn't start with ">" right after a blockquote is a lazy continuation, so the spacer joined the first callout, and the second callout's lines continued the same blockquote. The fourth, in the Kubernetes Prometheus operator page, was a callout indented 4 spaces under a plain paragraph, so it read as more of that paragraph. Each spacer becomes a blank line, and the indented callout is dedented after a blank line. Found while reviewing #4197 (import-data.md). A site-wide scan of the rendered build for literal callout markers found these four and no others. After the fix, each page renders every callout in its source (main was one short on each), and no literal markers remain. Back-to-back callouts touch (0px gap) on this site, including on pages that were never broken. That's existing styling, and probably why authors added the spacers. Learned: a spacer line (<br/>, ) directly after a blockquote is a lazy continuation, so the next callout merges into it; separate callouts with a blank line Directive: scan rendered HTML for literal [!NOTE]/[!WARNING] text to find broken callouts Ticket: DOC-7128 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
Contributor
Contributor
Two callouts in a row touched (0px gap) everywhere on the site, including on pages that were never broken. That's probably why authors added the spacer lines this PR removes, which broke the Markdown. A .alert + .alert rule adds a 1rem gap. .alert is only emitted by the three callout templates (render-blockquote.html, alert.html, alert-video.html), so it affects nothing else. Measured in a browser: adjacent callouts now sit 16px apart, and callouts separated by other content keep their spacing. Directive: separate back-to-back callouts with a blank line only; the CSS supplies the gap, so never add a spacer line Ticket: DOC-7128 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
andy-stark-redis
added a commit
that referenced
this pull request
Oct 5, 2026
#4197) The codemod skipped 28 screenshots because each image line sat directly under a line of text, which made the image part of that paragraph, so it 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, keeping its width. That follows the AGENTS.md rule that screenshots are always their own paragraph. 16 are outside lists: 14 dashboard screenshots in embeds/rs-observability.md 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 (911 to 951px). Converting them in place as inline images was rejected, because an inline image can't keep a width (five have one). Review of this PR spotted an unrelated broken callout on import-data, a callout-migration leftover. It was fixed separately in #4199. 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>
EliShteinman
added a commit
to EliShteinman/docs
that referenced
this pull request
Oct 5, 2026
Fixes four callouts that merged into the one above them and spaces adjacent alerts in CSS. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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 four pages where a callout rendered as literal
[!NOTE]text inside the callout above it. This was found during review of #4197 onrc/databases/import-data. It's an existing problem onmain, left over from the callout migration and not caused by the image work, so it's a separate PR.Cause: three pages had a spacer line directly after the first callout's last line:
<br/>(rc/databases/import-data),</br>(oss_and_stack/install/upgrade/cluster), or (oss_and_stack/install/install-stack/homebrew). A line that doesn't start with>right after a blockquote is a lazy continuation, so the spacer became part of the first callout, and the next callout's lines continued the same blockquote. The fourth (kubernetes/re-clusters/connect-prometheus-operator) was a callout indented 4 spaces under a plain paragraph, so it read as more text in that paragraph.Fix: each spacer line becomes a blank line, and the indented callout is dedented after a blank line. That's 4 content files, and no other text changed.
Gap between callouts (second commit): back-to-back callouts touched, with a 0px gap, everywhere on the site, including pages that were never broken. That's probably why authors added these spacers. A
.alert + .alert { margin-top: 1rem }rule now adds a gap..alertis only emitted by the three callout templates (render-blockquote.html,alert.html, andalert-video.html), so nothing else is affected. Measured in a browser: adjacent callouts now sit 16px apart, and callouts separated by other content keep their spacing.Verification
[!NOTE],[!WARNING], and so on, outside code) found exactly these 4 pages onmain, and 0 with this branch.main, each was one short:mainrc/databases/import-dataoss_and_stack/install/install-stack/homebrewoss_and_stack/install/upgrade/clusterkubernetes/re-clusters/connect-prometheus-operatorimport-data.mdis also changed in DOC-7128: convert the 28 screenshots that shared a paragraph with text #4197, on different lines. The two merge cleanly in either order.🤖 Generated with Claude Code
Note
Low Risk
Documentation and prose styling only; no application logic or security-sensitive changes.
Overview
Fixes merged callouts on four docs pages where a second
[!NOTE]/[!WARNING]rendered as literal text inside the preceding callout instead of its own box. The markdown fixes replace spacer lines (<br/>,</br>, ) or incorrect indentation with a blank line between callouts so blockquotes parse separately.Adds
.alert + .alert { margin-top: 1rem }inindex.cssso adjacent callouts have visible separation site-wide, reducing the need for those spacer hacks.Pages touched:
rc/databases/import-data, Homebrew install, cluster upgrade, and Kubernetes Prometheus operator connect.Reviewed by Cursor Bugbot for commit 915a3e5. Bugbot is set up for automated code reviews on this repo. Configure here.