TrueCloudLab/distribution
13
0
Fork 3
Code Issues 3 Pull requests Projects Releases 2 Packages Wiki Activity Actions

Merge pull request #641 from moxiegirl/hugo-test-fixes

Browse source 
Hugo final 1.7 Documentation PR -- please read carefully
This commit is contained in:
Olivier Gambier 2015-06-17 18:04:53 -07:00
commit b5977c0868
15 changed files with 56 additions and 68 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/Dockerfile
View file

@ -4,21 +4,23 @@ MAINTAINER Mary Anthony <mary@docker.com> (@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 '/^<!.*metadata]>/g' \
-e '/^<!.*end-metadata.*>/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' {} \;
-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' {} \;

6
docs/configuration.md
View file

@ -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
+++
<![end-metadata]-->
@ -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.
<table>
<tr>

4
docs/deploying.md
View file

@ -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
+++
<![end-metadata]-->
@ -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.

15
docs/help.md
View file

@ -1,8 +1,13 @@
<!--GITHUB
page_title: Getting help
page_description: Getting help with the Registry
page_keywords: registry, service, images, repository, help
IGNORES-->
<!--[metadata]>
+++
title = "Getting help"
description = "Getting help with the Registry"
keywords = ["registry, service, images, repository, help"]
[menu.main]
parent="smn_registry"
weight=9
+++
<![end-metadata]-->
# Getting help

26
docs/overview.md → docs/index.md
View file

@ -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)
<!--
- [Building the registry](building.md)
- [Architecture notes](architecture.md)
-->

26
docs/introduction.md
View file

@ -1,8 +1,13 @@
<!--GITHUB
page_title: Understanding the Registry
page_description: Explains what it is, basic use cases and requirements
page_keywords: registry, service, images, repository, understand, use cases, requirements
IGNORES-->
<!--[metadata]>
+++
title = "Understanding the Registry"
description = "Explains what it is, basic use cases and requirements"
keywords = ["registry, service, images, repository, understand, use cases, requirements"]
[menu.main]
parent="smn_registry"
weight=2
+++
<![end-metadata]-->
# 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).

8
docs/notifications.md
View file

@ -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
+++
<![end-metadata]-->
@ -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
<your token, if needed>". 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:

1
docs/spec/api.md
View file

@ -1,6 +1,5 @@
<!--[metadata]>
+++
draft = true
title = "Docker Registry HTTP API V2"
description = "This is a specification for the API."
keywords = ["registry, service, driver, images, storage, api"]

1
docs/spec/api.md.tmpl
View file

@ -1,6 +1,5 @@
<!--[metadata]>
+++
draft = true
title = "Docker Registry HTTP API V2"
description = "This is a specification for the API."
keywords = ["registry, service, driver, images, storage, api"]

1
docs/spec/json.md
View file

@ -1,5 +1,6 @@
<!--[metadata]>
+++
draft=true
title = "Docker Distribution JSON Canonicalization"
description = "Explains registry JSON objects"
keywords = ["registry, service, images, repository, json"]

2
docs/storage-drivers/azure.md
View file

@ -3,8 +3,6 @@
title = "Microsoft Azure storage driver"
description = "Explains how to use the Azure storage drivers"
keywords = ["registry, service, driver, images, storage, azure"]
[menu.main]
parent="smn_registry_drivers"
+++
<![end-metadata]-->

2
docs/storage-drivers/filesystem.md
View file

@ -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"
+++
<![end-metadata]-->

2
docs/storage-drivers/inmemory.md
View file

@ -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"
+++
<![end-metadata]-->

2
docs/storage-drivers/rados.md
View file

@ -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"
+++
<![end-metadata]-->

2
docs/storage-drivers/s3.md
View file

@ -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"
+++
<![end-metadata]-->