Skip to content
This repository was archived by the owner on Oct 13, 2023. It is now read-only.

Commit 256e26c

Browse files
Merge pull request #2453 from thaJeztah/19.03_backport_fixup_markdown_and_links
[19.03 backport] documentation changes Upstream-commit: 05ad944d13755a7e0a44cef3e4330992fd278853 Component: cli
2 parents 2490034 + 36c6db1 commit 256e26c

87 files changed

Lines changed: 2167 additions & 1400 deletions

Some content is hidden

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

components/cli/docs/extend/index.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ plugins using Docker Engine.
2424
For information about the legacy plugin system available in Docker Engine 1.12
2525
and earlier, see [Understand legacy Docker Engine plugins](legacy_plugins.md).
2626

27-
> **Note**: Docker Engine managed plugins are currently not supported
28-
on Windows daemons.
27+
> **Note**
28+
>
29+
> Docker Engine managed plugins are currently not supported on Windows daemons.
2930
3031
## Installing and using a plugin
3132

@@ -45,7 +46,12 @@ operation, such as creating a volume.
4546
In the following example, you install the `sshfs` plugin, verify that it is
4647
enabled, and use it to create a volume.
4748

48-
> **Note**: This example is intended for instructional purposes only. Once the volume is created, your SSH password to the remote host will be exposed as plaintext when inspecting the volume. You should delete the volume as soon as you are done with the example.
49+
> **Note**
50+
>
51+
> This example is intended for instructional purposes only. Once the volume is
52+
> created, your SSH password to the remote host will be exposed as plaintext
53+
> when inspecting the volume. You should delete the volume as soon as you are
54+
> done with the example.
4955
5056
1. Install the `sshfs` plugin.
5157

components/cli/docs/extend/plugins_authorization.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,10 @@ Authorization plugins must follow the rules described in [Docker Plugin API](plu
5353
Each plugin must reside within directories described under the
5454
[Plugin discovery](plugin_api.md#plugin-discovery) section.
5555

56-
**Note**: the abbreviations `AuthZ` and `AuthN` mean authorization and authentication
57-
respectively.
56+
> **Note**
57+
>
58+
> The abbreviations `AuthZ` and `AuthN` mean authorization and authentication
59+
> respectively.
5860
5961
## Default user authorization mechanism
6062

components/cli/docs/extend/plugins_metrics.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,11 @@ Docker exposes internal metrics based on the prometheus format. Metrics plugins
1818
enable accessing these metrics in a consistent way by providing a Unix
1919
socket at a predefined path where the plugin can scrape the metrics.
2020

21-
> **Note**: that while the plugin interface for metrics is non-experimental, the naming
22-
of the metrics and metric labels is still considered experimental and may change
23-
in a future version.
21+
> **Note**
22+
>
23+
> While the plugin interface for metrics is non-experimental, the naming of the
24+
> metrics and metric labels is still considered experimental and may change in a
25+
> future version.
2426
2527
## Creating a metrics plugin
2628

components/cli/docs/extend/plugins_volume.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,11 @@ provide the Docker Daemon with writeable paths on the host filesystem. The Docke
9090
daemon provides these paths to containers to consume. The Docker daemon makes
9191
the volumes available by bind-mounting the provided paths into the containers.
9292

93-
> **Note**: Volume plugins should *not* write data to the `/var/lib/docker/`
94-
> directory, including `/var/lib/docker/volumes`. The `/var/lib/docker/`
95-
> directory is reserved for Docker.
93+
> **Note**
94+
>
95+
> Volume plugins should *not* write data to the `/var/lib/docker/` directory,
96+
> including `/var/lib/docker/volumes`. The `/var/lib/docker/` directory is
97+
> reserved for Docker.
9698
9799
### `/VolumeDriver.Create`
98100

0 commit comments

Comments
 (0)