From e4fc8cfa23b8c677fbaa2c1ce3fdcaac1c8c1c65 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Sun, 19 Apr 2020 17:09:14 +0200 Subject: [PATCH] docs/extend: reformat notes Signed-off-by: Sebastiaan van Stijn --- docs/extend/index.md | 12 +++++++++--- docs/extend/plugins_authorization.md | 6 ++++-- docs/extend/plugins_metrics.md | 8 +++++--- docs/extend/plugins_volume.md | 8 +++++--- 4 files changed, 23 insertions(+), 11 deletions(-) diff --git a/docs/extend/index.md b/docs/extend/index.md index 4e8cae9855..bd0e9e1204 100644 --- a/docs/extend/index.md +++ b/docs/extend/index.md @@ -24,8 +24,9 @@ plugins using Docker Engine. For information about the legacy plugin system available in Docker Engine 1.12 and earlier, see [Understand legacy Docker Engine plugins](legacy_plugins.md). -> **Note**: Docker Engine managed plugins are currently not supported -on Windows daemons. +> **Note** +> +> Docker Engine managed plugins are currently not supported on Windows daemons. ## 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 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. diff --git a/docs/extend/plugins_authorization.md b/docs/extend/plugins_authorization.md index d7aa66cd80..d62c795862 100644 --- a/docs/extend/plugins_authorization.md +++ b/docs/extend/plugins_authorization.md @@ -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 [Plugin discovery](plugin_api.md#plugin-discovery) section. -**Note**: the abbreviations `AuthZ` and `AuthN` mean authorization and authentication -respectively. +> **Note** +> +> The abbreviations `AuthZ` and `AuthN` mean authorization and authentication +> respectively. ## Default user authorization mechanism diff --git a/docs/extend/plugins_metrics.md b/docs/extend/plugins_metrics.md index c29aeef932..c698a5a137 100644 --- a/docs/extend/plugins_metrics.md +++ b/docs/extend/plugins_metrics.md @@ -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 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 -of the metrics and metric labels is still considered experimental and may change -in a future version. +> **Note** +> +> 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 diff --git a/docs/extend/plugins_volume.md b/docs/extend/plugins_volume.md index b9a7139099..74abfd1bff 100644 --- a/docs/extend/plugins_volume.md +++ b/docs/extend/plugins_volume.md @@ -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 the volumes available by bind-mounting the provided paths into the containers. -> **Note**: 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. +> **Note** +> +> 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`