Skip to content

Commit fcdd28e

Browse files
authored
Merge pull request #21931 from docker/published-update
publish updates from main
2 parents cd54639 + 313ea77 commit fcdd28e

File tree

34 files changed

+338
-255
lines changed

34 files changed

+338
-255
lines changed

_vale/config/vocabularies/Docker/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Jamf
5757
JetBrains
5858
Kerberos
5959
Kitematic
60+
Kubeadm
6061
Kubernetes
6162
Laravel
6263
Laradock

content/contribute/components/call-outs.md

Lines changed: 18 additions & 29 deletions
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 10 additions & 10 deletions
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 4 additions & 2 deletions
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

@@ -35,6 +35,8 @@ docker desktop COMMAND [OPTIONS]
3535
| `restart` | Restarts Docker Desktop |
3636
| `status` | Displays whether Docker Desktop is running or stopped. |
3737
| `engine ls` | Lists available engines (Windows only) |
38-
| `engine use` | Switch between Linux and Windows containers (Windows only) |
38+
| `engine use` | Switch between Linux and Windows containers (Windows only) |
39+
| `update` | Manage Docker Desktop updates. Available for Mac only and with Docker Desktop version 4.38 and later. |
40+
3941

4042
For more details on each command, see the [Docker Desktop CLI reference](/reference/cli/docker/desktop/_index.md).

0 commit comments

Comments
 (0)