From 1aa8b00bdf0b56e5906ab798d88a617f3b806c18 Mon Sep 17 00:00:00 2001 From: Mary Anthony Date: Tue, 16 Jun 2015 06:00:24 -0700 Subject: [PATCH] Adding in the better sed Renaming to index.md;rereading of Hugo showed me my mistake; removing commented out/Markdown has no comment feature Updating with Olivier. Yay! It looks great Signed-off-by: Mary Anthony --- docs/Dockerfile | 26 ++++++++++++++------------ docs/configuration.md | 6 +++--- docs/deploying.md | 4 ++-- docs/help.md | 15 ++++++++++----- docs/{overview.md => index.md} | 26 +++----------------------- docs/introduction.md | 26 +++++++++++++++++++------- docs/notifications.md | 8 ++++---- docs/spec/api.md | 1 - docs/spec/api.md.tmpl | 1 - docs/spec/json.md | 1 + docs/storage-drivers/azure.md | 2 -- docs/storage-drivers/filesystem.md | 2 -- docs/storage-drivers/inmemory.md | 2 -- docs/storage-drivers/rados.md | 2 -- docs/storage-drivers/s3.md | 2 -- 15 files changed, 56 insertions(+), 68 deletions(-) rename docs/{overview.md => index.md} (75%) diff --git a/docs/Dockerfile b/docs/Dockerfile index 9f3cfa5e..3a95d1d9 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -4,21 +4,23 @@ MAINTAINER Mary Anthony (@moxiegirl) # To get the git info for this repo COPY . /src -COPY . /docs/content/distribution/ +COPY . /docs/content/registry/ # Sed to process GitHub Markdown # 1-2 Remove comment code from metadata block -# 3 Remove .md extension from link text -# 4 Change ](/ to ](/project/ in links -# 5 Change ](word) to ](/project/word) -# 6 Change ](../../ to ](/project/ -# 7 Change ](../ to ](/project/word) +# 3 Change ](/word to ](/project/ in links +# 4 Change ](word.md) to ](/project/word) +# 5 Remove .md extension from link text +# 6 Change ](./ to ](/project/word) +# 7 Change ](../../ to ](/project/ +# 8 Change ](../ to ](/project/ # -# -RUN find /docs/content/distribution -type f -name "*.md" -exec sed -i.old \ +RUN find /docs/content/registry -type f -name "*.md" -exec sed -i.old \ -e '/^/g' \ -e '/^/g' \ - -e 's/\([(]\)\(.*\)\(\.md\)/\1\2/g' \ - -e 's/\(\]\)\([(]\)\(\/\)/\1\2\/distribution\//g' \ - -e 's/\(\][(]\)\([A-z]*[)]\)/\]\(\/distribution\/\2/g' \ - -e 's/\(\][(]\)\(\.\.\/\)/\1\/distribution\//g' {} \; \ No newline at end of file + -e 's/\(\]\)\([(]\)\(\/\)/\1\2\/registry\//g' \ + -e 's/\(\][(]\)\([A-z].*\)\(\.md\)/\1\/registry\/\2/g' \ + -e 's/\([(]\)\(.*\)\(\.md\)/\1\2/g' \ + -e 's/\(\][(]\)\(\.\/\)/\1\/registry\//g' \ + -e 's/\(\][(]\)\(\.\.\/\.\.\/\)/\1\/registry\//g' \ + -e 's/\(\][(]\)\(\.\.\/\)/\1\/registry\//g' {} \; \ No newline at end of file diff --git a/docs/configuration.md b/docs/configuration.md index 0fdbf611..c260cdf3 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -5,7 +5,7 @@ description = "Explains how to deploy a registry" keywords = ["registry, service, images, repository"] [menu.main] parent="smn_registry" -weight=2 +weight=4 +++ @@ -279,7 +279,7 @@ Refer to `loglevel` to configure the level of messages printed. ## loglevel -> **DEPRECATED:** Please use [log](#log) instead. +> **DEPRECATED:** Please use `log` 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](#pool) subsection. +with the `pool` subsection. diff --git a/docs/deploying.md b/docs/deploying.md index 226f3307..9ebad658 100644 --- a/docs/deploying.md +++ b/docs/deploying.md @@ -5,7 +5,7 @@ description = "Explains how to deploy a registry server" keywords = ["registry, service, images, repository"] [menu.main] parent="smn_registry" -weight=1 +weight=3 +++ @@ -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](https://github.com/docker/distribution/blob/master/docs/storagedrivers.md), by [configuring it](https://github.com/docker/distribution/blob/master/docs/configuration.md#storage). +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/help.md b/docs/help.md index 6223c57d..8deb6a14 100644 --- a/docs/help.md +++ b/docs/help.md @@ -1,8 +1,13 @@ - + # Getting help diff --git a/docs/overview.md b/docs/index.md similarity index 75% rename from docs/overview.md rename to docs/index.md index df9ec95b..61d1507f 100644 --- a/docs/overview.md +++ b/docs/index.md @@ -54,30 +54,10 @@ docker push localhost:5000/myfirstimage docker pull localhost:5000/myfirstimage ``` -Simple as that? Yes. Now, please read the... +## Where to go next + +Simple as that? Yes. Continue on to read the [overview of the registry](introduction.md). -## Documentation - - - [Introduction](introduction.md) - - [Deployment](deploying.md) - - [Configuration](configuration.md) - - [Getting help](help.md) - - [Contributing](../CONTRIBUTING.md) - -### Reference and advanced topics - - - [Glossary](glossary.md) - - [Authentication](authentication.md) - - [Working with notifications](notifications.md) - -### Development resources - - - [Storage driver model](storagedrivers.md) - - [Registry API](spec/api.md) - \ No newline at end of file diff --git a/docs/introduction.md b/docs/introduction.md index 5efec283..4f7a9135 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,8 +1,13 @@ - + # Understanding the Registry @@ -42,6 +47,13 @@ You absolutely need to be familiar with Docker, specifically with regard to push Also, while just starting a registry is fairly easy, operating it in a production environment requires operational skills, just like any other service. You are expected to be familiar with systems availability and scalability, logging and log processing, systems monitoring, and security 101. Strong understanding of http and overall network communications, plus familiarity with golang are certainly useful as well. -## Next +## Related information + + - [Deploy a registry](deploying.md) + - [Configure a registry](configuration.md) + - [Authentication](authentication.md) + - [Working with notifications](notifications.md) + - [Registry API](spec/api.md) + - [Storage driver model](storagedrivers.md) + -You are now ready to [deploy your registry](deploying.md). diff --git a/docs/notifications.md b/docs/notifications.md index 233b35c7..b49cf38c 100644 --- a/docs/notifications.md +++ b/docs/notifications.md @@ -5,7 +5,7 @@ description = "Explains work with registry notifications" keywords = ["registry, service, images, notifications, repository"] [menu.main] parent="smn_registry" -weight=1 +weight=5 +++ @@ -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_](#endpoints). +queues and dispatches events to endpoints. ![](../images/notifications.png) @@ -49,12 +49,12 @@ notifications: ``` The above would configure the registry with an endpoint to send events to -"https://mylistener.example.com/event", with the header "Authorization: Bearer +`https://mylistener.example.com/event`, with the header "Authorization: Bearer ". The request would timeout after 500 milliseconds. If 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#notifications). +For details on the fields, please see the [configuration documentation](configuration.md). A properly configured endpoint should lead to a log message from the registry upon startup: diff --git a/docs/spec/api.md b/docs/spec/api.md index 56eef796..f5148b56 100644 --- a/docs/spec/api.md +++ b/docs/spec/api.md @@ -1,6 +1,5 @@ diff --git a/docs/storage-drivers/filesystem.md b/docs/storage-drivers/filesystem.md index 50030d30..2dbad8cd 100644 --- a/docs/storage-drivers/filesystem.md +++ b/docs/storage-drivers/filesystem.md @@ -3,8 +3,6 @@ title = "Filesystem storage driver" description = "Explains how to use the filesystem storage drivers" keywords = ["registry, service, driver, images, storage, filesystem"] -[menu.main] -parent="smn_registry_drivers" +++ diff --git a/docs/storage-drivers/inmemory.md b/docs/storage-drivers/inmemory.md index 7256b941..f43e1510 100644 --- a/docs/storage-drivers/inmemory.md +++ b/docs/storage-drivers/inmemory.md @@ -3,8 +3,6 @@ title = "In-memory storage driver" description = "Explains how to use the in-memory storage drivers" keywords = ["registry, service, driver, images, storage, in-memory"] -[menu.main] -parent="smn_registry_drivers" +++ diff --git a/docs/storage-drivers/rados.md b/docs/storage-drivers/rados.md index 83cdea26..4b630e19 100644 --- a/docs/storage-drivers/rados.md +++ b/docs/storage-drivers/rados.md @@ -3,8 +3,6 @@ title = "Ceph RADOS storage driver" description = "Explains how to use the Ceph RADOS storage driver" keywords = ["registry, service, driver, images, storage, ceph, rados"] -[menu.main] -parent="smn_registry_drivers" +++ diff --git a/docs/storage-drivers/s3.md b/docs/storage-drivers/s3.md index 4393bd76..7835ec39 100644 --- a/docs/storage-drivers/s3.md +++ b/docs/storage-drivers/s3.md @@ -3,8 +3,6 @@ title = "S3 storage driver" description = "Explains how to use the S3 storage drivers" keywords = ["registry, service, driver, images, storage, S3"] -[menu.main] -parent="smn_registry_drivers" +++