Skip to content

Commit ba50ab5

Browse files
gdevillelejohndmulhausen
gdevillele
authored and
johndmulhausen
committed
fix type of keywords entry in frontmatter (in /registry/) (docker#517)
keywords should be a string, not an array containing one string Signed-off-by: Gaetan de Villele <[email protected]>
1 parent 5ecd325 commit ba50ab5

33 files changed

+68
-101
lines changed

Diff for: ‎registry/compatibility.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: describes get by digest pitfall
3-
keywords:
4-
- registry, manifest, images, tags, repository, distribution, digest
3+
keywords: registry, manifest, images, tags, repository, distribution, digest
54
title: Registry compatibility
65
---
76

@@ -75,4 +74,4 @@ constraints of CAS.*
7574
For this reason if a manifest is pulled by _digest_ from a registry 2.3 with Docker
7675
Engine 1.9 and older, and the manifest was pushed with Docker Engine 1.10, a
7776
security check will cause the Engine to receive a manifest it cannot use and the
78-
pull will fail.
77+
pull will fail.

Diff for: ‎registry/configuration.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Explains how to configure a registry
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, configuration
3+
keywords: registry, on-prem, images, tags, repository, distribution, configuration
54
title: Registry configuration reference
65
---
76

@@ -1857,4 +1856,4 @@ The following example illustrates these values:
18571856

18581857
>**Note**: Cloudfront keys exist separately to other AWS keys. See
18591858
>[the documentation on AWS credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)
1860-
>for more information.
1859+
>for more information.

Diff for: ‎registry/deploying.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Explains how to deploy a registry
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, deployment
3+
keywords: registry, on-prem, images, tags, repository, distribution, deployment
54
title: Deploying a registry server
65
---
76

@@ -228,4 +227,4 @@ You will find more specific and advanced informations in the following sections:
228227
- [Advanced "recipes"](recipes/index.md)
229228
- [Registry API](spec/api.md)
230229
- [Storage driver model](storage-drivers/index.md)
231-
- [Token authentication](spec/auth/token.md)
230+
- [Token authentication](spec/auth/token.md)

Diff for: ‎registry/deprecated.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: describes deprecated functionality
3-
keywords:
4-
- registry, manifest, images, signatures, repository, distribution, digest
3+
keywords: registry, manifest, images, signatures, repository, distribution, digest
54
title: Docker Registry deprecation
65
---
76

@@ -18,4 +17,4 @@ not stored in the registry. This does not alter the functional behavior of
1817
the registry.
1918

2019
Old signatures blobs can be removed from the registry storage by running the
21-
garbage-collect subcommand.
20+
garbage-collect subcommand.

Diff for: ‎registry/garbage-collection.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: High level discussion of garbage collection
3-
keywords:
4-
- registry, garbage, images, tags, repository, distribution
3+
keywords: registry, garbage, images, tags, repository, distribution
54
title: Garbage collection
65
---
76

@@ -127,4 +126,4 @@ blob eligible for deletion: sha256:7e15ce58ccb2181a8fced7709e9893206f0937cc9543b
127126
blob eligible for deletion: sha256:87192bdbe00f8f2a62527f36bb4c7c7f4eaf9307e4b87e8334fb6abec1765bcb
128127
blob eligible for deletion: sha256:b549a9959a664038fc35c155a95742cf12297672ca0ae35735ec027d55bf4e97
129128
blob eligible for deletion: sha256:f251d679a7c61455f06d793e43c06786d7766c88b8c24edf242b2c08e3c3f599
130-
```
129+
```

Diff for: ‎registry/help.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Getting help with the Registry
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, help, 101, TL;DR
3+
keywords: registry, on-prem, images, tags, repository, distribution, help, 101, TL;DR
54
title: Get help
65
---
76

@@ -15,4 +14,4 @@ If you want to report a bug:
1514
- be sure to first read about [how to contribute](https://github.com/docker/distribution/blob/master/CONTRIBUTING.md)
1615
- you can then do so on the [GitHub project bugtracker](https://github.com/docker/distribution/issues)
1716

18-
You can also find out more about the Docker's project [Getting Help resources](/opensource/get-help.md).
17+
You can also find out more about the Docker's project [Getting Help resources](/opensource/get-help.md).

Diff for: ‎registry/index.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2+
description: High-level overview of the Registry
3+
keywords: registry, on-prem, images, tags, repository, distribution
24
redirect_from:
35
- /registry/overview/
4-
description: High-level overview of the Registry
5-
keywords:
6-
- registry, on-prem, images, tags, repository, distribution
76
title: Docker Registry
87
---
98

@@ -67,4 +66,4 @@ Now stop your registry and remove all data
6766

6867
You should now read the [detailed introduction about the
6968
registry](introduction.md), or jump directly to [deployment
70-
instructions](deploying.md).
69+
instructions](deploying.md).

Diff for: ‎registry/insecure.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Deploying a Registry in an insecure fashion
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, insecure
3+
keywords: registry, on-prem, images, tags, repository, distribution, insecure
54
title: Test an insecure registry
65
---
76

@@ -105,4 +104,4 @@ update-ca-trust
105104
$ update-ca-trust enable
106105
```
107106

108-
Now restart docker (`service docker stop && service docker start`, or any other way you use to restart docker).
107+
Now restart docker (`service docker stop && service docker start`, or any other way you use to restart docker).

Diff for: ‎registry/introduction.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Explains what the Registry is, basic use cases and requirements
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, use cases, requirements
3+
keywords: registry, on-prem, images, tags, repository, distribution, use cases, requirements
54
title: About Registry
65
---
76

@@ -73,4 +72,4 @@ golang are certainly useful as well for advanced operations or hacking.
7372

7473
## Next
7574

76-
Dive into [deploying your registry](deploying.md)
75+
Dive into [deploying your registry](deploying.md)

Diff for: ‎registry/notifications.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Explains how to work with registry notifications
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, notifications, advanced
3+
keywords: registry, on-prem, images, tags, repository, distribution, notifications, advanced
54
title: Work with notifications
65
---
76

@@ -341,4 +340,4 @@ provide acceptable guarantees, adding a transactional `Sink` to the registry
341340
is a possibility, although it may have an effect on request service time.
342341
Please see the
343342
[godoc](http://godoc.org/github.com/docker/distribution/notifications#Sink)
344-
for more information.
343+
for more information.

Diff for: ‎registry/recipes/apache.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Restricting access to your registry using an apache proxy
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, authentication, proxy, apache, httpd, TLS, recipe, advanced
3+
keywords: registry, on-prem, images, tags, repository, distribution, authentication, proxy, apache, httpd, TLS, recipe, advanced
54
title: Authenticate proxy with apache
65
---
76

@@ -207,4 +206,4 @@ Now, login with a "pull-only" user (using `testuser` and `testpassword`), then p
207206

208207
Verify that the "pull-only" can NOT push:
209208

210-
docker push myregistrydomain.com:5043/test
209+
docker push myregistrydomain.com:5043/test

Diff for: ‎registry/recipes/index.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Fun stuff to do with your registry
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, recipes, advanced
3+
keywords: registry, on-prem, images, tags, repository, distribution, recipes, advanced
54
title: Recipes Overview
65
---
76

@@ -28,4 +27,4 @@ At this point, it's assumed that:
2827
* [using Apache as an authenticating proxy](apache.md)
2928
* [using Nginx as an authenticating proxy](nginx.md)
3029
* [running a Registry on macOS](osx-setup-guide.md)
31-
* [mirror the Docker Hub](mirror.md)
30+
* [mirror the Docker Hub](mirror.md)

Diff for: ‎registry/recipes/mirror.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Setting-up a local mirror for Docker Hub images
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, mirror, Hub, recipe, advanced
3+
keywords: registry, on-prem, images, tags, repository, distribution, mirror, Hub, recipe, advanced
54
title: Registry as a pull through cache
65
---
76

@@ -94,4 +93,4 @@ For example, if your mirror is serving on `http://10.0.0.2:5000`, you would run:
9493

9594
> NOTE: Depending on your local host setup, you may be able to add the
9695
`--registry-mirror` option to the `DOCKER_OPTS` variable in
97-
`/etc/default/docker`.
96+
`/etc/default/docker`.

Diff for: ‎registry/recipes/nginx.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Restricting access to your registry using a nginx proxy
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, nginx, proxy, authentication, TLS, recipe, advanced
3+
keywords: registry, on-prem, images, tags, repository, distribution, nginx, proxy, authentication, TLS, recipe, advanced
54
title: Authenticate proxy with nginx
65
---
76

@@ -200,4 +199,4 @@ tag and push your first image:
200199
docker login -u=testuser -p=testpassword [email protected] myregistrydomain.com:5043
201200
docker tag ubuntu myregistrydomain.com:5043/test
202201
docker push myregistrydomain.com:5043/test
203-
docker pull myregistrydomain.com:5043/test
202+
docker pull myregistrydomain.com:5043/test

Diff for: ‎registry/recipes/osx-setup-guide.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Explains how to run a registry on macOS
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, macOS, recipe, advanced
3+
keywords: registry, on-prem, images, tags, repository, distribution, macOS, recipe, advanced
54
title: macOS Setup Guide
65
---
76

@@ -73,4 +72,4 @@ Start the Docker registry:
7372

7473
### Unloading the docker registry service
7574

76-
launchctl unload ~/Library/LaunchAgents/com.docker.registry.plist
75+
launchctl unload ~/Library/LaunchAgents/com.docker.registry.plist

Diff for: ‎registry/spec/api.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Specification for the Registry API.
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, api, advanced
3+
keywords: registry, on-prem, images, tags, repository, distribution, api, advanced
54
title: Docker Registry HTTP API V2
65
---
76

@@ -5476,4 +5475,4 @@ The following headers will be returned with the response:
54765475
|Name|Description|
54775476
|----|-----------|
54785477
|`Content-Length`|Length of the JSON response body.|
5479-
|`Link`|RFC5988 compliant rel='next' with URL to next result set, if available|
5478+
|`Link`|RFC5988 compliant rel='next' with URL to next result set, if available|

Diff for: ‎registry/spec/auth/index.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
22
description: Docker Registry v2 authentication schema
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, authentication, advanced
3+
keywords: registry, on-prem, images, tags, repository, distribution, authentication, advanced
54
title: Docker Registry v2 authentication
65
---
76

87
See the [Token Authentication Specification](token.md),
98
[Token Authentication Implementation](jwt.md),
109
[Token Scope Documentation](scope.md),
11-
[OAuth2 Token Authentication](oauth.md) for more information.
10+
[OAuth2 Token Authentication](oauth.md) for more information.

Diff for: ‎registry/spec/auth/jwt.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Describe the reference implementation of the Docker Registry v2 authentication schema
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, JWT authentication, advanced
3+
keywords: registry, on-prem, images, tags, repository, distribution, JWT authentication, advanced
54
title: Docker Registry v2 Bearer token specification
65
---
76

@@ -325,4 +324,4 @@ authorization then the registry will return the appropriate error.
325324
326325
At no point in this process should the registry need to call back to the
327326
authorization server. The registry only needs to be supplied with the trusted
328-
public keys to verify the token signatures.
327+
public keys to verify the token signatures.

Diff for: ‎registry/spec/auth/oauth.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Specifies the Docker Registry v2 authentication
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, oauth2, advanced
3+
keywords: registry, on-prem, images, tags, repository, distribution, oauth2, advanced
54
title: Docker Registry v2 authentication using OAuth2
65
---
76

@@ -181,4 +180,4 @@ HTTP/1.1 200 OK
181180
Content-Type: application/json
182181
183182
{"refresh_token":"kas9Da81Dfa8","access_token":"eyJhbGciOiJFUzI1NiIsInR5":"expires_in":900,"scope":"repository:samalba/my-app:pull,repository:samalba/my-app:push"}
184-
```
183+
```

Diff for: ‎registry/spec/auth/scope.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Describes the scope and access fields used for registry authorization tokens
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, advanced, access, scope
3+
keywords: registry, on-prem, images, tags, repository, distribution, advanced, access, scope
54
title: Docker Registry token scope and access
65
---
76

@@ -133,4 +132,4 @@ restricting scope to specific type, name, and actions combinations should be
133132
done by fetching an access token using the refresh token. Since the refresh
134133
token is not scoped to specific resources for an audience, extra care should
135134
be taken to only use the refresh token to negotiate new access tokens directly
136-
with the authorization server, and never with a resource provider.
135+
with the authorization server, and never with a resource provider.

Diff for: ‎registry/spec/auth/token.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: Specifies the Docker Registry v2 authentication
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, Bearer authentication, advanced
3+
keywords: registry, on-prem, images, tags, repository, distribution, Bearer authentication, advanced
54
title: Docker Registry v2 authentication via central service
65
---
76

@@ -248,4 +247,4 @@ Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiIsImtpZCI6IkJWM0Q6MkFWWj
248247
```
249248

250249
This is also described in [Section 2.1 of RFC 6750: The OAuth 2.0 Authorization
251-
Framework: Bearer Token Usage](https://tools.ietf.org/html/rfc6750#section-2.1)
250+
Framework: Bearer Token Usage](https://tools.ietf.org/html/rfc6750#section-2.1)

Diff for: ‎registry/spec/index.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
22
description: Explains registry JSON objects
3-
keywords:
4-
- registry, service, images, repository, json
3+
keywords: registry, service, images, repository, json
54
title: Docker Registry Reference
65
---
76

87
* [HTTP API V2](api.md)
98
* [Storage Driver](../storage-drivers/index.md)
109
* [Token Authentication Specification](auth/token.md)
11-
* [Token Authentication Implementation](auth/jwt.md)
10+
* [Token Authentication Implementation](auth/jwt.md)

Diff for: ‎registry/spec/json.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
description: Explains registry JSON objects
3+
keywords: registry, service, images, repository, json
34
published: false
4-
keywords:
5-
- registry, service, images, repository, json
65
title: Docker Distribution JSON canonicalization
76
---
87

@@ -84,4 +83,4 @@ var canonical bytes.Buffer
8483
if err := json.Indent(&canonical, incoming, "", ""); err != nil {
8584
// ... handle error
8685
}
87-
```
86+
```

Diff for: ‎registry/spec/manifest-v2-1.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
description: image manifest for the Registry.
3-
keywords:
4-
- registry, on-prem, images, tags, repository, distribution, api, advanced, manifest
3+
keywords: registry, on-prem, images, tags, repository, distribution, api, advanced, manifest
54
title: Image manifest V2, schema 1
65
---
76

@@ -159,4 +158,4 @@ by *libtrust*. A signature consists of the following fields:
159158
]
160159
}
161160
162-
```
161+
```

0 commit comments

Comments
 (0)