Skip to content

docs: replace blockquotes with admonitions#274

Merged
k8s-ci-robot merged 1 commit into
kubernetes-sigs:mainfrom
vitorfloriano:docs-add-admonitions
Jun 10, 2026
Merged

docs: replace blockquotes with admonitions#274
k8s-ci-robot merged 1 commit into
kubernetes-sigs:mainfrom
vitorfloriano:docs-add-admonitions

Conversation

@vitorfloriano

@vitorfloriano vitorfloriano commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

mbBook has native support for admonitions (callouts), which are a little nicer for grabing the reader's attention to a specific piece of content.

We're replacing the sidenotes and alerts in blockquotes with the built-in callouts.

The only ones I couldn't replace were the "Requirements" blockquotes, since there's no equivalent admonition to replace them with.

The admonitions can be seen here:

current preview
https://node-readiness-controller.sigs.k8s.io/user-guide/installation.html#verification https://deploy-preview-274--node-readiness-controller.netlify.app/user-guide/installation.html#verification
https://node-readiness-controller.sigs.k8s.io/user-guide/installation.html#uninstallation https://deploy-preview-274--node-readiness-controller.netlify.app/user-guide/installation.html#uninstallation
https://node-readiness-controller.sigs.k8s.io/user-guide/getting-started.html#1-select-target-nodes https://deploy-preview-274--node-readiness-controller.netlify.app/user-guide/getting-started.html#1-select-target-nodes
https://node-readiness-controller.sigs.k8s.io/user-guide/getting-started.html#4-configure-the-taint https://deploy-preview-274--node-readiness-controller.netlify.app/user-guide/getting-started.html#4-configure-the-taint
https://node-readiness-controller.sigs.k8s.io/examples/cni-readiness.html#step-by-step-guide https://deploy-preview-274--node-readiness-controller.netlify.app/examples/cni-readiness.html#step-by-step-guide
https://node-readiness-controller.sigs.k8s.io/examples/security-agent-readiness.html#step-by-step-guide-falco-example https://deploy-preview-274--node-readiness-controller.netlify.app/examples/security-agent-readiness.html#step-by-step-guide-falco-example
https://node-readiness-controller.sigs.k8s.io/examples/constrained-impersonation.html#secure-status-reporting https://deploy-preview-274--node-readiness-controller.netlify.app/examples/constrained-impersonation.html#secure-status-reporting

/kind documentation

mbBook's has native support for admonitions (callouts),
which are a little nicer for grabing the reader's attention.

We're replacing the blockquotes with the built-in callouts.

The only ones I couldn't replace were the "Requirements" blockquotes.
@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Jun 10, 2026
@netlify

netlify Bot commented Jun 10, 2026

Copy link
Copy Markdown

Deploy Preview for node-readiness-controller ready!

Name Link
🔨 Latest commit 76f1a01
🔍 Latest deploy log https://app.netlify.com/projects/node-readiness-controller/deploys/6a28d1cf43ceba0009a3b7eb
😎 Deploy Preview https://deploy-preview-274--node-readiness-controller.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jun 10, 2026
@ajaysundark

Copy link
Copy Markdown
Contributor

This definitely looks nicer. Thanks for handling it!

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 10, 2026
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ajaysundark, vitorfloriano

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 10, 2026
@k8s-ci-robot k8s-ci-robot merged commit bd71656 into kubernetes-sigs:main Jun 10, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants