From 267e231de0a40da3b90bcabbb090938eb4e34bd7 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Wed, 1 Apr 2020 13:05:50 +0200 Subject: [PATCH] Fix various links that were generating URLs with `.md` (#10548) * Fix incorrect links in compose section there's a bug causing wrapped links to not work, and replacing some links to point to the .md file, so that IDE's can check if the anchors are valid. Also replaced some links to point to their new location. Signed-off-by: Sebastiaan van Stijn * engine/swarm: update links Signed-off-by: Sebastiaan van Stijn * Fix various broken links There's a bug in the "jekyll-relative-links" plugin that causes wrapped links to not work. Also replacing some links to point to the .md file, so that IDE's can check if the anchors are valid. Finally, replaced some links to point to their new locations, so that users don't get redirected.. Signed-off-by: Sebastiaan van Stijn --- docs/deploying.md | 24 +++++++++++------------- docs/index.md | 5 ++--- docs/introduction.md | 14 ++++++-------- 3 files changed, 19 insertions(+), 24 deletions(-) diff --git a/docs/deploying.md b/docs/deploying.md index ac66eae24..35f7468c0 100644 --- a/docs/deploying.md +++ b/docs/deploying.md @@ -144,14 +144,13 @@ $ docker run -d \ ### Customize the storage location -By default, your registry data is persisted as a [docker -volume](/engine/tutorials/dockervolumes.md) on the host filesystem. If you want -to store your registry contents at a specific location on your host filesystem, -such as if you have an SSD or SAN mounted into a particular directory, you might -decide to use a bind mount instead. A bind mount is more dependent on the -filesystem layout of the Docker host, but more performant in many situations. -The following example bind-mounts the host directory `/mnt/registry` into the -registry container at `/var/lib/registry/`. +By default, your registry data is persisted as a [docker volume](/storage/volumes.md) +on the host filesystem. If you want to store your registry contents at a specific +location on your host filesystem, such as if you have an SSD or SAN mounted into +a particular directory, you might decide to use a bind mount instead. A bind mount +is more dependent on the filesystem layout of the Docker host, but more performant +in many situations. The following example bind-mounts the host directory +`/mnt/registry` into the registry container at `/var/lib/registry/`. ```bash $ docker run -d \ @@ -166,9 +165,9 @@ $ docker run -d \ By default, the registry stores its data on the local filesystem, whether you use a bind mount or a volume. You can store the registry data in an Amazon S3 -bucket, Google Cloud Platform, or on another storage back-end by using [storage -drivers](./storage-drivers/index.md). For more information, see [storage -configuration options](./configuration.md#storage). +bucket, Google Cloud Platform, or on another storage back-end by using +[storage drivers](./storage-drivers/index.md). For more information, see +[storage configuration options](./configuration.md#storage). ## Run an externally-accessible registry @@ -259,8 +258,7 @@ and the relevant section of the It is possible to use a self-signed certificate, or to use our registry insecurely. Unless you have set up verification for your self-signed -certificate, this is for testing only. See [run an insecure -registry](insecure.md). +certificate, this is for testing only. See [run an insecure registry](insecure.md). ## Run the registry as a service diff --git a/docs/index.md b/docs/index.md index 8d4899095..4d6f09422 100644 --- a/docs/index.md +++ b/docs/index.md @@ -72,6 +72,5 @@ Now stop your registry and remove all data ## Next -You should now read the [detailed introduction about the -registry](introduction.md), or jump directly to [deployment -instructions](deploying.md). +You should now read the [detailed introduction about the registry](introduction.md), +or jump directly to [deployment instructions](deploying.md). diff --git a/docs/introduction.md b/docs/introduction.md index 63f78c02a..fb1932819 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -17,8 +17,8 @@ Storage itself is delegated to drivers. The default storage driver is the local posix filesystem, which is suitable for development or small deployments. Additional cloud-based storage drivers like S3, Microsoft Azure, OpenStack Swift, and Aliyun OSS are also supported. People looking into using other storage -backends may do so by writing their own driver implementing the [Storage -API](storage-drivers/index.md). +backends may do so by writing their own driver implementing the +[Storage API](storage-drivers/index.md). Since securing access to your hosted images is paramount, the Registry natively supports TLS and basic authentication. @@ -27,10 +27,9 @@ The Registry GitHub repository includes additional information about advanced authentication and authorization methods. Only very large or public deployments are expected to extend the Registry in this way. -Finally, the Registry ships with a robust [notification -system](notifications.md), calling webhooks in response to activity, and both -extensive logging and reporting, mostly useful for large installations that want -to collect metrics. +Finally, the Registry ships with a robust [notification system](notifications.md), +calling webhooks in response to activity, and both extensive logging and reporting, +mostly useful for large installations that want to collect metrics. ## Understanding image naming @@ -40,8 +39,7 @@ Image names as used in typical docker commands reflect their origin: * `docker pull myregistrydomain:port/foo/bar` instructs docker to contact the registry located at `myregistrydomain:port` to find the image `foo/bar` You can find out more about the various Docker commands dealing with images in -the [official Docker engine -documentation](/engine/reference/commandline/cli.md). +the [official Docker engine documentation](/engine/reference/commandline/cli.md). ## Use cases