فهرست منبع

Merge pull request #12496 from moxiegirl/post-release-updates

Updates to Compose docs and ENV vars
moxiegirl 10 سال پیش
والد
کامیت
a313b729e4
2فایلهای تغییر یافته به همراه43 افزوده شده و 16 حذف شده
  1. 32 4
      docs/Dockerfile
  2. 11 12
      docs/mkdocs.yml

+ 32 - 4
docs/Dockerfile

@@ -6,11 +6,10 @@ MAINTAINER Sven Dowideit <SvenDowideit@docker.com> (@SvenDowideit)
 
 # This section ensures we pull the correct version of each
 # sub project
-ENV COMPOSE_BRANCH 1.2.0
+ENV COMPOSE_BRANCH release
 ENV SWARM_BRANCH v0.2.0
 ENV MACHINE_BRANCH master
-ENV DISTRIB_BRANCH v2.0.0
-
+ENV DISTRIB_BRANCH release/2.0
 
 
 # TODO: need the full repo source to get the git version info
@@ -33,8 +32,10 @@ COPY ./s3_website.json s3_website.json
 COPY ./release.sh release.sh
 
 
+#######################
 # Docker Distribution
-# 
+########################
+
 #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/images/notifications.png /docs/sources/registry/images/notifications.png
@@ -64,45 +65,72 @@ RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/registry/spec/jso
 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
 ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/docs/index.md /docs/sources/swarm/index.md
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/swarm/index.md
+
 ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/discovery/README.md /docs/sources/swarm/discovery.md
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/swarm/discovery.md
+
 ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/api/README.md /docs/sources/swarm/API.md
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/swarm/API.md
+
 ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/scheduler/filter/README.md /docs/sources/swarm/scheduler/filter.md
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/swarm/scheduler/filter.md
+
 ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/scheduler/strategy/README.md /docs/sources/swarm/scheduler/strategy.md
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/swarm/scheduler/strategy.md
 
+#######################
 # Docker Machine
+#######################
 #ADD https://raw.githubusercontent.com/docker/machine/${MACHINE_BRANCH}/docs/mkdocs.yml /docs/mkdocs-machine.yml
+
 ADD https://raw.githubusercontent.com/docker/machine/${MACHINE_BRANCH}/docs/index.md /docs/sources/machine/index.md
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/machine/index.md
 
+#######################
 # Docker Compose
+#######################
+
 #ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/mkdocs.yml /docs/mkdocs-compose.yml
+
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/index.md /docs/sources/compose/index.md
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/index.md
+
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/install.md /docs/sources/compose/install.md
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/install.md
+
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/cli.md /docs/sources/compose/cli.md
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/cli.md
+
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/yml.md /docs/sources/compose/yml.md
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/yml.md
+
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/env.md /docs/sources/compose/env.md
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/env.md
+
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/completion.md /docs/sources/compose/completion.md
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/completion.md
 
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/django.md /docs/sources/compose/django.md
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/django.md
+
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/rails.md /docs/sources/compose/rails.md
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/rails.md
+
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/wordpress.md /docs/sources/compose/wordpress.md
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/wordpress.md
 
+ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/extends.md /docs/sources/compose/extends.md
+RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/extends.md
+
+ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/production.md /docs/sources/compose/production.md
+RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/production.md
+
 # Then build everything together, ready for mkdocs
 RUN /docs/build.sh

+ 11 - 12
docs/mkdocs.yml

@@ -1,5 +1,5 @@
 site_name: Docker Documentation
-#site_url: https://docs.docker.com/
+#site_url: http://docs.docker.com/
 site_url: /
 site_description: Documentation for fast and lightweight Docker container based virtualization framework.
 site_favicon: img/favicon.png
@@ -66,6 +66,8 @@ pages:
 - ['userguide/level1.md', '**HIDDEN**' ]
 - ['userguide/level2.md', '**HIDDEN**' ]
 - ['compose/index.md', 'User Guide', 'Docker Compose' ]
