TrueCloudLab/distribution
13
0
Fork 3
Code Issues 2 Pull requests Projects Releases 2 Packages Wiki Activity Actions

Fix various links that were generating URLs with .md (#10548)

Browse source 
* 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 <github@gone.nl>

* engine/swarm: update links

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* 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 <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2020-04-01 13:05:50 +02:00 committed by GitHub
parent cb2a09fac2
commit 267e231de0
3 changed files with 19 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
docs/deploying.md
View file

@ -144,14 +144,13 @@ $ docker run -d \
### Customize the storage location ### Customize the storage location
By default, your registry data is persisted as a [docker By default, your registry data is persisted as a [docker volume](/storage/volumes.md)
volume](/engine/tutorials/dockervolumes.md) on the host filesystem. If you want on the host filesystem. If you want to store your registry contents at a specific
to store your registry contents at a specific location on your host filesystem, location on your host filesystem, such as if you have an SSD or SAN mounted into
such as if you have an SSD or SAN mounted into a particular directory, you might a particular directory, you might decide to use a bind mount instead. A bind mount
decide to use a bind mount instead. A bind mount is more dependent on the is more dependent on the filesystem layout of the Docker host, but more performant
filesystem layout of the Docker host, but more performant in many situations. in many situations. The following example bind-mounts the host directory
The following example bind-mounts the host directory `/mnt/registry` into the `/mnt/registry` into the registry container at `/var/lib/registry/`.
registry container at `/var/lib/registry/`.
```bash ```bash
$ docker run -d \ $ docker run -d \
@ -166,9 +165,9 @@ $ docker run -d \
By default, the registry stores its data on the local filesystem, whether you 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 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 bucket, Google Cloud Platform, or on another storage back-end by using
drivers](./storage-drivers/index.md). For more information, see [storage [storage drivers](./storage-drivers/index.md). For more information, see
configuration options](./configuration.md#storage). [storage configuration options](./configuration.md#storage).
## Run an externally-accessible registry ## 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 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 insecurely. Unless you have set up verification for your self-signed
certificate, this is for testing only. See [run an insecure certificate, this is for testing only. See [run an insecure registry](insecure.md).
registry](insecure.md).
## Run the registry as a service ## Run the registry as a service

5
docs/index.md
View file

@ -72,6 +72,5 @@ Now stop your registry and remove all data
## Next ## Next
You should now read the [detailed introduction about the You should now read the [detailed introduction about the registry](introduction.md),
registry](introduction.md), or jump directly to [deployment or jump directly to [deployment instructions](deploying.md).
instructions](deploying.md).

14
docs/introduction.md
View file

@ -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. posix filesystem, which is suitable for development or small deployments.
Additional cloud-based storage drivers like S3, Microsoft Azure, OpenStack Swift, Additional cloud-based storage drivers like S3, Microsoft Azure, OpenStack Swift,
and Aliyun OSS are also supported. People looking into using other storage and Aliyun OSS are also supported. People looking into using other storage
backends may do so by writing their own driver implementing the [Storage backends may do so by writing their own driver implementing the
API](storage-drivers/index.md). [Storage API](storage-drivers/index.md).
Since securing access to your hosted images is paramount, the Registry natively Since securing access to your hosted images is paramount, the Registry natively
supports TLS and basic authentication. 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 authentication and authorization methods. Only very large or public deployments
are expected to extend the Registry in this way. are expected to extend the Registry in this way.
Finally, the Registry ships with a robust [notification Finally, the Registry ships with a robust [notification system](notifications.md),
system](notifications.md), calling webhooks in response to activity, and both calling webhooks in response to activity, and both extensive logging and reporting,
extensive logging and reporting, mostly useful for large installations that want mostly useful for large installations that want to collect metrics.
to collect metrics.
## Understanding image naming ## 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` * `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 You can find out more about the various Docker commands dealing with images in
the [official Docker engine the [official Docker engine documentation](/engine/reference/commandline/cli.md).
documentation](/engine/reference/commandline/cli.md).
## Use cases ## Use cases