From 6b3ccf964053c6130a4dbfc53f03501d608f4b0e Mon Sep 17 00:00:00 2001 From: Misty Stanley-Jones Date: Fri, 14 Oct 2016 15:40:45 -0700 Subject: [PATCH] Convert Markdown frontmatter to YAML Some frontmatter such as the weights, menu stuff, etc is no longer used 'draft=true' becomes 'published: false' Signed-off-by: Misty Stanley-Jones (cherry picked from commit f180e9a9349040229a5a72b5867e098600cf9b55) Signed-off-by: Misty Stanley-Jones (cherry picked from commit c5a8e74c562cd62db83df69ec71d9cee3e346317) Signed-off-by: Misty Stanley-Jones --- docs/configuration.md | 15 +++++---------- docs/spec/api.md | 14 +++++--------- docs/spec/api.md.tmpl | 14 +++++--------- docs/spec/auth/index.md | 15 +++++---------- docs/spec/auth/jwt.md | 15 +++++---------- docs/spec/auth/oauth.md | 16 +++++----------- docs/spec/auth/scope.md | 16 +++++----------- docs/spec/auth/token.md | 19 +++++++------------ docs/spec/implementations.md | 8 +++----- docs/spec/index.md | 15 +++++---------- docs/spec/json.md | 16 ++++++---------- docs/spec/manifest-v2-1.md | 14 +++++--------- docs/spec/manifest-v2-2.md | 14 +++++--------- docs/spec/menu.md | 20 +++++++------------- 14 files changed, 73 insertions(+), 138 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 1ef680f56..e2821d4d8 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,13 +1,8 @@ - +--- +title: "Configuring a registry" +description: "Explains how to configure a registry" +keywords: ["registry, on-prem, images, tags, repository, distribution, configuration"] +--- # Registry Configuration Reference diff --git a/docs/spec/api.md b/docs/spec/api.md index 390411461..5b61a29ed 100644 --- a/docs/spec/api.md +++ b/docs/spec/api.md @@ -1,12 +1,8 @@ - +--- +title: "HTTP API V2" +description: "Specification for the Registry API." +keywords: ["registry, on-prem, images, tags, repository, distribution, api, advanced"] +--- # Docker Registry HTTP API V2 diff --git a/docs/spec/api.md.tmpl b/docs/spec/api.md.tmpl index 13a1fc2ed..a429642e5 100644 --- a/docs/spec/api.md.tmpl +++ b/docs/spec/api.md.tmpl @@ -1,12 +1,8 @@ - +--- +title: "HTTP API V2" +description: "Specification for the Registry API." +keywords: ["registry, on-prem, images, tags, repository, distribution, api, advanced"] +--- # Docker Registry HTTP API V2 diff --git a/docs/spec/auth/index.md b/docs/spec/auth/index.md index f6ee8e1fa..d1aa94225 100644 --- a/docs/spec/auth/index.md +++ b/docs/spec/auth/index.md @@ -1,13 +1,8 @@ - +--- +title: "Docker Registry Token Authentication" +description: "Docker Registry v2 authentication schema" +keywords: ["registry, on-prem, images, tags, repository, distribution, authentication, advanced"] +--- # Docker Registry v2 authentication diff --git a/docs/spec/auth/jwt.md b/docs/spec/auth/jwt.md index c90bd6e86..aa9941b0b 100644 --- a/docs/spec/auth/jwt.md +++ b/docs/spec/auth/jwt.md @@ -1,13 +1,8 @@ - +--- +title: "Token Authentication Implementation" +description: "Describe the reference implementation of the Docker Registry v2 authentication schema" +keywords: ["registry, on-prem, images, tags, repository, distribution, JWT authentication, advanced"] +--- # Docker Registry v2 Bearer token specification diff --git a/docs/spec/auth/oauth.md b/docs/spec/auth/oauth.md index 3d1ae0aa4..8b1571792 100644 --- a/docs/spec/auth/oauth.md +++ b/docs/spec/auth/oauth.md @@ -1,13 +1,8 @@ - +--- +title: "Oauth2 Token Authentication" +description: "Specifies the Docker Registry v2 authentication" +keywords: ["registry, on-prem, images, tags, repository, distribution, oauth2, advanced"] +--- # Docker Registry v2 authentication using OAuth2 @@ -188,4 +183,3 @@ Content-Type: application/json {"refresh_token":"kas9Da81Dfa8","access_token":"eyJhbGciOiJFUzI1NiIsInR5":"expires_in":900,"scope":"repository:samalba/my-app:pull,repository:samalba/my-app:push"} ``` - diff --git a/docs/spec/auth/scope.md b/docs/spec/auth/scope.md index a8f6c0628..eecb8f6f1 100644 --- a/docs/spec/auth/scope.md +++ b/docs/spec/auth/scope.md @@ -1,13 +1,8 @@ - +--- +title: "Token Scope Documentation" +description: "Describes the scope and access fields used for registry authorization tokens" +keywords: ["registry, on-prem, images, tags, repository, distribution, advanced, access, scope"] +--- # Docker Registry Token Scope and Access @@ -140,4 +135,3 @@ done by fetching an access token using the refresh token. Since the refresh token is not scoped to specific resources for an audience, extra care should be taken to only use the refresh token to negotiate new access tokens directly with the authorization server, and never with a resource provider. - diff --git a/docs/spec/auth/token.md b/docs/spec/auth/token.md index 12dfc6852..41bcb00dc 100644 --- a/docs/spec/auth/token.md +++ b/docs/spec/auth/token.md @@ -1,13 +1,8 @@ - +--- +title: "Token Authentication Specification" +description: "Specifies the Docker Registry v2 authentication" +keywords: ["registry, on-prem, images, tags, repository, distribution, Bearer authentication, advanced"] +--- # Docker Registry v2 authentication via central service @@ -25,7 +20,7 @@ This document outlines the v2 Docker registry authentication scheme: 5. The client retries the original request with the Bearer token embedded in the request's Authorization header. 6. The Registry authorizes the client by validating the Bearer token and the - claim set embedded within it and begins the push/pull session as usual. + claim set embedded within it and begins the push/pull session as usual. ## Requirements @@ -161,7 +156,7 @@ Defines getting a bearer and refresh token using the token endpoint. expires_in
- (Optional) The duration in seconds since the token was issued that it + (Optional) The duration in seconds since the token was issued that it will remain valid. When omitted, this defaults to 60 seconds. For compatibility with older clients, a token should never be returned with less than 60 seconds to live. diff --git a/docs/spec/implementations.md b/docs/spec/implementations.md index ec937b647..347465350 100644 --- a/docs/spec/implementations.md +++ b/docs/spec/implementations.md @@ -1,8 +1,6 @@ - +--- +published: false +--- # Distribution API Implementations diff --git a/docs/spec/index.md b/docs/spec/index.md index 474bd455c..952ebabd2 100644 --- a/docs/spec/index.md +++ b/docs/spec/index.md @@ -1,13 +1,8 @@ - +--- +title: "Reference Overview" +description: "Explains registry JSON objects" +keywords: ["registry, service, images, repository, json"] +--- # Docker Registry Reference diff --git a/docs/spec/json.md b/docs/spec/json.md index a8916dccc..825b17ac2 100644 --- a/docs/spec/json.md +++ b/docs/spec/json.md @@ -1,13 +1,9 @@ - +--- +published: false +title: "Docker Distribution JSON Canonicalization" +description: "Explains registry JSON objects" +keywords: ["registry, service, images, repository, json"] +--- diff --git a/docs/spec/manifest-v2-1.md b/docs/spec/manifest-v2-1.md index 056f4bc66..b06c2f2a9 100644 --- a/docs/spec/manifest-v2-1.md +++ b/docs/spec/manifest-v2-1.md @@ -1,12 +1,8 @@ - +--- +title: "Image Manifest V 2, Schema 1 " +description: "image manifest for the Registry." +keywords: ["registry, on-prem, images, tags, repository, distribution, api, advanced, manifest"] +--- # Image Manifest Version 2, Schema 1 diff --git a/docs/spec/manifest-v2-2.md b/docs/spec/manifest-v2-2.md index fc7056399..1db8b33ba 100644 --- a/docs/spec/manifest-v2-2.md +++ b/docs/spec/manifest-v2-2.md @@ -1,12 +1,8 @@ - +--- +title: "Image Manifest V 2, Schema 2 " +description: "image manifest for the Registry." +keywords: ["registry, on-prem, images, tags, repository, distribution, api, advanced, manifest"] +--- # Image Manifest Version 2, Schema 2 diff --git a/docs/spec/menu.md b/docs/spec/menu.md index ebc52327b..9237e3ce8 100644 --- a/docs/spec/menu.md +++ b/docs/spec/menu.md @@ -1,13 +1,7 @@ - - +--- +title: "Reference" +description: "Explains registry JSON objects" +keywords: ["registry, service, images, repository, json"] +type: "menu" +identifier: "smn_registry_ref" +---