+- ['compose/production.md', 'User Guide', '&nbsp;&nbsp;&nbsp;&nbsp;&blacksquare;&nbsp; Use Compose in production' ]
+- ['compose/extends.md', 'User Guide', '&nbsp;&nbsp;&nbsp;&nbsp;&blacksquare;&nbsp; Extend Compose services' ]
 - ['machine/index.md', 'User Guide', 'Docker Machine' ]
 - ['swarm/index.md', 'User Guide', 'Docker Swarm' ]
 
@@ -122,7 +124,6 @@ pages:
 - ['reference/commandline/cli.md', 'Reference', 'Docker command line']
 - ['reference/builder.md', 'Reference', 'Dockerfile']
 - ['faq.md', 'Reference', 'FAQ']
-- ['reference/glossary.md', 'Reference', 'Glossary']
 - ['reference/run.md', 'Reference', 'Run Reference']
 - ['compose/cli.md', 'Reference', 'Compose command line']
 - ['compose/yml.md', 'Reference', 'Compose yml']
@@ -148,10 +149,9 @@ pages:
 - ['reference/api/docker-io_api.md', 'Reference', 'Docker Hub API']
 #- ['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.19.md', 'Reference', 'Docker Remote API v1.19']
 - ['reference/api/docker_remote_api_v1.18.md', 'Reference', 'Docker Remote API v1.18']
 - ['reference/api/docker_remote_api_v1.17.md', 'Reference', 'Docker Remote API v1.17']
-- ['reference/api/docker_remote_api_v1.16.md', '**HIDDEN**']
+- ['reference/api/docker_remote_api_v1.16.md', 'Reference', 'Docker Remote API v1.16']
 - ['reference/api/docker_remote_api_v1.15.md', '**HIDDEN**']
 - ['reference/api/docker_remote_api_v1.14.md', '**HIDDEN**']
 - ['reference/api/docker_remote_api_v1.13.md', '**HIDDEN**']
@@ -187,17 +187,16 @@ pages:
 # Project:
 - ['project/index.md', '**HIDDEN**']
 - ['project/who-written-for.md', 'Contributor Guide', 'README first']
-- ['project/software-required.md', 'Contributor Guide', 'Get required software']
-- ['project/set-up-git.md', 'Contributor Guide', 'Configure Git for contributing']
-- ['project/set-up-dev-env.md', 'Contributor Guide', 'Work with a development container']
+- ['project/software-required.md', 'Contributor Guide', 'Get required software'] 
+- ['project/set-up-git.md', 'Contributor Guide', 'Configure Git for contributing'] 
+- ['project/set-up-dev-env.md', 'Contributor Guide', 'Work with a development container'] 
 - ['project/test-and-docs.md', 'Contributor Guide', 'Run tests and test documentation']
 - ['project/make-a-contribution.md', 'Contributor Guide', 'Understand contribution workflow']
-- ['project/find-an-issue.md', 'Contributor Guide', 'Find an issue']
-- ['project/work-issue.md', 'Contributor Guide', 'Work on an issue']
-- ['project/create-pr.md', 'Contributor Guide', 'Create a pull request']
-- ['project/review-pr.md', 'Contributor Guide', 'Participate in the PR review']
+- ['project/find-an-issue.md', 'Contributor Guide', 'Find an issue'] 
+- ['project/work-issue.md', 'Contributor Guide', 'Work on an issue'] 
+- ['project/create-pr.md', 'Contributor Guide', 'Create a pull request'] 
+- ['project/review-pr.md', 'Contributor Guide', 'Participate in the PR review'] 
 - ['project/advanced-contributing.md', 'Contributor Guide', 'Advanced contributing']
 - ['project/get-help.md', 'Contributor Guide', 'Where to get help']
 - ['project/coding-style.md', 'Contributor Guide', 'Coding style guide']
 - ['project/doc-style.md', 'Contributor Guide', 'Documentation style guide']
-