-
Notifications
You must be signed in to change notification settings - Fork 5.2k
docs: Replace GitHub-style alerts with Docsy shortcodes #23070
Copy link
Copy link
Labels
good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.Denotes an issue ready for a new contributor, according to the "help wanted" guidelines.help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.
Metadata
Metadata
Assignees
Labels
good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.Denotes an issue ready for a new contributor, according to the "help wanted" guidelines.help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.
Type
Fields
Give feedbackNo fields configured for issues without a type.
Problem
Some minikube site docs use GitHub-style alert syntax:
This renders as plain blockquotes on minikube.sigs.k8s.io (Hugo/Docsy), not as styled warnings or notes.
Solution
Replace with Docsy shortcodes that render correctly:
Warning:
{{% alert title="Warning" color="warning" %}} Your warning text here. {{% /alert %}}Important / note:
{{% alert title="Note" color="primary" %}} Your note text here. {{% /alert %}}Info / tips (optional, for less urgent callouts):
{{% pageinfo color="info" %}} Your info text here. {{% /pageinfo %}}Working examples in the repo:
site/content/en/docs/contrib/releasing/binaries.md(warning)site/content/en/docs/handbook/host-access.md(note)site/content/en/docs/handbook/pushing.md(pageinfo)Files to update
site/content/en/docs/drivers/krunkit.md—[!IMPORTANT],[!WARNING]site/content/en/docs/drivers/vfkit.md—**IMPORTANT**:inline (convert to alert)site/content/en/docs/contrib/building/iso.md—[!IMPORTANT]Search for other occurrences:
rg '\[!(WARNING|IMPORTANT|NOTE|TIP|CAUTION)' site/Good first issue
make site(or the site docs build target)Acceptance criteria
> [!...]alerts undersite/