Skip to content

Commit 35626ba

Browse files
authored
Merge pull request #5350 from dvdksn/docs-alerts-syntax
docs: use gh alert syntax for callouts
2 parents d47c36d + f1befab commit 35626ba

56 files changed

Lines changed: 101 additions & 193 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/deprecated.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -562,8 +562,7 @@ Docker API v1.42 and up now ignores this option when set. Older versions of the
562562
API continue to accept the option, but depending on the OCI runtime used, may
563563
take no effect.
564564

565-
> **Note**
566-
>
565+
> [!NOTE]
567566
> While not deprecated (yet) in Docker, the OCI runtime specification also
568567
> deprecated the `memory.kmem.tcp.limit_in_bytes` option. When using `runc` as
569568
> runtime, this option takes no effect. The linux kernel did not explicitly

docs/extend/index.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ plugins using Docker Engine.
1616
For information about legacy (non-managed) plugins, refer to
1717
[Understand legacy Docker Engine plugins](legacy_plugins.md).
1818

19-
> **Note**
20-
>
19+
> [!NOTE]
2120
> Docker Engine managed plugins are currently not supported on Windows daemons.
2221
2322
## Installing and using a plugin
@@ -38,8 +37,7 @@ operation, such as creating a volume.
3837
In the following example, you install the `sshfs` plugin, verify that it is
3938
enabled, and use it to create a volume.
4039

41-
> **Note**
42-
>
40+
> [!NOTE]
4341
> This example is intended for instructional purposes only. Once the volume is
4442
> created, your SSH password to the remote host is exposed as plaintext when
4543
> inspecting the volume. Delete the volume as soon as you are done with the
@@ -126,8 +124,7 @@ commands and options, see the
126124
The `rootfs` directory represents the root filesystem of the plugin. In this
127125
example, it was created from a Dockerfile:
128126

129-
> **Note**
130-
>
127+
> [!NOTE]
131128
> The `/run/docker/plugins` directory is mandatory inside of the
132129
> plugin's filesystem for Docker to communicate with the plugin.
133130

docs/extend/plugins_authorization.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ Authorization plugins must follow the rules described in [Docker Plugin API](plu
4343
Each plugin must reside within directories described under the
4444
[Plugin discovery](plugin_api.md#plugin-discovery) section.
4545

46-
> **Note**
47-
>
46+
> [!NOTE]
4847
> The abbreviations `AuthZ` and `AuthN` mean authorization and authentication
4948
> respectively.
5049

docs/extend/plugins_metrics.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ Docker exposes internal metrics based on the Prometheus format. Metrics plugins
88
enable accessing these metrics in a consistent way by providing a Unix
99
socket at a predefined path where the plugin can scrape the metrics.
1010

11-
> **Note**
12-
>
11+
> [!NOTE]
1312
> While the plugin interface for metrics is non-experimental, the naming of the
1413
> metrics and metric labels is still considered experimental and may change in a
1514
> future version.

docs/extend/plugins_volume.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,7 @@ provide the Docker Daemon with writeable paths on the host filesystem. The Docke
8080
daemon provides these paths to containers to consume. The Docker daemon makes
8181
the volumes available by bind-mounting the provided paths into the containers.
8282

83-
> **Note**
84-
>
83+
> [!NOTE]
8584
> Volume plugins should *not* write data to the `/var/lib/docker/` directory,
8685
> including `/var/lib/docker/volumes`. The `/var/lib/docker/` directory is
8786
> reserved for Docker.

docs/reference/commandline/config_create.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ Creates a config using standard input or from a file for the config content.
1919

2020
For detailed information about using configs, refer to [store configuration data using Docker Configs](https://docs.docker.com/engine/swarm/configs/).
2121

22-
> **Note**
23-
>
22+
> [!NOTE]
2423
> This is a cluster management command, and must be executed on a Swarm
2524
> manager node. To learn about managers and workers, refer to the
2625
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the

docs/reference/commandline/config_inspect.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ describes all the details of the format.
2525

2626
For detailed information about using configs, refer to [store configuration data using Docker Configs](https://docs.docker.com/engine/swarm/configs/).
2727

28-
> **Note**
29-
>
28+
> [!NOTE]
3029
> This is a cluster management command, and must be executed on a Swarm
3130
> manager node. To learn about managers and workers, refer to the
3231
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the

docs/reference/commandline/config_ls.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ Run this command on a manager node to list the configs in the Swarm.
2424

2525
For detailed information about using configs, refer to [store configuration data using Docker Configs](https://docs.docker.com/engine/swarm/configs/).
2626

27-
> **Note**
28-
>
27+
> [!NOTE]
2928
> This is a cluster management command, and must be executed on a Swarm
3029
> manager node. To learn about managers and workers, refer to the
3130
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the

docs/reference/commandline/config_rm.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ Removes the specified configs from the Swarm.
1616

1717
For detailed information about using configs, refer to [store configuration data using Docker Configs](https://docs.docker.com/engine/swarm/configs/).
1818

19-
> **Note**
20-
>
19+
> [!NOTE]
2120
> This is a cluster management command, and must be executed on a Swarm
2221
> manager node. To learn about managers and workers, refer to the
2322
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the
@@ -32,8 +31,7 @@ $ docker config rm my_config
3231
sapth4csdo5b6wz2p5uimh5xg
3332
```
3433

35-
> **Warning**
36-
>
34+
> [!WARNING]
3735
> This command doesn't ask for confirmation before removing a config.
3836
{ .warning }
3937

docs/reference/commandline/container_attach.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ Use `docker attach` to attach your terminal's standard input, output, and error
2525
ID or name. This lets you view its output or control it interactively, as
2626
though the commands were running directly in your terminal.
2727

28-
> **Note**
29-
>
28+
> [!NOTE]
3029
> The `attach` command displays the output of the container's `ENTRYPOINT` and
3130
> `CMD` process. This can appear as if the attach command is hung when in fact
3231
> the process may simply not be writing any output at that time.
@@ -39,8 +38,7 @@ container. If `--sig-proxy` is true (the default),`CTRL-c` sends a `SIGINT` to
3938
the container. If the container was run with `-i` and `-t`, you can detach from
4039
a container and leave it running using the `CTRL-p CTRL-q` key sequence.
4140

42-
> **Note**
43-
>
41+
> [!NOTE]
4442
> A process running as PID 1 inside a container is treated specially by
4543
> Linux: it ignores any signal with the default action. So, the process
4644
> doesn't terminate on `SIGINT` or `SIGTERM` unless it's coded to do so.

0 commit comments

Comments
 (0)