From 4e95367e5500194c263fef9c3f5bb4036d11e0a7 Mon Sep 17 00:00:00 2001 From: Olivier Gambier Date: Wed, 17 Jun 2015 18:58:53 -0700 Subject: [PATCH] Fixed doc generation + rollback the (now) unecessary changes Signed-off-by: Olivier Gambier --- docs/Dockerfile | 2 +- docs/configuration.md | 4 ++-- docs/deploying.md | 2 +- docs/notifications.md | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/Dockerfile b/docs/Dockerfile index 3a95d1d9d..c7df0f946 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -19,7 +19,7 @@ RUN find /docs/content/registry -type f -name "*.md" -exec sed -i.old \ -e '/^/g' \ -e '/^/g' \ -e 's/\(\]\)\([(]\)\(\/\)/\1\2\/registry\//g' \ - -e 's/\(\][(]\)\([A-z].*\)\(\.md\)/\1\/registry\/\2/g' \ + -e 's/\(\][(]\)\([A-Za-z0-9]*\)\(\.md\)/\1\/registry\/\2/g' \ -e 's/\([(]\)\(.*\)\(\.md\)/\1\2/g' \ -e 's/\(\][(]\)\(\.\/\)/\1\/registry\//g' \ -e 's/\(\][(]\)\(\.\.\/\.\.\/\)/\1\/registry\//g' \ diff --git a/docs/configuration.md b/docs/configuration.md index c260cdf37..493a4be70 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -279,7 +279,7 @@ Refer to `loglevel` to configure the level of messages printed. ## loglevel -> **DEPRECATED:** Please use `log` instead. +> **DEPRECATED:** Please use [log](#logs) instead. ```yaml loglevel: debug @@ -1255,7 +1255,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` subsection. +with the [pool](#pool) subsection. diff --git a/docs/deploying.md b/docs/deploying.md index 9ebad658c..5ab01ba43 100644 --- a/docs/deploying.md +++ b/docs/deploying.md @@ -36,7 +36,7 @@ Then pull it back: By default, your registry stores its data on the local filesystem, inside the container. -In a production environment, it's highly recommended to use [another storage backend](storagedrivers.md), by [configuring it](/configuration.md). +In a production environment, it's highly recommended to use [another storage backend](storagedrivers.md), by [configuring it](configuration.md). If you want to stick with the local posix filesystem, you should store your data outside of the container. diff --git a/docs/notifications.md b/docs/notifications.md index b49cf38ca..b518cb498 100644 --- a/docs/notifications.md +++ b/docs/notifications.md @@ -17,7 +17,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. +queues and dispatches events to [_Endpoints_](#endpoints). ![](../images/notifications.png) @@ -54,7 +54,7 @@ The above would configure the registry with an endpoint to send events to 5 failures happen consecutively, the registry will backoff for 1 second before trying again. -For details on the fields, please see the [configuration documentation](configuration.md). +For details on the fields, please see the [configuration documentation](configuration.md#notifications). A properly configured endpoint should lead to a log message from the registry upon startup: