From abd2d765ac754ae8e17c07e2b13380f06b539218 Mon Sep 17 00:00:00 2001 From: Misty Stanley-Jones Date: Thu, 10 Nov 2016 15:37:21 -0800 Subject: [PATCH] Metadata and formatting fixes needed for Jekyll build Signed-off-by: Misty Stanley-Jones (cherry picked from commit 49d6706ce9d952718725350d82d9ea7deb4f7326) Signed-off-by: Misty Stanley-Jones --- docs/configuration.md | 6 ++---- docs/spec/api.md | 11 ++--------- docs/spec/api.md.tmpl | 6 ++---- docs/spec/auth/index.md | 6 ++---- docs/spec/auth/jwt.md | 6 ++---- docs/spec/auth/oauth.md | 6 ++---- docs/spec/auth/scope.md | 6 ++---- docs/spec/auth/token.md | 6 ++---- docs/spec/implementations.md | 4 +--- docs/spec/index.md | 6 ++---- docs/spec/json.md | 6 +----- docs/spec/manifest-v2-1.md | 4 +--- docs/spec/manifest-v2-2.md | 4 +--- docs/spec/menu.md | 7 ------- 14 files changed, 22 insertions(+), 62 deletions(-) delete mode 100644 docs/spec/menu.md diff --git a/docs/configuration.md b/docs/configuration.md index e2821d4d8..f8d05f021 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,11 +1,9 @@ --- -title: "Configuring a registry" +title: "Registry Configuration Reference" description: "Explains how to configure a registry" -keywords: ["registry, on-prem, images, tags, repository, distribution, configuration"] +keywords: "registry, on-prem, images, tags, repository, distribution, configuration" --- -# Registry Configuration Reference - The Registry configuration is based on a YAML file, detailed below. While it comes with sane default values out of the box, you are heavily encouraged to review it exhaustively before moving your systems to production. ## Override specific configuration options diff --git a/docs/spec/api.md b/docs/spec/api.md index 5b61a29ed..70d8d0fb4 100644 --- a/docs/spec/api.md +++ b/docs/spec/api.md @@ -1,11 +1,9 @@ --- -title: "HTTP API V2" +title: "Docker Registry HTTP API V2" description: "Specification for the Registry API." -keywords: ["registry, on-prem, images, tags, repository, distribution, api, advanced"] +keywords: "registry, on-prem, images, tags, repository, distribution, api, advanced" --- -# Docker Registry HTTP API V2 - ## Introduction The _Docker Registry HTTP API_ is the protocol to facilitate distribution of @@ -4842,8 +4840,3 @@ The following headers will be returned with the response: |----|-----------| |`Content-Length`|Length of the JSON response body.| |`Link`|RFC5988 compliant rel='next' with URL to next result set, if available| - - - - - diff --git a/docs/spec/api.md.tmpl b/docs/spec/api.md.tmpl index a429642e5..28edc37fc 100644 --- a/docs/spec/api.md.tmpl +++ b/docs/spec/api.md.tmpl @@ -1,11 +1,9 @@ --- -title: "HTTP API V2" +title: "Docker Registry HTTP API V2" description: "Specification for the Registry API." -keywords: ["registry, on-prem, images, tags, repository, distribution, api, advanced"] +keywords: "registry, on-prem, images, tags, repository, distribution, api, advanced" --- -# Docker Registry HTTP API V2 - ## Introduction The _Docker Registry HTTP API_ is the protocol to facilitate distribution of diff --git a/docs/spec/auth/index.md b/docs/spec/auth/index.md index d1aa94225..bb7490603 100644 --- a/docs/spec/auth/index.md +++ b/docs/spec/auth/index.md @@ -1,11 +1,9 @@ --- -title: "Docker Registry Token Authentication" +title: "Docker Registry v2 authentication" description: "Docker Registry v2 authentication schema" -keywords: ["registry, on-prem, images, tags, repository, distribution, authentication, advanced"] +keywords: "registry, on-prem, images, tags, repository, distribution, authentication, advanced" --- -# Docker Registry v2 authentication - See the [Token Authentication Specification](token.md), [Token Authentication Implementation](jwt.md), [Token Scope Documentation](scope.md), diff --git a/docs/spec/auth/jwt.md b/docs/spec/auth/jwt.md index aa9941b0b..856082820 100644 --- a/docs/spec/auth/jwt.md +++ b/docs/spec/auth/jwt.md @@ -1,11 +1,9 @@ --- -title: "Token Authentication Implementation" +title: "Docker Registry v2 Bearer token specification" description: "Describe the reference implementation of the Docker Registry v2 authentication schema" -keywords: ["registry, on-prem, images, tags, repository, distribution, JWT authentication, advanced"] +keywords: "registry, on-prem, images, tags, repository, distribution, JWT authentication, advanced" --- -# Docker Registry v2 Bearer token specification - This specification covers the `docker/distribution` implementation of the v2 Registry's authentication schema. Specifically, it describes the JSON Web Token schema that `docker/distribution` has adopted to implement the diff --git a/docs/spec/auth/oauth.md b/docs/spec/auth/oauth.md index 8b1571792..f023a30f4 100644 --- a/docs/spec/auth/oauth.md +++ b/docs/spec/auth/oauth.md @@ -1,11 +1,9 @@ --- -title: "Oauth2 Token Authentication" +title: "Docker Registry v2 authentication using OAuth2" description: "Specifies the Docker Registry v2 authentication" -keywords: ["registry, on-prem, images, tags, repository, distribution, oauth2, advanced"] +keywords: "registry, on-prem, images, tags, repository, distribution, oauth2, advanced" --- -# Docker Registry v2 authentication using OAuth2 - This document describes support for the OAuth2 protocol within the authorization server. [RFC6749](https://tools.ietf.org/html/rfc6749) should be used as a reference for the protocol and HTTP endpoints described here. diff --git a/docs/spec/auth/scope.md b/docs/spec/auth/scope.md index eecb8f6f1..3e58212e0 100644 --- a/docs/spec/auth/scope.md +++ b/docs/spec/auth/scope.md @@ -1,11 +1,9 @@ --- -title: "Token Scope Documentation" +title: "Docker Registry Token Scope and Access" description: "Describes the scope and access fields used for registry authorization tokens" -keywords: ["registry, on-prem, images, tags, repository, distribution, advanced, access, scope"] +keywords: "registry, on-prem, images, tags, repository, distribution, advanced, access, scope" --- -# Docker Registry Token Scope and Access - Tokens used by the registry are always restricted what resources they may be used to access, where those resources may be accessed, and what actions may be done on those resources. Tokens always have the context of a user which diff --git a/docs/spec/auth/token.md b/docs/spec/auth/token.md index 41bcb00dc..9c89ae07c 100644 --- a/docs/spec/auth/token.md +++ b/docs/spec/auth/token.md @@ -1,11 +1,9 @@ --- -title: "Token Authentication Specification" +title: "Docker Registry v2 authentication via central service" description: "Specifies the Docker Registry v2 authentication" -keywords: ["registry, on-prem, images, tags, repository, distribution, Bearer authentication, advanced"] +keywords: "registry, on-prem, images, tags, repository, distribution, Bearer authentication, advanced" --- -# Docker Registry v2 authentication via central service - This document outlines the v2 Docker registry authentication scheme: ![v2 registry auth](https://docs.google.com/drawings/d/1EHZU9uBLmcH0kytDClBv6jv6WR4xZjE8RKEUw1mARJA/pub?w=480&h=360) diff --git a/docs/spec/implementations.md b/docs/spec/implementations.md index 347465350..b78807a16 100644 --- a/docs/spec/implementations.md +++ b/docs/spec/implementations.md @@ -1,9 +1,8 @@ --- published: false +title: Distribution API Implementations --- -# Distribution API Implementations - This is a list of known implementations of the Distribution API spec. ## [Docker Distribution Registry](https://github.com/docker/distribution) @@ -27,4 +26,3 @@ _Known Issues_ - No resumable push support - No PATCH implementation for blob upload - Content ranges ignored - diff --git a/docs/spec/index.md b/docs/spec/index.md index 952ebabd2..853debc9e 100644 --- a/docs/spec/index.md +++ b/docs/spec/index.md @@ -1,11 +1,9 @@ --- -title: "Reference Overview" +title: "Docker Registry Reference" description: "Explains registry JSON objects" -keywords: ["registry, service, images, repository, json"] +keywords: "registry, service, images, repository, json" --- -# Docker Registry Reference - * [HTTP API V2](api.md) * [Storage Driver](../storage-drivers/index.md) * [Token Authentication Specification](auth/token.md) diff --git a/docs/spec/json.md b/docs/spec/json.md index 825b17ac2..b646a4e7a 100644 --- a/docs/spec/json.md +++ b/docs/spec/json.md @@ -2,13 +2,9 @@ published: false title: "Docker Distribution JSON Canonicalization" description: "Explains registry JSON objects" -keywords: ["registry, service, images, repository, json"] +keywords: "registry, service, images, repository, json" --- - - -# Docker Distribution JSON Canonicalization - To provide consistent content hashing of JSON objects throughout Docker Distribution APIs, the specification defines a canonical JSON format. Adopting such a canonicalization also aids in caching JSON responses. diff --git a/docs/spec/manifest-v2-1.md b/docs/spec/manifest-v2-1.md index b06c2f2a9..925251aa5 100644 --- a/docs/spec/manifest-v2-1.md +++ b/docs/spec/manifest-v2-1.md @@ -1,11 +1,9 @@ --- title: "Image Manifest V 2, Schema 1 " description: "image manifest for the Registry." -keywords: ["registry, on-prem, images, tags, repository, distribution, api, advanced, manifest"] +keywords: "registry, on-prem, images, tags, repository, distribution, api, advanced, manifest" --- -# Image Manifest Version 2, Schema 1 - This document outlines the format of of the V2 image manifest. The image manifest described herein was introduced in the Docker daemon in the [v1.3.0 release](https://github.com/docker/docker/commit/9f482a66ab37ec396ac61ed0c00d59122ac07453). diff --git a/docs/spec/manifest-v2-2.md b/docs/spec/manifest-v2-2.md index 1db8b33ba..f2a2ce73f 100644 --- a/docs/spec/manifest-v2-2.md +++ b/docs/spec/manifest-v2-2.md @@ -1,11 +1,9 @@ --- title: "Image Manifest V 2, Schema 2 " description: "image manifest for the Registry." -keywords: ["registry, on-prem, images, tags, repository, distribution, api, advanced, manifest"] +keywords: "registry, on-prem, images, tags, repository, distribution, api, advanced, manifest" --- -# Image Manifest Version 2, Schema 2 - This document outlines the format of of the V2 image manifest, schema version 2. The original (and provisional) image manifest for V2 (schema 1), was introduced in the Docker daemon in the [v1.3.0 diff --git a/docs/spec/menu.md b/docs/spec/menu.md deleted file mode 100644 index 9237e3ce8..000000000 --- a/docs/spec/menu.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Reference" -description: "Explains registry JSON objects" -keywords: ["registry, service, images, repository, json"] -type: "menu" -identifier: "smn_registry_ref" ----