Skip to content

Commit 9f56d94

Browse files
chore: summary bar cleanup (#21887)
## 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
1 parent 04d0957 commit 9f56d94

File tree

24 files changed

+186
-206
lines changed

24 files changed

+186
-206
lines changed

content/contribute/components/call-outs.md

+18-29
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,25 @@ toc_max: 3
66

77
We support these broad categories of callouts:
88

9-
- Alerts (Note, Tip, Important, Warning, Caution)
10-
- Version callouts
11-
- Experimental, which use the `{{%/* experimental */%}}` shortcode
12-
- Restricted, which use the `{{%/* restricted */%}}` shortcode
9+
- Alerts: Note, Tip, Important, Warning, Caution
1310

14-
The experimental and restricted shortcodes take a title as an argument. The
15-
title is optional, defaults to "Experimental" or "Restricted" respectively, and
16-
is displayed in the callout.
11+
We also support summary bars, which represent a feature's required subscription, version, or Adminstrator role.
12+
To add a summary bar:
13+
14+
Add the feature name to the `/data/summary.yaml` file. Use the following attributes:
15+
16+
| Attribute | Description | Possible values |
17+
|----------------|--------------------------------------------------------|---------------------------------------------------------|
18+
| `subscription` | Notes the subscription required to use the feature | All, Personal, Pro, Team, Business |
19+
| `availability` | Notes what product development stage the feature is in | Experimental, Beta, Early access, GA, Retired |
20+
| `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 |
21+
| `for` | Notes if the feature is intended for IT Administrators | Administrators |
22+
23+
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.
1724

1825
## Examples
1926

20-
{{< introduced buildx 0.16.0 >}}
27+
{{< summary-bar feature_name="PKG installer" >}}
2128

2229
> [!NOTE]
2330
>
@@ -54,18 +61,10 @@ is displayed in the callout.
5461
5562
For both of the following callouts, consult [the Docker release lifecycle](/release-lifecycle) for more information on when to use them.
5663

57-
{{% experimental title="Beta feature" %}}
58-
The Builds view is currently in Beta. This feature may change or be removed from future releases.
59-
{{% /experimental %}}
60-
61-
{{% restricted %}}
62-
Docker Scout is an [early access](/release-lifecycle/#early-access-ea) product.
63-
{{% /restricted %}}
64-
65-
## Formatting
64+
## Formatting
6665

6766
```go
68-
{{</* introduced buildx 0.10.4 "../../release-notes.md#0104" */>}}
67+
> {{< summary-bar feature_name="PKG installer" >}}
6968
```
7069

7170
```html
@@ -101,14 +100,4 @@ Docker Scout is an [early access](/release-lifecycle/#early-access-ea) product.
101100
> [!CAUTION]
102101
>
103102
> Here be dragons.
104-
```
105-
106-
```go
107-
{{%/* experimental title="Beta feature" */%}}
108-
The Builds view is currently in Beta. This feature may change or be removed from future releases.
109-
{{%/* /experimental */%}}
110-
111-
{{%/* restricted */%}}
112-
Docker Scout is an [early access](/release-lifecycle/#early-access-ea) product.
113-
{{%/* /restricted */%}}
114-
```
103+
```

content/manuals/build/builders/drivers/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ To build an image using a non-default driver and load it to the image store,
6666

6767
### Load by default
6868

69-
{{< introduced buildx 0.14.0 >}}
69+
{{< summary-bar feature_name="Load by default" >}}
7070

7171
You can configure the custom build drivers to behave in a similar way to the
7272
default `docker` driver, and load images to the local image store by default.

content/manuals/build/building/variables.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ Setting `NO_COLOR` to anything turns off colorized output, as recommended by
352352

353353
### BUILDKIT_HOST
354354

355-
{{< introduced buildx 0.9.0 "../release-notes.md#090" >}}
355+
{{< summary-bar feature_name="Buildkit host" >}}
356356

357357
You use the `BUILDKIT_HOST` to specify the address of a BuildKit daemon to use
358358
as a remote builder. This is the same as specifying the address as a positional
@@ -438,7 +438,7 @@ Example:
438438

439439
### BUILDX_BAKE_GIT_AUTH_HEADER
440440

441-
{{< introduced buildx 0.14.0 >}}
441+
{{< summary-bar feature_name="Buildx bake Git auth token" >}}
442442

443443
Sets the HTTP authentication scheme when using a remote Bake definition in a private Git repository.
444444
This is equivalent to the [`GIT_AUTH_HEADER` secret](./secrets#http-authentication-scheme),
@@ -453,7 +453,7 @@ $ export BUILDX_BAKE_GIT_AUTH_HEADER=basic
453453

454454
### BUILDX_BAKE_GIT_AUTH_TOKEN
455455

456-
{{< introduced buildx 0.14.0 >}}
456+
{{< summary-bar feature_name="Buildx bake Git auth token" >}}
457457

458458
Sets the HTTP authentication token when using a remote Bake definition in a private Git repository.
459459
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)
467467

468468
### BUILDX_BAKE_GIT_SSH
469469

470-
{{< introduced buildx 0.14.0 >}}
470+
{{< summary-bar feature_name="Buildx bake Git SSH" >}}
471471

472472
Lets you specify a list of SSH agent socket filepaths to forward to Bake
473473
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
512512

513513
### BUILDX_CPU_PROFILE
514514

515-
{{< introduced buildx 0.18.0 >}}
515+
{{< summary-bar feature_name="Buildx CPU profile" >}}
516516

517517
If specified, Buildx generates a `pprof` CPU profile at the specified location.
518518

@@ -538,7 +538,7 @@ $ export BUILDX_EXPERIMENTAL=1
538538

539539
### BUILDX_GIT_CHECK_DIRTY
540540

541-
{{< introduced buildx 0.10.4 "../release-notes.md#0104" >}}
541+
{{< summary-bar feature_name="Buildx Git check dirty" >}}
542542

543543
When set to true, checks for dirty state in source control information for
544544
[provenance attestations](/manuals/build/metadata/attestations/slsa-provenance.md).
@@ -551,7 +551,7 @@ $ export BUILDX_GIT_CHECK_DIRTY=1
551551

552552
### BUILDX_GIT_INFO
553553

554-
{{< introduced buildx 0.10.0 "../release-notes.md#0100" >}}
554+
{{< summary-bar feature_name="Buildx Git info" >}}
555555

556556
When set to false, removes source control information from
557557
[provenance attestations](/manuals/build/metadata/attestations/slsa-provenance.md).
@@ -564,7 +564,7 @@ $ export BUILDX_GIT_INFO=0
564564

565565
### BUILDX_GIT_LABELS
566566

567-
{{< introduced buildx 0.10.0 "../release-notes.md#0100" >}}
567+
{{< summary-bar feature_name="Buildx Git labels" >}}
568568

569569
Adds provenance labels, based on Git information, to images that you build. The
570570
labels are:
@@ -593,7 +593,7 @@ If the repository is in a dirty state, the `revision` gets a `-dirty` suffix.
593593

594594
### BUILDX_MEM_PROFILE
595595

596-
{{< introduced buildx 0.18.0 >}}
596+
{{< summary-bar feature_name="Buildx mem profile" >}}
597597

598598
If specified, Buildx generates a `pprof` memory profile at the specified
599599
location.
@@ -610,7 +610,7 @@ $ export BUILDX_MEM_PROFILE=buildx_mem.prof
610610

611611
### BUILDX_NO_DEFAULT_ATTESTATIONS
612612

613-
{{< introduced buildx 0.10.4 "../release-notes.md#0104" >}}
613+
{{< summary-bar feature_name="Buildx no default" >}}
614614

615615
By default, BuildKit v0.11 and later adds
616616
[provenance attestations](/manuals/build/metadata/attestations/slsa-provenance.md) to images you

content/manuals/build/exporters/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ WARNING: No output specified with docker-container driver.
184184

185185
## Multiple exporters
186186

187-
{{< introduced buildx 0.13.0 >}}
187+
{{< summary-bar feature_name="Build multiple exporters" >}}
188188

189189
You can use multiple exporters for any given build by specifying the `--output`
190190
flag multiple times. This requires **both Buildx and BuildKit** version 0.13.0

content/manuals/compose/how-tos/environment-variables/envvars.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ If `COMPOSE_ENV_FILES` is not set, and you don't provide `--env-file` in the CLI
172172

173173
### COMPOSE\_MENU
174174

175-
{{< introduced compose 2.26.0 "/manuals/compose/releases/release-notes.md#2260" >}}
175+
{{< summary-bar feature_name="Compose menu" >}}
176176

177177
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).
178178

@@ -183,7 +183,7 @@ When enabled, Compose displays a navigation menu where you can choose to open th
183183

184184
### COMPOSE\_EXPERIMENTAL
185185

186-
{{< introduced compose 2.26.0 "/manuals/compose/releases/release-notes.md#2260" >}}
186+
{{< summary-bar feature_name="Compose experimental" >}}
187187

188188
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).
189189

content/manuals/compose/how-tos/file-watch.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ aliases:
77
- /compose/file-watch/
88
---
99

10-
{{< introduced compose 2.22.0 "/manuals/compose/releases/release-notes.md#2220" >}}
10+
{{< summary-bar feature_name="Compose file watch" >}}
1111

1212
{{% include "compose/watch.md" %}}
1313

content/manuals/compose/how-tos/lifecycle.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ desription: How to use lifecycle hooks with Docker Compose
66
keywords: cli, compose, lifecycle, hooks reference
77
---
88

9-
{{< introduced compose 2.30.0 "../releases/release-notes.md#2300" >}}
9+
{{< summary-bar feature_name="Compose lifecycle hooks" >}}
1010

1111
## Services lifecycle hooks
1212

content/manuals/compose/how-tos/multiple-compose-files/include.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ aliases:
66
- /compose/multiple-compose-files/include/
77
---
88

9-
{{< introduced compose 2.20.3 "/manuals/compose/releases/release-notes.md#2203" >}}
9+
{{< summary-bar feature_name="Compose include" >}}
1010

1111
{{% include "compose/include.md" %}}
1212

content/manuals/desktop/features/desktop-cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ params:
1313

1414
{{< summary-bar feature_name="Docker Desktop CLI" >}}
1515

16-
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.
16+
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.
1717

1818
The Docker Desktop CLI provides:
1919

content/manuals/desktop/features/networking.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ syntax for `-p` is `HOST_PORT:CLIENT_PORT`.
4949

5050
See [Proxies](/manuals/desktop/settings-and-maintenance/settings.md#proxies)
5151

52-
### SOCKS5 proxy support
52+
### SOCKS5 proxy support
5353

54-
{{< introduced desktop 4.28.0 "../release-notes.md#4280" >}}
54+
{{< summary-bar feature_name="SOCKS5 proxy support" >}}
5555

5656
> [!NOTE]
5757
>

content/manuals/desktop/setup/install/enterprise-deployment/msi-install-and-configure.md

+11-13
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,21 @@ description: Understand how to use the MSI installer. Also explore additional co
44
keywords: msi, windows, docker desktop, install, deploy, configure, admin, mdm
55
tags: [admin]
66
weight: 10
7-
aliases:
7+
aliases:
88
- /desktop/install/msi/install-and-configure/
99
- /desktop/setup/install/msi/install-and-configure/
1010
---
1111

12-
> [!NOTE]
13-
>
14-
> The MSI installer is available to all company and organization owners with a Business subscription and Docker Desktop version 4.32 and later.
12+
{{< summary-bar feature_name="MSI installer" >}}
1513

1614
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.
1715

1816
## Install interactively
1917

20-
1. In the [Docker Admin Console](http://admin.docker.com/), navigate to your organization.
21-
2. Under **Security and access**, select the **Deploy Docker Desktop** page.
22-
3. From the **Windows OS** tab, select the **Download MSI installer** button.
23-
4. Once downloaded, double-click `Docker Desktop Installer.msi` to run the installer.
18+
1. In the [Docker Admin Console](http://admin.docker.com/), navigate to your organization.
19+
2. Under **Security and access**, select the **Deploy Docker Desktop** page.
20+
3. From the **Windows OS** tab, select the **Download MSI installer** button.
21+
4. Once downloaded, double-click `Docker Desktop Installer.msi` to run the installer.
2422
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`.
2523
6. Configure the Docker Desktop installation. You can:
2624

@@ -36,25 +34,25 @@ The MSI package supports various MDM (Mobile Device Management) solutions, makin
3634

3735
If your administrator account is different to your user account, you must add the user to the **docker-users** group:
3836
1. Run **Computer Management** as an **administrator**.
39-
2. Navigate to **Local Users and Groups** > **Groups** > **docker-users**.
37+
2. Navigate to **Local Users and Groups** > **Groups** > **docker-users**.
4038
3. Right-click to add the user to the group.
4139
4. Sign out and sign back in for the changes to take effect.
4240

4341
> [!NOTE]
4442
>
4543
> 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.
4644
>
47-
> 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**.
45+
> 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**.
4846
>
4947
> To keep up to date with new releases, check the [release notes](/manuals/desktop/release-notes.md) page.
5048
5149
## Install from the command line
5250

5351
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).
5452

55-
When installing Docker Desktop, you can choose between interactive or non-interactive installations.
53+
When installing Docker Desktop, you can choose between interactive or non-interactive installations.
5654

57-
Interactive installations, without specifying `/quiet` or `/qn`, display the user interface and let you select your own properties.
55+
Interactive installations, without specifying `/quiet` or `/qn`, display the user interface and let you select your own properties.
5856

5957
When installing via the user interface it's possible to:
6058

@@ -239,7 +237,7 @@ The registry key is as follows:
239237
SOFTWARE\Docker Inc.\Docker Desktop\DisableMsiAnalytics
240238
```
241239

242-
When analytics is disabled, this key has a value of `1`.
240+
When analytics is disabled, this key has a value of `1`.
243241

244242
## Additional resources
245243

content/manuals/desktop/setup/install/enterprise-deployment/use-jamf-pro.md

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ tags: [admin]
66
weight: 40
77
---
88

9+
{{< summary-bar feature_name="Jamf Pro" >}}
10+
911
Learn how to deploy Docker Desktop for Mac using Jamf Pro.
1012

1113
First, upload the package:

content/manuals/engine/cli/otel.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ aliases:
66
- /config/otel/
77
---
88

9-
{{< introduced engine 26.1.0 >}}
9+
{{< summary-bar feature_name="Docker CLI OpenTelemetry" >}}
1010

1111
The Docker CLI supports [OpenTelemetry](https://opentelemetry.io/docs/) instrumentation
1212
for emitting metrics about command invocations. This is disabled by default.

content/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ ones in the repository.
138138

139139
### Docker Socket Mount Permissions for derived images
140140

141-
{{< introduced desktop 4.34.0 "../../../../desktop/release-notes.md#4340" >}}
141+
{{< summary-bar feature_name="Docker Scout Mount Permissions" >}}
142142

143143
As described in the prior section, administrators can configure the list of container
144144
images that are allowed to mount the Docker socket via the `imageList`.

content/reference/compose-file/build.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Alternatively `build` can be an object with fields defined as follows:
8383

8484
### `additional_contexts`
8585

86-
{{< introduced compose 2.17.0 "/manuals/compose/releases/release-notes.md#2170" >}}
86+
{{< summary-bar feature_name="Build additional contexts" >}}
8787

8888
`additional_contexts` defines a list of named contexts the image builder should use during image build.
8989

@@ -229,7 +229,7 @@ build:
229229

230230
### `dockerfile_inline`
231231

232-
{{< introduced compose 2.17.0 "/manuals/compose/releases/release-notes.md#2170" >}}
232+
{{< summary-bar feature_name="Build dockerfile inline" >}}
233233

234234
`dockerfile_inline` defines the Dockerfile content as an inlined string in a Compose file. When set, the `dockerfile`
235235
attribute is not allowed and Compose rejects any Compose file having both set.
@@ -246,7 +246,7 @@ build:
246246

247247
### `entitlements`
248248

249-
{{< introduced compose 2.27.1 "/manuals/compose/releases/release-notes.md#2271" >}}
249+
{{< summary-bar feature_name="Build entitlements" >}}
250250

251251
`entitlements` defines extra privileged entitlements to be allowed during the build.
252252

@@ -392,7 +392,7 @@ Composes reports an error in the following cases:
392392

393393
### `privileged`
394394

395-
{{< introduced compose 2.15.0 "/manuals/compose/releases/release-notes.md#2" >}}
395+
{{< summary-bar feature_name="Build privileged" >}}
396396

397397
`privileged` configures the service image to build with elevated privileges. Support and actual impacts are platform specific.
398398

@@ -555,7 +555,7 @@ build:
555555

556556
### `ulimits`
557557

558-
{{< introduced compose 2.23.1 "/manuals/compose/releases/release-notes.md#2231" >}}
558+
{{< summary-bar feature_name="Build ulimits" >}}
559559

560560
`ulimits` overrides the default `ulimits` for a container. It's specified either as an integer for a single limit
561561
or as mapping for soft/hard limits.

content/reference/compose-file/develop.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ Compose to monitor source code for changes. For more information, see [Use Compo
6464

6565
#### `exec`
6666

67-
{{< introduced compose 2.23.2 "/manuals/compose/releases/release-notes.md#2232" >}}
67+
{{< summary-bar feature_name="Compose exec" >}}
6868

69-
`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.
69+
`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.
7070

7171
- `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.
7272
- `user`: The user to run the command. If not set, the command is run with the same user as the main service command.

0 commit comments

Comments
 (0)