Home Explore Blog CI



docker

content/contribute/components/call-outs.md
b9f54eb79de681dc7cdd82c3dea0df227277d7e95688756a0000000300000ea7
---
description: components and formatting examples used in Docker's docs
title: Callouts
toc_max: 3
---

We support these broad categories of callouts:

- Alerts: Note, Tip, Important, Warning, Caution

We also support summary bars, which represent a feature's required subscription, version, or Adminstrator role.
To add a summary bar:

Add the feature name to the `/data/summary.yaml` file. Use the following attributes:

| Attribute      | Description                                            | Possible values                                         |
|----------------|--------------------------------------------------------|---------------------------------------------------------|
| `subscription` | Notes the subscription required to use the feature     | All, Personal, Pro, Team, Business                      |
| `availability` | Notes what product development stage the feature is in | Experimental, Beta, Early Access, GA, Retired           |
| `requires`     | Notes what minimum version is required for the feature | No specific value, use a string to describe the version and link to relevant release notes |
| `for`          | Notes if the feature is intended for IT Administrators | Administrators                                          |

Then, add the `summary-bar` shortcode on the page you want to add the summary bar to. Note, the feature name is case sensitive. The icons that appear in the summary bar are automatically rendered.

## Examples

{{< summary-bar feature_name="PKG installer" >}}

> [!NOTE]
>
> Note the way the `get_hit_count` function is written. This basic retry
> loop lets us attempt our request multiple times if the redis service is
> not available. This is useful at startup while the application comes
> online, but also makes our application more resilient if the Redis
> service needs to be restarted anytime during the app's lifetime. In a
> cluster, this also helps handling momentary connection drops between
> nodes.

> [!TIP]
>
> For a smaller base image, use `alpine`.

> [!IMPORTANT]
>
> Treat access tokens like your password and keep them secret. Store your
> tokens securely (for example, in a credential manager).

> [!WARNING]
>
> Removing Volumes
>
> By default, named volumes in your compose file are NOT removed when running
> `docker compose down`. If you want to remove the volumes, you will need to add
> the `--volumes` flag.
>
> The Docker Desktop 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.

## Formatting

```md
{{</* summary-bar feature_name="PKG installer" */>}}
```

```html
> [!NOTE]
>
> Note the way the `get_hit_count` function is written. This basic retry
> loop lets us attempt our request multiple times if the redis service is
> not available. This is useful at startup while the application comes
> online, but also makes our application more resilient if the Redis
> service needs to be restarted anytime during the app's lifetime. In a
> cluster, this also helps handling momentary connection drops between
> nodes.

> [!TIP]
>
> For a smaller base image, use `alpine`.

> [!IMPORTANT]
>
> Treat access tokens like your password and keep them secret. Store your
> tokens securely (for example, in a credential manager).

> [!WARNING]
>
> Removing Volumes
>
> By default, named volumes in your compose file are NOT removed when running
> `docker compose down`. If you want to remove the volumes, you will need to add
> the `--volumes` flag.
>
> The Docker Desktop Dashboard does not remove volumes when you delete the app stack.

> [!CAUTION]
>
> Here be dragons.
```

Chunks
de5310b8 (1st chunk of `content/contribute/components/call-outs.md`)
Title: Callout Components and Formatting in Docker Documentation
Summary
This section of the Docker documentation outlines the supported callout categories (Note, Tip, Important, Warning, Caution) and summary bars, detailing their purpose and usage. It explains how to add summary bars by modifying the `/data/summary.yaml` file and using the `summary-bar` shortcode. The document also provides examples and formatting guidelines for each type of callout, including notes, tips, warnings, and cautions, with practical advice and explanations.