chore: summary bar cleanup (#21887)

sarahsanders-docker · web-flow · commit 9f56d945a73a · 2025-01-30T07:54:26.000-08:00
## Description - Updated "Contribute" guide to reference summary bars, added instructions for using them - Removed `introduced` partial, this is now replaced by the summary bar `requires` value - Updated all files using `introduced` partial to use summary bar, updated YAML file w/ feature name and info ## Related issues or tickets [ENGDOCS-2392](https://docker.atlassian.net/browse/ENGDOCS-2392) ## Reviews - [ ] Technical review - [ ] Editorial review [ENGDOCS-2392]: https://docker.atlassian.net/browse/ENGDOCS-2392?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
diff --git a/content/contribute/components/call-outs.md b/content/contribute/components/call-outs.md
@@ -6,18 +6,25 @@ toc_max: 3
 
 We support these broad categories of callouts:
 
-- Alerts (Note, Tip, Important, Warning, Caution)
-- Version callouts
-- Experimental, which use the `{{%/* experimental */%}}` shortcode
-- Restricted, which use the `{{%/* restricted */%}}` shortcode
+- Alerts: Note, Tip, Important, Warning, Caution
 
-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.
+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
 
-{{< introduced buildx 0.16.0 >}}
+{{< summary-bar feature_name="PKG installer" >}}
 
 > [!NOTE]
 >
@@ -54,18 +61,10 @@ is displayed in the callout.
 
 For both of the following callouts, consult [the Docker release lifecycle](/release-lifecycle) for more information on when to use them.
 
-{{% experimental title="Beta feature" %}}
-The Builds view is currently in Beta. This feature may change or be removed from future releases.
-{{% /experimental %}}
-
-{{% restricted %}}
-Docker Scout is an [early access](/release-lifecycle/#early-access-ea) product.
-{{% /restricted %}}
-
-## Formatting 
+## Formatting
 
 ```go
-{{</* introduced buildx 0.10.4 "../../release-notes.md#0104" */>}}
+> {{< summary-bar feature_name="PKG installer" >}}
 ```
 
 ```html
@@ -101,14 +100,4 @@ Docker Scout is an [early access](/release-lifecycle/#early-access-ea) product.
 > [!CAUTION]
 >
 > Here be dragons.
-```
-
-```go
-{{%/* experimental title="Beta feature" */%}}
-The Builds view is currently in Beta. This feature may change or be removed from future releases.
-{{%/* /experimental */%}}
-
-{{%/* restricted */%}}
-Docker Scout is an [early access](/release-lifecycle/#early-access-ea) product.
-{{%/* /restricted */%}}
-```
+```
diff --git a/content/manuals/build/builders/drivers/_index.md b/content/manuals/build/builders/drivers/_index.md
@@ -66,7 +66,7 @@ To build an image using a non-default driver and load it to the image store,
 
 ### Load by default
 
-{{< introduced buildx 0.14.0 >}}
+{{< summary-bar feature_name="Load by default" >}}
 
 You can configure the custom build drivers to behave in a similar way to the
 default `docker` driver, and load images to the local image store by default.
diff --git a/content/manuals/build/building/variables.md b/content/manuals/build/building/variables.md
@@ -352,7 +352,7 @@ Setting `NO_COLOR` to anything turns off colorized output, as recommended by
 
 ### BUILDKIT_HOST
 
-{{< introduced buildx 0.9.0 "../release-notes.md#090" >}}
+{{< summary-bar feature_name="Buildkit host" >}}
 
 You use the `BUILDKIT_HOST` to specify the address of a BuildKit daemon to use
 as a remote builder. This is the same as specifying the address as a positional
@@ -438,7 +438,7 @@ Example:
 
 ### BUILDX_BAKE_GIT_AUTH_HEADER
 
-{{< introduced buildx 0.14.0 >}}
+{{< summary-bar feature_name="Buildx bake Git auth token" >}}
 
 Sets the HTTP authentication scheme when using a remote Bake definition in a private Git repository.
 This is equivalent to the [`GIT_AUTH_HEADER` secret](./secrets#http-authentication-scheme),
@@ -453,7 +453,7 @@ $ export BUILDX_BAKE_GIT_AUTH_HEADER=basic
 
 ### BUILDX_BAKE_GIT_AUTH_TOKEN
 
-{{< introduced buildx 0.14.0 >}}
+{{< summary-bar feature_name="Buildx bake Git auth token" >}}
 
 Sets the HTTP authentication token when using a remote Bake definition in a private Git repository.
 This is equivalent to the [`GIT_AUTH_TOKEN` secret](./secrets#git-authentication-for-remote-contexts),
@@ -467,7 +467,7 @@ $ export BUILDX_BAKE_GIT_AUTH_TOKEN=$(cat git-token.txt)
 
 ### BUILDX_BAKE_GIT_SSH
 
-{{< introduced buildx 0.14.0 >}}
+{{< summary-bar feature_name="Buildx bake Git SSH" >}}
 
 Lets you specify a list of SSH agent socket filepaths to forward to Bake
 for authenticating to a Git server when using a remote Bake definition in a private repository.
@@ -512,7 +512,7 @@ $ export BUILDX_CONFIG=/usr/local/etc
 
 ### BUILDX_CPU_PROFILE
 
-{{< introduced buildx 0.18.0 >}}
+{{< summary-bar feature_name="Buildx CPU profile" >}}
 
 If specified, Buildx generates a `pprof` CPU profile at the specified location.
 
@@ -538,7 +538,7 @@ $ export BUILDX_EXPERIMENTAL=1
 
 ### BUILDX_GIT_CHECK_DIRTY
 
-{{< introduced buildx 0.10.4 "../release-notes.md#0104" >}}
+{{< summary-bar feature_name="Buildx Git check dirty" >}}
 
 When set to true, checks for dirty state in source control information for
 [provenance attestations](/manuals/build/metadata/attestations/slsa-provenance.md).
@@ -551,7 +551,7 @@ $ export BUILDX_GIT_CHECK_DIRTY=1
 
 ### BUILDX_GIT_INFO
 
-{{< introduced buildx 0.10.0 "../release-notes.md#0100" >}}
+{{< summary-bar feature_name="Buildx Git info" >}}
 
 When set to false, removes source control information from
 [provenance attestations](/manuals/build/metadata/attestations/slsa-provenance.md).
@@ -564,7 +564,7 @@ $ export BUILDX_GIT_INFO=0
 
 ### BUILDX_GIT_LABELS
 
-{{< introduced buildx 0.10.0 "../release-notes.md#0100" >}}
+{{< summary-bar feature_name="Buildx Git labels" >}}
 
 Adds provenance labels, based on Git information, to images that you build. The
 labels are:
@@ -593,7 +593,7 @@ If the repository is in a dirty state, the `revision` gets a `-dirty` suffix.
 
 ### BUILDX_MEM_PROFILE
 
-{{< introduced buildx 0.18.0 >}}
+{{< summary-bar feature_name="Buildx mem profile" >}}
 
 If specified, Buildx generates a `pprof` memory profile at the specified
 location.
@@ -610,7 +610,7 @@ $ export BUILDX_MEM_PROFILE=buildx_mem.prof
 
 ### BUILDX_NO_DEFAULT_ATTESTATIONS
 
-{{< introduced buildx 0.10.4 "../release-notes.md#0104" >}}
+{{< summary-bar feature_name="Buildx no default" >}}
 
 By default, BuildKit v0.11 and later adds
 [provenance attestations](/manuals/build/metadata/attestations/slsa-provenance.md) to images you
diff --git a/content/manuals/build/exporters/_index.md b/content/manuals/build/exporters/_index.md
@@ -184,7 +184,7 @@ WARNING: No output specified with docker-container driver.
 
 ## Multiple exporters
 
-{{< introduced buildx 0.13.0 >}}
+{{< summary-bar feature_name="Build multiple exporters" >}}
 
 You can use multiple exporters for any given build by specifying the `--output`
 flag multiple times. This requires **both Buildx and BuildKit** version 0.13.0
diff --git a/content/manuals/compose/how-tos/environment-variables/envvars.md b/content/manuals/compose/how-tos/environment-variables/envvars.md
@@ -172,7 +172,7 @@ If `COMPOSE_ENV_FILES` is not set, and you don't provide `--env-file` in the CLI
 
 ### COMPOSE\_MENU
 
-{{< introduced compose 2.26.0 "/manuals/compose/releases/release-notes.md#2260" >}}
+{{< summary-bar feature_name="Compose menu" >}}
 
 When enabled, Compose displays a navigation menu where you can choose to open the Compose stack in Docker Desktop, switch on [`watch` mode](../file-watch.md), or use [Docker Debug](/reference/cli/docker/debug.md).
 
@@ -183,7 +183,7 @@ When enabled, Compose displays a navigation menu where you can choose to open th
 
 ### COMPOSE\_EXPERIMENTAL
 
-{{< introduced compose 2.26.0 "/manuals/compose/releases/release-notes.md#2260" >}}
+{{< summary-bar feature_name="Compose experimental" >}}
 
 This is an opt-out variable. When turned off it deactivates the experimental features such as the navigation menu or [Synchronized file shares](/manuals/desktop/features/synchronized-file-sharing.md).
 
diff --git a/content/manuals/compose/how-tos/file-watch.md b/content/manuals/compose/how-tos/file-watch.md
@@ -7,7 +7,7 @@ aliases:
 - /compose/file-watch/
 ---
 
-{{< introduced compose 2.22.0 "/manuals/compose/releases/release-notes.md#2220" >}}
+{{< summary-bar feature_name="Compose file watch" >}}
 
 {{% include "compose/watch.md" %}}
 
diff --git a/content/manuals/compose/how-tos/lifecycle.md b/content/manuals/compose/how-tos/lifecycle.md
@@ -6,7 +6,7 @@ desription: How to use lifecycle hooks with Docker Compose
 keywords: cli, compose, lifecycle, hooks reference
 ---
 
-{{< introduced compose 2.30.0 "../releases/release-notes.md#2300" >}}
+{{< summary-bar feature_name="Compose lifecycle hooks" >}}
 
 ## Services lifecycle hooks
 
diff --git a/content/manuals/compose/how-tos/multiple-compose-files/include.md b/content/manuals/compose/how-tos/multiple-compose-files/include.md
@@ -6,7 +6,7 @@ aliases:
 - /compose/multiple-compose-files/include/
 ---
 
-{{< introduced compose 2.20.3 "/manuals/compose/releases/release-notes.md#2203" >}}
+{{< summary-bar feature_name="Compose include" >}}
 
 {{% include "compose/include.md" %}}
 
diff --git a/content/manuals/desktop/features/desktop-cli.md b/content/manuals/desktop/features/desktop-cli.md
@@ -13,7 +13,7 @@ params:
 
 {{< summary-bar feature_name="Docker Desktop CLI" >}}
 
-The Docker Desktop CLI lets you perform key operations such as starting, stopping, restarting, and checking the status of Docker Desktop directly from the command line. It is available with Docker Desktop version 4.37 and later.
+The Docker Desktop CLI lets you perform key operations such as starting, stopping, restarting, and checking the status of Docker Desktop directly from the command line.
 
 The Docker Desktop CLI provides:
 
diff --git a/content/manuals/desktop/features/networking.md b/content/manuals/desktop/features/networking.md
@@ -49,9 +49,9 @@ syntax for `-p` is `HOST_PORT:CLIENT_PORT`.
 
 See [Proxies](/manuals/desktop/settings-and-maintenance/settings.md#proxies)
 
-### SOCKS5 proxy support 
+### SOCKS5 proxy support
 
-{{< introduced desktop 4.28.0 "../release-notes.md#4280" >}}
+{{< summary-bar feature_name="SOCKS5 proxy support" >}}
 
 > [!NOTE]
 >
diff --git a/content/manuals/desktop/setup/install/enterprise-deployment/msi-install-and-configure.md b/content/manuals/desktop/setup/install/enterprise-deployment/msi-install-and-configure.md
@@ -4,23 +4,21 @@ description: Understand how to use the MSI installer. Also explore additional co
 keywords: msi, windows, docker desktop, install, deploy, configure, admin, mdm
 tags: [admin]
 weight: 10
-aliases: 
+aliases:
 - /desktop/install/msi/install-and-configure/
 - /desktop/setup/install/msi/install-and-configure/
 ---
 
-> [!NOTE]
->
-> The MSI installer is available to all company and organization owners with a Business subscription and Docker Desktop version 4.32 and later.
+{{< summary-bar feature_name="MSI installer" >}}
 
 The MSI package supports various MDM (Mobile Device Management) solutions, making it ideal for bulk installations and eliminating the need for manual setups by individual users. With this package, IT administrators can ensure standardized, policy-driven installations of Docker Desktop, enhancing efficiency and software management across their organizations.
 
 ## Install interactively
 
-1. In the [Docker Admin Console](http://admin.docker.com/), navigate to your organization.   
-2. Under **Security and access**, select the **Deploy Docker Desktop** page. 
-3. From the **Windows OS** tab, select the **Download MSI installer** button. 
-4. Once downloaded, double-click `Docker Desktop Installer.msi` to run the installer. 
+1. In the [Docker Admin Console](http://admin.docker.com/), navigate to your organization.
+2. Under **Security and access**, select the **Deploy Docker Desktop** page.
+3. From the **Windows OS** tab, select the **Download MSI installer** button.
+4. Once downloaded, double-click `Docker Desktop Installer.msi` to run the installer.
 5. Once you've accepted the license agreement, you can choose the install location. By default, Docker Desktop is installed at `C:\Program Files\Docker\Docker`.
 6. Configure the Docker Desktop installation. You can:
 
@@ -36,25 +34,25 @@ The MSI package supports various MDM (Mobile Device Management) solutions, makin
 
 If your administrator account is different to your user account, you must add the user to the **docker-users** group:
 1. Run **Computer Management** as an **administrator**.
-2. Navigate to **Local Users and Groups** > **Groups** > **docker-users**. 
+2. Navigate to **Local Users and Groups** > **Groups** > **docker-users**.
 3. Right-click to add the user to the group.
 4. Sign out and sign back in for the changes to take effect.
 
 > [!NOTE]
 >
 > When installing Docker Desktop with the MSI, in-app updates are automatically disabled. This feature ensures your organization maintains the required Docker Desktop version. For Docker Desktop installed with the .exe installer, in-app updates remain supported.
 >
-> Docker Desktop notifies you when an update is available. To update Docker Desktop, download the latest installer from the Docker Admin Console. Navigate to the  **Deploy Docker Desktop** page > under **Security and access**. 
+> Docker Desktop notifies you when an update is available. To update Docker Desktop, download the latest installer from the Docker Admin Console. Navigate to the  **Deploy Docker Desktop** page > under **Security and access**.
 >
 > To keep up to date with new releases, check the [release notes](/manuals/desktop/release-notes.md) page.
 
 ## Install from the command line
 
 This section covers command line installations of Docker Desktop using PowerShell. It provides common installation commands that you can run. You can also add additional arguments which are outlined in [configuration options](#configuration-options).
 
-When installing Docker Desktop, you can choose between interactive or non-interactive installations. 
+When installing Docker Desktop, you can choose between interactive or non-interactive installations.
 
-Interactive installations, without specifying `/quiet` or `/qn`, display the user interface and let you select your own properties. 
+Interactive installations, without specifying `/quiet` or `/qn`, display the user interface and let you select your own properties.
 
 When installing via the user interface it's possible to:
 
@@ -239,7 +237,7 @@ The registry key is as follows:
 SOFTWARE\Docker Inc.\Docker Desktop\DisableMsiAnalytics
 ```
 
-When analytics is disabled, this key has a value of `1`. 
+When analytics is disabled, this key has a value of `1`.
 
 ## Additional resources
 
diff --git a/content/manuals/desktop/setup/install/enterprise-deployment/use-jamf-pro.md b/content/manuals/desktop/setup/install/enterprise-deployment/use-jamf-pro.md
@@ -6,6 +6,8 @@ tags: [admin]
 weight: 40
 ---
 
+{{< summary-bar feature_name="Jamf Pro" >}}
+
 Learn how to deploy Docker Desktop for Mac using Jamf Pro.
 
 First, upload the package:
diff --git a/content/manuals/engine/cli/otel.md b/content/manuals/engine/cli/otel.md
@@ -6,7 +6,7 @@ aliases:
   - /config/otel/
 ---
 
-{{< introduced engine 26.1.0 >}}
+{{< summary-bar feature_name="Docker CLI OpenTelemetry" >}}
 
 The Docker CLI supports [OpenTelemetry](https://opentelemetry.io/docs/) instrumentation
 for emitting metrics about command invocations. This is disabled by default.
diff --git a/content/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md b/content/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md
@@ -138,7 +138,7 @@ ones in the repository.
 
 ### Docker Socket Mount Permissions for derived images
 
-{{< introduced desktop 4.34.0 "../../../../desktop/release-notes.md#4340" >}}
+{{< summary-bar feature_name="Docker Scout Mount Permissions" >}}
 
 As described in the prior section, administrators can configure the list of container
 images that are allowed to mount the Docker socket via the `imageList`.
diff --git a/content/reference/compose-file/build.md b/content/reference/compose-file/build.md
@@ -83,7 +83,7 @@ Alternatively `build` can be an object with fields defined as follows:
 
 ### `additional_contexts`
 
-{{< introduced compose 2.17.0 "/manuals/compose/releases/release-notes.md#2170" >}}
+{{< summary-bar feature_name="Build additional contexts" >}}
 
 `additional_contexts` defines a list of named contexts the image builder should use during image build.
 
@@ -229,7 +229,7 @@ build:
 
 ### `dockerfile_inline`
 
-{{< introduced compose 2.17.0 "/manuals/compose/releases/release-notes.md#2170" >}}
+{{< summary-bar feature_name="Build dockerfile inline" >}}
 
 `dockerfile_inline` defines the Dockerfile content as an inlined string in a Compose file. When set, the `dockerfile`
 attribute is not allowed and Compose rejects any Compose file having both set.
@@ -246,7 +246,7 @@ build:
 
 ### `entitlements`
 
-{{< introduced compose 2.27.1 "/manuals/compose/releases/release-notes.md#2271" >}}
+{{< summary-bar feature_name="Build entitlements" >}}
 
 `entitlements` defines extra privileged entitlements to be allowed during the build.
 
@@ -392,7 +392,7 @@ Composes reports an error in the following cases:
 
 ### `privileged`
 
-{{< introduced compose 2.15.0 "/manuals/compose/releases/release-notes.md#2" >}}
+{{< summary-bar feature_name="Build privileged" >}}
 
 `privileged` configures the service image to build with elevated privileges. Support and actual impacts are platform specific.
 
@@ -555,7 +555,7 @@ build:
 
 ### `ulimits`
 
-{{< introduced compose 2.23.1 "/manuals/compose/releases/release-notes.md#2231" >}}
+{{< summary-bar feature_name="Build ulimits" >}}
 
 `ulimits` overrides the default `ulimits` for a container. It's specified either as an integer for a single limit
 or as mapping for soft/hard limits.
diff --git a/content/reference/compose-file/develop.md b/content/reference/compose-file/develop.md
@@ -64,9 +64,9 @@ Compose to monitor source code for changes. For more information, see [Use Compo
 
 #### `exec`
 
-{{< introduced compose 2.23.2 "/manuals/compose/releases/release-notes.md#2232" >}}
+{{< summary-bar feature_name="Compose exec" >}}
 
-`exec` is only relevant when `action` is set to `sync+exec`. Like [service hooks](services.md#post_start), `exec` is used to define the command to be run inside the container once it has started. 
+`exec` is only relevant when `action` is set to `sync+exec`. Like [service hooks](services.md#post_start), `exec` is used to define the command to be run inside the container once it has started.
 
 - `command`: Specifies the command to run once the container starts. This attribute is required, and you can choose to use either the shell form or the exec form.
 - `user`: The user to run the command. If not set, the command is run with the same user as the main service command.
diff --git a/content/reference/compose-file/include.md b/content/reference/compose-file/include.md
diff --git a/content/reference/compose-file/merge.md b/content/reference/compose-file/merge.md
diff --git a/content/reference/compose-file/services.md b/content/reference/compose-file/services.md
diff --git a/data/summary.yaml b/data/summary.yaml
diff --git a/hugo.yaml b/hugo.yaml
diff --git a/i18n/en.yaml b/i18n/en.yaml
diff --git a/layouts/shortcodes/introduced.html b/layouts/shortcodes/introduced.html
diff --git a/layouts/shortcodes/summary-bar.html b/layouts/shortcodes/summary-bar.html

Original file line number	Diff line number	Diff line change
@@ -49,9 +49,9 @@ syntax for `-p` is `HOST_PORT:CLIENT_PORT`.
`49`	`49`
`50`	`50`	`See [Proxies](/manuals/desktop/settings-and-maintenance/settings.md#proxies)`
`51`	`51`
`52`		`-### SOCKS5 proxy support`
	`52`	`+### SOCKS5 proxy support`
`53`	`53`
`54`		`-{{< introduced desktop 4.28.0 "../release-notes.md#4280" >}}`
	`54`	`+{{< summary-bar feature_name="SOCKS5 proxy support" >}}`
`55`	`55`
`56`	`56`	`> [!NOTE]`
`57`	`57`	`>`