docs/extend: reformat notes

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2020-04-19 17:09:14 +02:00
parent 16730a2ab6
commit e4fc8cfa23
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
4 changed files with 23 additions and 11 deletions

View File

@ -24,8 +24,9 @@ plugins using Docker Engine.
For information about the legacy plugin system available in Docker Engine 1.12 For information about the legacy plugin system available in Docker Engine 1.12
and earlier, see [Understand legacy Docker Engine plugins](legacy_plugins.md). and earlier, see [Understand legacy Docker Engine plugins](legacy_plugins.md).
> **Note**: Docker Engine managed plugins are currently not supported > **Note**
on Windows daemons. >
> Docker Engine managed plugins are currently not supported on Windows daemons.
## Installing and using a plugin ## Installing and using a plugin
@ -45,7 +46,12 @@ operation, such as creating a volume.
In the following example, you install the `sshfs` plugin, verify that it is In the following example, you install the `sshfs` plugin, verify that it is
enabled, and use it to create a volume. enabled, and use it to create a volume.
> **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. > **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.
1. Install the `sshfs` plugin. 1. Install the `sshfs` plugin.

View File

@ -53,8 +53,10 @@ Authorization plugins must follow the rules described in [Docker Plugin API](plu
Each plugin must reside within directories described under the Each plugin must reside within directories described under the
[Plugin discovery](plugin_api.md#plugin-discovery) section. [Plugin discovery](plugin_api.md#plugin-discovery) section.
**Note**: the abbreviations `AuthZ` and `AuthN` mean authorization and authentication > **Note**
respectively. >
> The abbreviations `AuthZ` and `AuthN` mean authorization and authentication
> respectively.
## Default user authorization mechanism ## Default user authorization mechanism

View File

@ -18,9 +18,11 @@ Docker exposes internal metrics based on the prometheus format. Metrics plugins
enable accessing these metrics in a consistent way by providing a Unix enable accessing these metrics in a consistent way by providing a Unix
socket at a predefined path where the plugin can scrape the metrics. socket at a predefined path where the plugin can scrape the metrics.
> **Note**: that while the plugin interface for metrics is non-experimental, the naming > **Note**
of the metrics and metric labels is still considered experimental and may change >
in a future version. > While the plugin interface for metrics is non-experimental, the naming of the
> metrics and metric labels is still considered experimental and may change in a
> future version.
## Creating a metrics plugin ## Creating a metrics plugin

View File

@ -90,9 +90,11 @@ provide the Docker Daemon with writeable paths on the host filesystem. The Docke
daemon provides these paths to containers to consume. The Docker daemon makes daemon provides these paths to containers to consume. The Docker daemon makes
the volumes available by bind-mounting the provided paths into the containers. the volumes available by bind-mounting the provided paths into the containers.
> **Note**: Volume plugins should *not* write data to the `/var/lib/docker/` > **Note**
> directory, including `/var/lib/docker/volumes`. The `/var/lib/docker/` >
> directory is reserved for Docker. > Volume plugins should *not* write data to the `/var/lib/docker/` directory,
> including `/var/lib/docker/volumes`. The `/var/lib/docker/` directory is
> reserved for Docker.
### `/VolumeDriver.Create` ### `/VolumeDriver.Create`