From 856dacadfc85cabfce96e2322c01e7800a81855e Mon Sep 17 00:00:00 2001 From: John Mulhausen Date: Fri, 30 Sep 2016 01:51:56 -0700 Subject: [PATCH] Content rendering fixes --- docs/configuration.md | 4 ++-- docs/deploying.md | 2 +- docs/glossary.md | 16 ++++++++-------- docs/notifications.md | 2 +- docs/spec/api.md | 15 +++++---------- 5 files changed, 17 insertions(+), 22 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index b900e0fb..0388d84c 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -341,7 +341,7 @@ Refer to `loglevel` to configure the level of messages printed. ## loglevel -> **DEPRECATED:** Please use [log](#log) instead. +> **DEPRECATED:** Please use [log](configuration.md#log) instead. loglevel: debug @@ -1251,7 +1251,7 @@ Declare parameters for constructing the redis connections. Registry instances may use the Redis instance for several applications. The current purpose is caching information about immutable blobs. Most of the options below control how the registry connects to redis. You can control the pool's behavior -with the [pool](#pool) subsection. +with the [pool](configuration.md#pool) subsection. It's advisable to configure Redis itself with the **allkeys-lru** eviction policy as the registry does not set an expire value on keys. diff --git a/docs/deploying.md b/docs/deploying.md index 1ac25093..1aa42aa0 100644 --- a/docs/deploying.md +++ b/docs/deploying.md @@ -154,7 +154,7 @@ Except for registries running on secure local networks, registries should always The simplest way to achieve access restriction is through basic authentication (this is very similar to other web servers' basic authentication mechanism). -> **Warning**: You **cannot** use authentication with an insecure registry. You have to [configure TLS first](#running-a-domain-registry) for this to work. +> **Warning**: You **cannot** use authentication with an insecure registry. You have to [configure TLS first](deploying.md#running-a-domain-registry) for this to work. First create a password file with one entry for the user "testuser", with password "testpassword": diff --git a/docs/glossary.md b/docs/glossary.md index 00be147f..61c8d1dc 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -11,7 +11,7 @@ This page contains definitions for distribution related terms.
A blob is any kind of content that is stored by a Registry under a content-addressable identifier (a "digest").

- Layers are a good example of "blobs". + Layers are a good example of "blobs".

@@ -19,9 +19,9 @@ This page contains definitions for distribution related terms.
An image is a named set of immutable data from which a Docker container can be created.

- An image is represented by a json file called a manifest, and is conceptually a set of layers. + An image is represented by a json file called a manifest, and is conceptually a set of layers. - Image names indicate the location where they can be pulled from and pushed to, as they usually start with a registry domain name and port. + Image names indicate the location where they can be pulled from and pushed to, as they usually start with a registry domain name and port.

@@ -30,7 +30,7 @@ This page contains definitions for distribution related terms.
A layer is a tar archive bundling partial content from a filesystem.

- Layers from an image are usually extracted in order on top of each other to make up a root filesystem from which containers run out. + Layers from an image are usually extracted in order on top of each other to make up a root filesystem from which containers run out.

@@ -45,7 +45,7 @@ This page contains definitions for distribution related terms.

Registry

-
A registry is a service that let you store and deliver images.
+
A registry is a service that let you store and deliver images.

Repository

@@ -57,12 +57,12 @@ This page contains definitions for distribution related terms.
A scope is the portion of a namespace onto which a given authorization token is granted.

Tag

-
A tag is conceptually a "version" of a named image.
+
A tag is conceptually a "version" of a named image.

Example: `docker pull myimage:latest` instructs docker to pull the image "myimage" in version "latest".

- +
- + diff --git a/docs/notifications.md b/docs/notifications.md index db858bc0..dd01a5b8 100644 --- a/docs/notifications.md +++ b/docs/notifications.md @@ -15,7 +15,7 @@ The Registry supports sending webhook notifications in response to events happening within the registry. Notifications are sent in response to manifest pushes and pulls and layer pushes and pulls. These actions are serialized into events. The events are queued into a registry-internal broadcast system which -queues and dispatches events to [_Endpoints_](#endpoints). +queues and dispatches events to [_Endpoints_](notifications.md#endpoints). ![](images/notifications.png) diff --git a/docs/spec/api.md b/docs/spec/api.md index fd745a5b..45551b9e 100644 --- a/docs/spec/api.md +++ b/docs/spec/api.md @@ -258,7 +258,7 @@ All endpoints should support aggressive http caching, compression and range headers, where appropriate. The new API attempts to leverage HTTP semantics where possible but may break from standards to implement targeted features. -For detail on individual endpoints, please see the [_Detail_](#detail) +For detail on individual endpoints, please see the [_Detail_](api.md#detail) section. ### Errors @@ -288,7 +288,7 @@ error codes as `UNKNOWN`, allowing future error codes to be added without breaking API compatibility. For the purposes of the specification error codes will only be added and never removed. -For a complete account of all error codes, please see the [_Errors_](#errors-2) +For a complete account of all error codes, please see the [_Errors_](api.md#errors-2) section. ### API Version Check @@ -622,7 +622,7 @@ Content-Type: application/octet-stream ``` The "digest" parameter must be included with the PUT request. Please see the -[_Completed Upload_](#completed-upload) section for details on the parameters +[_Completed Upload_](api.md#completed-upload) section for details on the parameters and expected responses. ##### Chunked Upload @@ -848,7 +848,7 @@ in [manifest-v2-1.md](manifest-v2-1.md) and [manifest-v2-2.md](manifest-v2-2.md) If there is a problem with pushing the manifest, a relevant 4xx response will be returned with a JSON error message. Please see the -[_PUT Manifest_](#put-manifest) section for details on possible error codes that +[_PUT Manifest_](api.md#put-manifest) section for details on possible error codes that may be returned. If one or more layers are unknown to the registry, `BLOB_UNKNOWN` errors are @@ -912,7 +912,7 @@ explicitly requested. In this case the `Link` header will be returned along with the results, and subsequent results can be obtained by following the link as if pagination had been initially requested. -For details of the `Link` header, please see the [_Pagination_](#pagination) +For details of the `Link` header, please see the [_Pagination_](api.md#pagination) section. #### Pagination @@ -5482,8 +5482,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| - - - - -