From 3d14741648eca978ea99528159e1390d911bd22c Mon Sep 17 00:00:00 2001 From: Gaetan Date: Fri, 4 Nov 2016 10:48:38 -0700 Subject: [PATCH] fix more frontmatter keywords values (#439) * fix format of frontmatter keyword entry in some .md files Signed-off-by: Gaetan de Villele --- docs/compatibility.md | 5 ++--- docs/deploying.md | 5 ++--- docs/deprecated.md | 5 ++--- docs/garbage-collection.md | 6 ++---- docs/help.md | 5 ++--- docs/index.md | 5 ++--- docs/insecure.md | 5 ++--- docs/introduction.md | 5 ++--- docs/notifications.md | 6 +++--- docs/recipes/apache.md | 7 +++---- docs/recipes/index.md | 5 ++--- docs/recipes/mirror.md | 7 +++---- docs/recipes/nginx.md | 7 +++---- docs/recipes/osx-setup-guide.md | 6 +++--- docs/storage-drivers/azure.md | 5 ++--- docs/storage-drivers/filesystem.md | 5 ++--- docs/storage-drivers/gcs.md | 5 ++--- docs/storage-drivers/index.md | 6 +++--- docs/storage-drivers/inmemory.md | 5 ++--- docs/storage-drivers/oss.md | 5 ++--- docs/storage-drivers/s3.md | 5 ++--- docs/storage-drivers/swift.md | 5 ++--- 22 files changed, 50 insertions(+), 70 deletions(-) diff --git a/docs/compatibility.md b/docs/compatibility.md index 6d18ffc35..71ee230da 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -1,7 +1,6 @@ --- description: describes get by digest pitfall -keywords: -- registry, manifest, images, tags, repository, distribution, digest +keywords: registry, manifest, images, tags, repository, distribution, digest menu: main: parent: smn_registry_ref @@ -81,4 +80,4 @@ constraints of CAS.* For this reason if a manifest is pulled by _digest_ from a registry 2.3 with Docker Engine 1.9 and older, and the manifest was pushed with Docker Engine 1.10, a security check will cause the Engine to receive a manifest it cannot use and the -pull will fail. +pull will fail. \ No newline at end of file diff --git a/docs/deploying.md b/docs/deploying.md index 1aa42aa0a..de3470554 100644 --- a/docs/deploying.md +++ b/docs/deploying.md @@ -1,7 +1,6 @@ --- description: Explains how to deploy a registry -keywords: -- registry, on-prem, images, tags, repository, distribution, deployment +keywords: registry, on-prem, images, tags, repository, distribution, deployment menu: main: parent: smn_registry @@ -234,4 +233,4 @@ You will find more specific and advanced informations in the following sections: - [Advanced "recipes"](recipes/index.md) - [Registry API](spec/api.md) - [Storage driver model](storage-drivers/index.md) - - [Token authentication](spec/auth/token.md) + - [Token authentication](spec/auth/token.md) \ No newline at end of file diff --git a/docs/deprecated.md b/docs/deprecated.md index d30ff4254..dd4f9762e 100644 --- a/docs/deprecated.md +++ b/docs/deprecated.md @@ -1,7 +1,6 @@ --- description: describes deprecated functionality -keywords: -- registry, manifest, images, signatures, repository, distribution, digest +keywords: registry, manifest, images, signatures, repository, distribution, digest menu: main: parent: smn_registry_ref @@ -24,4 +23,4 @@ not stored in the registry. This does not alter the functional behavior of the registry. Old signatures blobs can be removed from the registry storage by running the -garbage-collect subcommand. +garbage-collect subcommand. \ No newline at end of file diff --git a/docs/garbage-collection.md b/docs/garbage-collection.md index d24bb77ce..1352b5279 100644 --- a/docs/garbage-collection.md +++ b/docs/garbage-collection.md @@ -1,7 +1,6 @@ --- description: High level discussion of garbage collection -keywords: -- registry, garbage, images, tags, repository, distribution +keywords: registry, garbage, images, tags, repository, distribution menu: main: parent: smn_registry_ref @@ -133,5 +132,4 @@ blob eligible for deletion: sha256:7e15ce58ccb2181a8fced7709e9893206f0937cc9543b blob eligible for deletion: sha256:87192bdbe00f8f2a62527f36bb4c7c7f4eaf9307e4b87e8334fb6abec1765bcb blob eligible for deletion: sha256:b549a9959a664038fc35c155a95742cf12297672ca0ae35735ec027d55bf4e97 blob eligible for deletion: sha256:f251d679a7c61455f06d793e43c06786d7766c88b8c24edf242b2c08e3c3f599 -``` - +``` \ No newline at end of file diff --git a/docs/help.md b/docs/help.md index 8728924c1..40615b275 100644 --- a/docs/help.md +++ b/docs/help.md @@ -1,7 +1,6 @@ --- description: Getting help with the Registry -keywords: -- registry, on-prem, images, tags, repository, distribution, help, 101, TL;DR +keywords: registry, on-prem, images, tags, repository, distribution, help, 101, TL;DR menu: main: parent: smn_registry @@ -21,4 +20,4 @@ If you want to report a bug: - be sure to first read about [how to contribute](https://github.com/docker/distribution/blob/master/CONTRIBUTING.md) - you can then do so on the [GitHub project bugtracker](https://github.com/docker/distribution/issues) -You can also find out more about the Docker's project [Getting Help resources](/opensource/get-help.md). +You can also find out more about the Docker's project [Getting Help resources](/opensource/get-help.md). \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 0a57a2d3b..269ab74f4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,8 +2,7 @@ aliases: - /registry/overview/ description: High-level overview of the Registry -keywords: -- registry, on-prem, images, tags, repository, distribution +keywords: registry, on-prem, images, tags, repository, distribution menu: main: parent: smn_registry @@ -65,4 +64,4 @@ 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). \ No newline at end of file diff --git a/docs/insecure.md b/docs/insecure.md index 0bb214589..01385ef65 100644 --- a/docs/insecure.md +++ b/docs/insecure.md @@ -1,7 +1,6 @@ --- description: Deploying a Registry in an insecure fashion -keywords: -- registry, on-prem, images, tags, repository, distribution, insecure +keywords: registry, on-prem, images, tags, repository, distribution, insecure menu: main: parent: smn_registry_ref @@ -111,4 +110,4 @@ update-ca-trust $ update-ca-trust enable ``` -Now restart docker (`service docker stop && service docker start`, or any other way you use to restart docker). +Now restart docker (`service docker stop && service docker start`, or any other way you use to restart docker). \ No newline at end of file diff --git a/docs/introduction.md b/docs/introduction.md index f95be8199..d1a572b96 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,7 +1,6 @@ --- description: Explains what the Registry is, basic use cases and requirements -keywords: -- registry, on-prem, images, tags, repository, distribution, use cases, requirements +keywords: registry, on-prem, images, tags, repository, distribution, use cases, requirements menu: main: parent: smn_registry @@ -52,4 +51,4 @@ Also, while just starting a registry is fairly easy, operating it in a productio ## Next -Dive into [deploying your registry](deploying.md) +Dive into [deploying your registry](deploying.md) \ No newline at end of file diff --git a/docs/notifications.md b/docs/notifications.md index dd01a5b86..a4a5f51bc 100644 --- a/docs/notifications.md +++ b/docs/notifications.md @@ -1,7 +1,7 @@ --- description: Explains how to work with registry notifications -keywords: -- registry, on-prem, images, tags, repository, distribution, notifications, advanced +keywords: registry, on-prem, images, tags, repository, distribution, notifications, + advanced menu: main: parent: smn_registry @@ -347,4 +347,4 @@ provide acceptable guarantees, adding a transactional `Sink` to the registry is a possibility, although it may have an effect on request service time. Please see the [godoc](http://godoc.org/github.com/docker/distribution/notifications#Sink) -for more information. +for more information. \ No newline at end of file diff --git a/docs/recipes/apache.md b/docs/recipes/apache.md index 1b5035841..318470d70 100644 --- a/docs/recipes/apache.md +++ b/docs/recipes/apache.md @@ -1,8 +1,7 @@ --- description: Restricting access to your registry using an apache proxy -keywords: -- registry, on-prem, images, tags, repository, distribution, authentication, proxy, - apache, httpd, TLS, recipe, advanced +keywords: registry, on-prem, images, tags, repository, distribution, authentication, + proxy, apache, httpd, TLS, recipe, advanced menu: main: parent: smn_recipes @@ -213,4 +212,4 @@ Now, login with a "pull-only" user (using `testuser` and `testpassword`), then p Verify that the "pull-only" can NOT push: - docker push myregistrydomain.com:5043/test + docker push myregistrydomain.com:5043/test \ No newline at end of file diff --git a/docs/recipes/index.md b/docs/recipes/index.md index 482a48943..948f1bb40 100644 --- a/docs/recipes/index.md +++ b/docs/recipes/index.md @@ -1,7 +1,6 @@ --- description: Fun stuff to do with your registry -keywords: -- registry, on-prem, images, tags, repository, distribution, recipes, advanced +keywords: registry, on-prem, images, tags, repository, distribution, recipes, advanced menu: main: parent: smn_recipes @@ -34,4 +33,4 @@ At this point, it's assumed that: * [using Apache as an authenticating proxy](apache.md) * [using Nginx as an authenticating proxy](nginx.md) * [running a Registry on macOS](osx-setup-guide.md) - * [mirror the Docker Hub](mirror.md) + * [mirror the Docker Hub](mirror.md) \ No newline at end of file diff --git a/docs/recipes/mirror.md b/docs/recipes/mirror.md index 6e66f73a0..8d94c2f32 100644 --- a/docs/recipes/mirror.md +++ b/docs/recipes/mirror.md @@ -1,8 +1,7 @@ --- description: Setting-up a local mirror for Docker Hub images -keywords: -- registry, on-prem, images, tags, repository, distribution, mirror, Hub, recipe, - advanced +keywords: registry, on-prem, images, tags, repository, distribution, mirror, Hub, + recipe, advanced menu: main: parent: smn_recipes @@ -74,4 +73,4 @@ For example, if your mirror is serving on `http://10.0.0.2:5000`, you would run: docker --registry-mirror=https://10.0.0.2:5000 daemon -NOTE: Depending on your local host setup, you may be able to add the `--registry-mirror` option to the `DOCKER_OPTS` variable in `/etc/default/docker`. +NOTE: Depending on your local host setup, you may be able to add the `--registry-mirror` option to the `DOCKER_OPTS` variable in `/etc/default/docker`. \ No newline at end of file diff --git a/docs/recipes/nginx.md b/docs/recipes/nginx.md index 94fca625c..d0e97f4f6 100644 --- a/docs/recipes/nginx.md +++ b/docs/recipes/nginx.md @@ -1,8 +1,7 @@ --- description: Restricting access to your registry using a nginx proxy -keywords: -- registry, on-prem, images, tags, repository, distribution, nginx, proxy, authentication, - TLS, recipe, advanced +keywords: registry, on-prem, images, tags, repository, distribution, nginx, proxy, + authentication, TLS, recipe, advanced menu: main: parent: smn_recipes @@ -188,4 +187,4 @@ Login with a "push" authorized user (using `testuser` and `testpassword`), then docker login -u=testuser -p=testpassword -e=root@example.ch myregistrydomain.com:5043 docker tag ubuntu myregistrydomain.com:5043/test docker push myregistrydomain.com:5043/test - docker pull myregistrydomain.com:5043/test + docker pull myregistrydomain.com:5043/test \ No newline at end of file diff --git a/docs/recipes/osx-setup-guide.md b/docs/recipes/osx-setup-guide.md index f926f8c9e..03a5fa3a0 100644 --- a/docs/recipes/osx-setup-guide.md +++ b/docs/recipes/osx-setup-guide.md @@ -1,7 +1,7 @@ --- description: Explains how to run a registry on macOS -keywords: -- registry, on-prem, images, tags, repository, distribution, macOS, recipe, advanced +keywords: registry, on-prem, images, tags, repository, distribution, macOS, recipe, + advanced menu: main: parent: smn_recipes @@ -78,4 +78,4 @@ Start the Docker registry: ### Unloading the docker registry service - launchctl unload ~/Library/LaunchAgents/com.docker.registry.plist + launchctl unload ~/Library/LaunchAgents/com.docker.registry.plist \ No newline at end of file diff --git a/docs/storage-drivers/azure.md b/docs/storage-drivers/azure.md index 64e476e42..08d5b00ef 100644 --- a/docs/storage-drivers/azure.md +++ b/docs/storage-drivers/azure.md @@ -1,7 +1,6 @@ --- description: Explains how to use the Azure storage drivers -keywords: -- registry, service, driver, images, storage, azure +keywords: registry, service, driver, images, storage, azure menu: main: parent: smn_storagedrivers @@ -74,4 +73,4 @@ An implementation of the `storagedriver.StorageDriver` interface which uses [Mic * To get information about [azure-blob-storage](http://azure.microsoft.com/en-us/services/storage/) visit the Microsoft website. -* You can use Microsoft's [Blob Service REST API](https://msdn.microsoft.com/en-us/library/azure/dd135733.aspx) to [create a container] (https://msdn.microsoft.com/en-us/library/azure/dd179468.aspx). +* You can use Microsoft's [Blob Service REST API](https://msdn.microsoft.com/en-us/library/azure/dd135733.aspx) to [create a container] (https://msdn.microsoft.com/en-us/library/azure/dd179468.aspx). \ No newline at end of file diff --git a/docs/storage-drivers/filesystem.md b/docs/storage-drivers/filesystem.md index 2c7f6628e..5c7e0e60b 100644 --- a/docs/storage-drivers/filesystem.md +++ b/docs/storage-drivers/filesystem.md @@ -1,7 +1,6 @@ --- description: Explains how to use the filesystem storage drivers -keywords: -- registry, service, driver, images, storage, filesystem +keywords: registry, service, driver, images, storage, filesystem menu: main: parent: smn_storagedrivers @@ -20,4 +19,4 @@ there is adequate space available. Defaults to `/var/lib/registry`. `maxthreads`: (optional) The maximum number of simultaneous blocking filesystem operations permitted within the registry. Each operation spawns a new thread and may cause thread exhaustion issues if many are done in parallel. Defaults to -`100`, and can be no lower than `25`. +`100`, and can be no lower than `25`. \ No newline at end of file diff --git a/docs/storage-drivers/gcs.md b/docs/storage-drivers/gcs.md index 4c8a7c88c..8787b620c 100644 --- a/docs/storage-drivers/gcs.md +++ b/docs/storage-drivers/gcs.md @@ -1,7 +1,6 @@ --- description: Explains how to use the Google Cloud Storage drivers -keywords: -- registry, service, driver, images, storage, gcs, google, cloud +keywords: registry, service, driver, images, storage, gcs, google, cloud menu: main: parent: smn_storagedrivers @@ -74,4 +73,4 @@ An implementation of the `storagedriver.StorageDriver` interface which uses Goog **Note** Instead of a key file you can use [Google Application Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials). -`rootdirectory`: (optional) The root directory tree in which all registry files will be stored. Defaults to the empty string (bucket root). +`rootdirectory`: (optional) The root directory tree in which all registry files will be stored. Defaults to the empty string (bucket root). \ No newline at end of file diff --git a/docs/storage-drivers/index.md b/docs/storage-drivers/index.md index 1c9fbe9da..d42d7b089 100644 --- a/docs/storage-drivers/index.md +++ b/docs/storage-drivers/index.md @@ -2,8 +2,8 @@ aliases: - /registry/storagedrivers/ description: Explains how to use storage drivers -keywords: -- registry, on-prem, images, tags, repository, distribution, storage drivers, advanced +keywords: registry, on-prem, images, tags, repository, distribution, storage drivers, + advanced menu: main: identifier: storage_index @@ -63,4 +63,4 @@ Storage drivers should call `factory.Register` with their driver name in an `ini Storage driver test suites are provided in `storagedriver/testsuites/testsuites.go` and may be used for any storage driver written in Go. Tests can be registered using the `RegisterSuite` -function, which run the same set of tests for any registered drivers. +function, which run the same set of tests for any registered drivers. \ No newline at end of file diff --git a/docs/storage-drivers/inmemory.md b/docs/storage-drivers/inmemory.md index 6fbed6aaf..d658bcd5d 100644 --- a/docs/storage-drivers/inmemory.md +++ b/docs/storage-drivers/inmemory.md @@ -1,7 +1,6 @@ --- description: Explains how to use the in-memory storage drivers -keywords: -- registry, service, driver, images, storage, in-memory +keywords: registry, service, driver, images, storage, in-memory menu: main: parent: smn_storagedrivers @@ -19,4 +18,4 @@ volatile memory, use the [`filesystem` driver](filesystem.md) on a ramdisk. ## Parameters -None +None \ No newline at end of file diff --git a/docs/storage-drivers/oss.md b/docs/storage-drivers/oss.md index 441090030..f291af79c 100644 --- a/docs/storage-drivers/oss.md +++ b/docs/storage-drivers/oss.md @@ -1,7 +1,6 @@ --- description: Explains how to use the Aliyun OSS storage driver -keywords: -- registry, service, driver, images, storage, OSS, aliyun +keywords: registry, service, driver, images, storage, OSS, aliyun menu: main: parent: smn_storagedrivers @@ -123,4 +122,4 @@ no The root directory tree in which to store all registry files. Defaults to an empty string (bucket root). - + \ No newline at end of file diff --git a/docs/storage-drivers/s3.md b/docs/storage-drivers/s3.md index cf7294902..30941cf91 100644 --- a/docs/storage-drivers/s3.md +++ b/docs/storage-drivers/s3.md @@ -1,7 +1,6 @@ --- description: Explains how to use the S3 storage drivers -keywords: -- registry, service, driver, images, storage, S3 +keywords: registry, service, driver, images, storage, S3 menu: main: parent: smn_storagedrivers @@ -265,4 +264,4 @@ middleware: ## CloudFront Key-Pair -A CloudFront key-pair is required for all AWS accounts needing access to your CloudFront distribution. For information, please see [Creating CloudFront Key Pairs](http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-trusted-signers.html#private-content-creating-cloudfront-key-pairs). +A CloudFront key-pair is required for all AWS accounts needing access to your CloudFront distribution. For information, please see [Creating CloudFront Key Pairs](http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-trusted-signers.html#private-content-creating-cloudfront-key-pairs). \ No newline at end of file diff --git a/docs/storage-drivers/swift.md b/docs/storage-drivers/swift.md index eaa805112..454f2acb4 100644 --- a/docs/storage-drivers/swift.md +++ b/docs/storage-drivers/swift.md @@ -1,7 +1,6 @@ --- description: Explains how to use the OpenStack swift storage driver -keywords: -- registry, service, driver, images, storage, swift +keywords: registry, service, driver, images, storage, swift menu: main: parent: smn_storagedrivers @@ -242,4 +241,4 @@ disabled that feature, the configuration file can specify the following optional

- + \ No newline at end of file