From d588ed13b257d19e79346beab608fb84a9613f24 Mon Sep 17 00:00:00 2001 From: Mary Anthony Date: Sat, 18 Apr 2015 17:06:51 -0700 Subject: [PATCH] Fixes #391 for registry top page Fixes #390 to add building link to README Docker Registry Service to Docker Registry Signed-off-by: Mary Anthony --- README.md | 8 +++++--- docs/Dockerfile | 10 +++++----- docs/configuration.md | 2 +- docs/deploying.md | 12 ++++++------ docs/distribution.md | 4 ++-- docs/{overview.md => index.md} | 2 +- docs/migration.md | 2 +- docs/mkdocs.yml | 16 ++++++++-------- docs/notifications.md | 2 +- 9 files changed, 30 insertions(+), 28 deletions(-) rename docs/{overview.md => index.md} (99%) diff --git a/README.md b/README.md index fcb470c85..ac7672580 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ The Docker toolset to pack, ship, store, and deliver content. -This repository's main product is the Docker Registry Service 2.0 implementation +This repository's main product is the Docker Registry 2.0 implementation for storing and distributing Docker images. It supersedes the [docker/docker- registry](https://github.com/docker/docker-registry) project with a new API design, focused around security and performance. @@ -15,7 +15,7 @@ This repository contains the following components: | **libraries** | A rich set of libraries for interacting with,distribution components. Please see [godoc](http://godoc.org/github.com/docker/distribution) for details. **Note**: These libraries are **unstable**. | | **dist** | An _experimental_ tool to provide distribution, oriented functionality without the `docker` daemon. | | **specifications** | _Distribution_ related specifications are available in [docs/spec](docs/spec) | -| **documentation** | Docker's full documentation set is available at [docs.docker.com](http://docs.docker.com). This repository [contains the subset](docs/overview.md) related just to the registry. | +| **documentation** | Docker's full documentation set is available at [docs.docker.com](http://docs.docker.com). This repository [contains the subset](docs/index.md) related just to the registry. | ### How does this integrate with Docker engine? @@ -69,7 +69,9 @@ may be the better choice. ## Contribute -Please see [CONTRIBUTING.md](CONTRIBUTING.md). +Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute +issues, fixes, and patches to this project. If you are contributing code, see +the instructions for [building a development environment](docs/building.md). ## Support diff --git a/docs/Dockerfile b/docs/Dockerfile index 17a740258..1613e13aa 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -12,11 +12,11 @@ RUN git reset --hard # The above line causes a floating point error in our tools # RUN grep "VERSION =" /src/version/version.go | sed 's/.*"\(.*\)".*/\1/' > /docs/VERSION -COPY docs/* /docs/sources/distribution/ -COPY docs/images/* /docs/sources/distribution/images/ -COPY docs/spec/* /docs/sources/distribution/spec/ -COPY docs/spec/auth/* /docs/sources/distribution/spec/auth/ -COPY docs/storage-drivers/* /docs/sources/distribution/storage-drivers/ +COPY docs/* /docs/sources/registry/ +COPY docs/images/* /docs/sources/registry/images/ +COPY docs/spec/* /docs/sources/registry/spec/ +COPY docs/spec/auth/* /docs/sources/registry/spec/auth/ +COPY docs/storage-drivers/* /docs/sources/registry/storage-drivers/ COPY docs/mkdocs.yml /docs/mkdocs-distribution.yml diff --git a/docs/configuration.md b/docs/configuration.md index e6277d8c2..0b59f41b9 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,5 +1,5 @@ page_title: Configure a Registry -page_description: Explains how to deploy a registry service +page_description: Explains how to deploy a registry page_keywords: registry, service, images, repository diff --git a/docs/deploying.md b/docs/deploying.md index 01761748d..c7d3d17cf 100644 --- a/docs/deploying.md +++ b/docs/deploying.md @@ -1,10 +1,10 @@ -page_title: Deploying a registry service -page_description: Explains how to deploy a registry service +page_title: Deploying a registry server +page_description: Explains how to deploy a registry server page_keywords: registry, service, images, repository -# Deploying a registry service +# Deploying a registry server -This section explains how to deploy a Docker Registry Service either privately +This section explains how to deploy a Docker Registry either privately for your own company or publicly for other users. For example, your company may require a private registry to support your continuous integration (CI) system as it builds new releases or test servers. Alternatively, your company may have a @@ -37,7 +37,7 @@ a local registry. The `run` command automatically pulls a `hello-world` image from Docker's official images. -3. Start a registry service on your localhost. +3. Start a registry on your localhost. $ docker run -p 5000:5000 registry:2.0 @@ -82,7 +82,7 @@ a local registry. 511136ea3c5a: Image already exists Digest: sha256:a1b13bc01783882434593119198938b9b9ef2bd32a0a246f16ac99b01383ef7a -7. Use the `curl` command and the Docker Registry Service API v2 to list your +7. Use the `curl` command and the Docker Registry API v2 to list your image in the registry: $ curl -v -X GET http://localhost:5000/v2/hello-mine/tags/list diff --git a/docs/distribution.md b/docs/distribution.md index 3907b91ab..bad7362f5 100644 --- a/docs/distribution.md +++ b/docs/distribution.md @@ -1,11 +1,11 @@ # Project ## Contents -- [Docker Registry Service 2.0](overview.md) +- [Docker Registry 2.0](index.md) - [Architecture](architecture.md) - [Build the development environment](building.md) - [Configure a registry](configuration.md) -- [Deploying a registry service](deploying.md) +- [Deploying a registry server](deploying.md) - [Microsoft Azure storage driver](storage-drivers/azure.md) - [Filesystem storage driver](storage-drivers/filesystem.md) - [In-memory storage driver](storage-drivers/inmemory.md) diff --git a/docs/overview.md b/docs/index.md similarity index 99% rename from docs/overview.md rename to docs/index.md index 0d97549af..7c21d17ff 100644 --- a/docs/overview.md +++ b/docs/index.md @@ -22,7 +22,7 @@ is collection of images. Users interact with the registry by pushing images to or pulling images from the registry. The Docker Registry includes several optional features that you can configure according to your needs. -![](../images/registry.png) +![](images/registry.png) The architecture supports a configurable storage backend. You can store images on a file system or on a service such as Amazon S3 or Microsoft Azure. The diff --git a/docs/migration.md b/docs/migration.md index c1eae91cb..be3f02bbe 100644 --- a/docs/migration.md +++ b/docs/migration.md @@ -10,7 +10,7 @@ One can migrate images from one version to the other by pulling images from the ----- -The Docker Registry Service 2.0 is backward compatible with images created by the earlier specification. If you are migrating a private registry to version 2.0, you should use the following process: +The Docker Registry 2.0 is backward compatible with images created by the earlier specification. If you are migrating a private registry to version 2.0, you should use the following process: 1. Configure and test a 2.0 registry image in a sandbox environment. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 025896c9d..5ff559096 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,9 +1,9 @@ -- ['distribution/overview.md', 'Reference', 'Docker Registry Service 2.0'] -- ['distribution/deploying.md', 'Reference', '-- Deploy a registry' ] -- ['distribution/configuration.md', 'Reference', '-- Configure a registry' ] -- ['distribution/storagedrivers.md', 'Reference', '-- Storage driver model' ] -- ['distribution/notifications.md', 'Reference', '-- Work with notifications' ] -- ['distribution/spec/api.md', 'Reference', '-- Registry Service API v2' ] -- ['distribution/spec/json.md', 'Reference', '-- JSON format' ] -- ['distribution/spec/auth/token.md', 'Reference', '-- Authenticate via central service' ] +- ['registry/index.md', 'Reference', 'Docker Registry 2.0'] +- ['registry/deploying.md', 'Reference', '    ▪  Deploy a registry' ] +- ['registry/configuration.md', 'Reference', '    ▪  Configure a registry' ] +- ['registry/storagedrivers.md', 'Reference', '    ▪  Storage driver model' ] +- ['registry/notifications.md', 'Reference', '    ▪  Work with notifications' ] +- ['registry/spec/api.md', 'Reference', '    ▪  Registry Service API v2' ] +- ['registry/spec/json.md', 'Reference', '    ▪  JSON format' ] +- ['registry/spec/auth/token.md', 'Reference', '    ▪  Authenticate via central service' ] diff --git a/docs/notifications.md b/docs/notifications.md index 264a7dc8d..b8fdf3716 100644 --- a/docs/notifications.md +++ b/docs/notifications.md @@ -1,5 +1,5 @@ page_title: Work with Notifications -page_description: Explains how to deploy a registry service +page_description: Explains how to deploy a registry server page_keywords: registry, service, images, repository # Notifications