diff --git a/docs/Dockerfile b/docs/Dockerfile index 7914abf38007a..aa97313ae9bac 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -37,15 +37,32 @@ COPY ./release.sh release.sh # #ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/mkdocs.yml /docs/mkdocs-distribution.yml -#ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/overview.md /docs/sources/distribution/overview.md -#RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/distribution/overview.md +ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/images/notifications.png /docs/sources/registry/images/notifications.png +ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/images/registry.png /docs/sources/registry/images/registry.png -#ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/install.md /docs/sources/distribution/install.md -#RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/distribution/install.md +ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/overview.md /docs/sources/registry/overview.md +RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/registry/overview.md -#ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/architecture.md /docs/sources/distribution/architecture.md -#RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/distribution/architecture.md +ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/deploying.md /docs/sources/registry/deploying.md +RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/registry/deploying.md +ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/configuration.md /docs/sources/registry/configuration.md +RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/registry/configuration.md + +ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/storagedrivers.md /docs/sources/registry/storagedrivers.md +RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/registry/storagedrivers.md + +ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/notifications.md /docs/sources/registry/notifications.md +RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/registry/notifications.md + +ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/spec/api.md /docs/sources/registry/spec/api.md +RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/registry/spec/api.md + +ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/spec/json.md /docs/sources/registry/spec/json.md +RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/registry/spec/json.md + +ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/spec/auth/token.md /docs/sources/registry/spec/auth/token.md +RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/registry/spec/auth/token.md # Docker Swarm #ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/docs/mkdocs.yml /docs/mkdocs-swarm.yml @@ -88,4 +105,4 @@ ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/word RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/wordpress.md # Then build everything together, ready for mkdocs -RUN /docs/build.sh +RUN /docs/build.sh \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 6e7be67d20ec6..30f2d11624d5b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -132,10 +132,19 @@ pages: - ['swarm/scheduler/filter.md', 'Reference', 'Swarm filters'] - ['swarm/API.md', 'Reference', 'Swarm API'] - ['reference/api/index.md', '**HIDDEN**'] +- ['registry/overview.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' ] +- ['reference/api/hub_registry_spec.md', 'Reference', 'Docker Hub and Registry 1.0'] +- ['reference/api/registry_api.md', 'Reference', '    ▪ Docker Registry API v1'] +- ['reference/api/registry_api_client_libraries.md', 'Reference', '    ▪ Docker Registry 1.0 API Client Libraries'] +#- ['reference/image-spec-v1.md', 'Reference', 'Docker Image Specification v1.0.0'] - ['reference/api/docker-io_api.md', 'Reference', 'Docker Hub API'] -- ['reference/api/registry_api.md', 'Reference', 'Docker Registry API'] -- ['reference/api/registry_api_client_libraries.md', 'Reference', 'Docker Registry API Client Libraries'] -- ['reference/api/hub_registry_spec.md', 'Reference', 'Docker Hub and Registry Spec'] #- ['reference/image-spec-v1.md', 'Reference', 'Docker Image Specification v1.0.0'] - ['reference/api/docker_remote_api.md', 'Reference', 'Docker Remote API'] - ['reference/api/docker_remote_api_v1.18.md', 'Reference', 'Docker Remote API v1.18'] diff --git a/docs/sources/reference/api/hub_registry_spec.md b/docs/sources/reference/api/hub_registry_spec.md index 26d4ffca307e9..0e39784b84751 100644 --- a/docs/sources/reference/api/hub_registry_spec.md +++ b/docs/sources/reference/api/hub_registry_spec.md @@ -2,7 +2,7 @@ page_title: Registry Documentation page_description: Documentation for docker Registry and Registry API page_keywords: docker, registry, api, hub -# The Docker Hub and the Registry spec +# The Docker Hub and the Registry 1.0 spec ## The three roles @@ -28,9 +28,9 @@ The Docker Hub is authoritative for that information. There is only one instance of the Docker Hub, run and managed by Docker Inc. -### Registry +### Docker Registry 1.0 -The registry has the following characteristics: +The 1.0 registry has the following characteristics: - It stores the images and the graph for a set of repositories - It does not have user accounts data diff --git a/docs/sources/reference/api/registry_api.md b/docs/sources/reference/api/registry_api.md index 54a158934a77c..13a51356f0462 100644 --- a/docs/sources/reference/api/registry_api.md +++ b/docs/sources/reference/api/registry_api.md @@ -2,11 +2,11 @@ page_title: Registry API page_description: API Documentation for Docker Registry page_keywords: API, Docker, index, registry, REST, documentation -# Docker Registry API +# Docker Registry API v1 ## Introduction - - This is the REST API for the Docker Registry + - This is the REST API for the Docker Registry 1.0 - It stores the images and the graph for a set of repositories - It does not have user accounts data - It has no notion of user accounts or authorization diff --git a/docs/sources/reference/api/registry_api_client_libraries.md b/docs/sources/reference/api/registry_api_client_libraries.md index 6977af3cc462f..811ac859e420d 100644 --- a/docs/sources/reference/api/registry_api_client_libraries.md +++ b/docs/sources/reference/api/registry_api_client_libraries.md @@ -2,7 +2,7 @@ page_title: Registry API Client Libraries page_description: Various client libraries available to use with the Docker registry API page_keywords: API, Docker, index, registry, REST, documentation, clients, C#, Erlang, Go, Groovy, Java, JavaScript, Perl, PHP, Python, Ruby, Rust, Scala -# Docker Registry API Client Libraries +# Docker Registry 1.0 API Client Libraries These libraries have not been tested by the Docker maintainers for compatibility. Please file issues with the library owners. If you find