docs(operator): fix broken admonition delimiters leaking ::: markup - #556
Merged
Merged
Conversation
Three admonitions in the Kubernetes Operator docs leaked raw ":::" markup
onto the published pages because their delimiters were malformed:
- index.md: content followed ":::warning[Supported platforms]" on the same
line, so the block never parsed as a directive. The whole admonition
rendered as literal text on
/docs/enterprise-kubernetes-operator/.
- operations/backup-restore.md (PITR) and operations/database.md: the
closing ":::" sat at the end of a prose line instead of on its own line,
so the block never closed and a stray ":::" rendered on the page.
Put the opening tag (and its title, where present) alone on its line, the
body on following lines, and the closing ":::" on its own line.
Also reflows the danger admonition above the PVC cleanup step in
backup-restore.md: it rendered fine, but its legacy space-separated title
cut the sentence mid-clause ("...permanently destroys its" as the title,
"incomplete restore data." as the body).
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
🚀 Build success! Latest successful preview: https://preview-556--questdb-documentation.netlify.app/docs/ Commit SHA: 366eb3f
|
javier
approved these changes
Sep 17, 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.
The "Supported platforms" warning on /docs/enterprise-kubernetes-operator/ renders as literal text instead of a warning box — the raw
:::warning[Supported platforms]string is visible on the published page.Cause
Docusaurus admonitions need the opening tag (with its optional
[Title]) alone on its line and the closing:::alone on its line. Three blocks in the operator docs violate that, so the directive never parses and the:::markup leaks into the page body:index.md:::warning[Supported platforms]on the same lineoperations/backup-restore.md(PITR):::at the end of a prose lineoperations/database.md:::at the end of a prose lineVerification
Fetched the rendered HTML of the live pages:
/enterprise-kubernetes-operator/— 0theme-admonition-*elements, literal:::warning[Supported platforms]present..../operations/backup-restore/and.../operations/database/— a stray literal:::present.Parsed each file before and after with the same
remark-directivepipeline Docusaurus builds on:The corrected shape is the one already used successfully elsewhere in these docs (
getting-started/migrate.md,high-availability/wal-cleanup.md), both confirmed rendering proper admonition elements with no leaked colons on the live site.I also swept the whole
documentation/tree for the same defect class — these three are the only occurrences. The common:::note Some titlelegacy form found on other pages is valid and renders correctly; it is left untouched.One non-bug change
The
:::dangerabove the PVC cleanup step inbackup-restore.mdalready rendered correctly, so it is not part of the bug. It is reflowed here because its legacy space-separated title split the sentence mid-clause — title "Deleting the retained destination PVC permanently destroys its", body "incomplete restore data." Happy to drop this hunk if you would rather keep the PR strictly to the breakage.Prose is wrapped at 80 columns to match
prettier.config.js(proseWrap: "always").🤖 Generated with Claude Code