Repository navigation
Fix tip admonition rendering on Calico on-premises install page - #3132
Merged
Merged
Conversation
The "Automatic data plane deployment" tip in step 3 used the legacy ":::tip Title" syntax. The site sets mdx1CompatDisabledByDefault, so the title is no longer rewritten to a directive label and the whole block rendered as a literal paragraph. Use ":::tip[Title]" instead in next, 3.33, 3.32 and 3.31. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
✅ Deploy Preview succeeded!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The syntax fix is consistently applied across all reviewed documentation versions with no unresolved review comments.
No open issues 🎉
What changed in this PR
Updates Calico on-premises documentation so the “Automatic data plane deployment” tip renders correctly with Docusaurus MDX syntax.
Changes:
- Replaces legacy tip syntax with bracketed directive labels.
- Applies the fix to next, 3.33, 3.32, and 3.31 documentation.
| File | Description |
|---|---|
calico/getting-started/kubernetes/self-managed-onprem/onpremises.mdx |
Fixes the next-version tip syntax. |
calico_versioned_docs/version-3.33/getting-started/kubernetes/self-managed-onprem/onpremises.mdx |
Fixes the 3.33 tip syntax. |
calico_versioned_docs/version-3.32/getting-started/kubernetes/self-managed-onprem/onpremises.mdx |
Fixes the 3.32 tip syntax. |
calico_versioned_docs/version-3.31/getting-started/kubernetes/self-managed-onprem/onpremises.mdx |
Fixes the 3.31 tip syntax. |
Review effort: Lite
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
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.
Product Version(s):
Calico next, 3.33 (latest), 3.32, 3.31
Issue:
On https://docs.tigera.io/calico/latest/getting-started/kubernetes/self-managed-onprem/onpremises (and the 3.32/3.31 versions), the "Automatic data plane deployment" tip in step 3 renders as literal text (
:::tip Automatic data plane deployment ... :::) instead of a tip box.Link to docs preview:
/calico/next/getting-started/kubernetes/self-managed-onprem/onpremisesand/calico/{latest,3.32,3.31}/getting-started/kubernetes/self-managed-onprem/onpremiseson the deploy preview.SME review:
DOCS review:
Additional information:
The tip used the legacy
:::tip Titlesyntax.docusaurus.config.jssetsfuture.v4.mdx1CompatDisabledByDefault: true, so Docusaurus no longer rewrites that to the MDX v3 directive label form, and remark-directive fails to parse it as an admonition. Switched to:::tip[Automatic data plane deployment]. Verified by compiling the page with@docusaurus/mdx-loader3.10.1 with mdx1Compat disabled: before → plain paragraph (matches the live site), after →admonitionwithtype: "tip"and the title.Merge checklist:
🤖 Generated with Claude Code