docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

contrib: update instructions and examples for callouts 

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson 2024-08-15 21:04:01 +02:00
parent 556aa69437
commit be79aba1b6
1 changed files with 30 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
content/contribute/components/call-outs.md
View File

@ -6,14 +6,18 @@ toc_max: 3
We support these broad categories of callouts: We support these broad categories of callouts:
- Alerts (Note, Tip, Important, Warning, Caution)
- Version callouts - Version callouts
- Notes (no HTML attribute required) - Experimental, which use the `{{%/* experimental */%}}` shortcode
- Experimental, which use the `{ .experimental }` class - Restricted, which use the `{{%/* restricted */%}}` shortcode
- Restricted, which use the `{ .restricted }` class
The experimental and restricted shortcodes take a title as an argument. The
title is optional, defaults to "Experimental" or "Restricted" respectively, and
is displayed in the callout.
## Examples ## Examples
{{< introduced buildx 0.10.4 >}} {{< introduced buildx 0.16.0 >}}
> [!NOTE] > [!NOTE]
> >
@ -29,13 +33,11 @@ We support these broad categories of callouts:
> >
> For a smaller base image, use `alpine`. > For a smaller base image, use `alpine`.
> [!IMPORTANT] > [!IMPORTANT]
> >
> Treat access tokens like your password and keep them secret. Store your > Treat access tokens like your password and keep them secret. Store your
> tokens securely (for example, in a credential manager). > tokens securely (for example, in a credential manager).
> [!WARNING] > [!WARNING]
> >
> Removing Volumes > Removing Volumes
@ -46,18 +48,19 @@ We support these broad categories of callouts:
> >
> The Docker Dashboard does not remove volumes when you delete the app stack. > The Docker Dashboard does not remove volumes when you delete the app stack.
> [!CAUTION]
>
> Here be dragons.
For both of the following callouts, consult [the Docker release lifecycle](/release-lifecycle) for more information on when to use them. For both of the following callouts, consult [the Docker release lifecycle](/release-lifecycle) for more information on when to use them.
> **Beta feature** {{% experimental title="Beta feature" %}}
> The Builds view is currently in Beta. This feature may change or be removed from future releases.
> The Builds view is currently in Beta. This feature may change or be removed from future releases. {{% /experimental %}}
{ .experimental }
> **Restricted** {{% restricted %}}
> Docker Scout is an [early access](/release-lifecycle/#early-access-ea) product.
> Docker Scout is an [early access](/release-lifecycle/#early-access-ea) {{% /restricted %}}
> product.
{ .restricted}
## Formatting ## Formatting
@ -95,14 +98,17 @@ For both of the following callouts, consult [the Docker release lifecycle](/rele
> >
> The Docker Dashboard does _not_ remove volumes when you delete the app stack. > The Docker Dashboard does _not_ remove volumes when you delete the app stack.
> **Beta feature** > [!CAUTION]
> >
> The Builds view is currently in Beta. This feature may change or be removed from future releases. > Here be dragons.
{ .experimental } ```
> **Restricted** ```go
> {{%/* experimental title="Beta feature" */%}}
> Docker Scout is an [early access](/release-lifecycle/#early-access-ea) The Builds view is currently in Beta. This feature may change or be removed from future releases.
> product. {{%/* /experimental */%}}
{ .restricted }
{{%/* restricted */%}}
Docker Scout is an [early access](/release-lifecycle/#early-access-ea) product.
{{%/* /restricted */%}}
``` ```