Browse code

Updates to Compose docs and ENV vars - Compose teamhad forgotten some documentation - Updated ENV for Distribution also - Forgot one of the readability sections

Signed-off-by: Mary Anthony <mary@docker.com>

Mary Anthony authored on 2015/04/18 04:53:30
Showing 2 changed files
... ...
@@ -6,11 +6,10 @@ MAINTAINER Sven Dowideit <SvenDowideit@docker.com> (@SvenDowideit)
6 6
 
7 7
 # This section ensures we pull the correct version of each
8 8
 # sub project
9
-ENV COMPOSE_BRANCH 1.2.0
9
+ENV COMPOSE_BRANCH release
10 10
 ENV SWARM_BRANCH v0.2.0
11 11
 ENV MACHINE_BRANCH master
12
-ENV DISTRIB_BRANCH v2.0.0
13
-
12
+ENV DISTRIB_BRANCH release/2.0
14 13
 
15 14
 
16 15
 # TODO: need the full repo source to get the git version info
... ...
@@ -33,8 +32,10 @@ COPY ./s3_website.json s3_website.json
33 33
 COPY ./release.sh release.sh
34 34
 
35 35
 
36
+#######################
36 37
 # Docker Distribution
37
-# 
38
+########################
39
+
38 40
 #ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/mkdocs.yml /docs/mkdocs-distribution.yml
39 41
 
40 42
 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
64 64
 ADD https://raw.githubusercontent.com/docker/distribution/${DISTRIB_BRANCH}/docs/spec/auth/token.md /docs/sources/registry/spec/auth/token.md
65 65
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/registry/spec/auth/token.md
66 66
 
67
+#######################
67 68
 # Docker Swarm
69
+#######################
70
+
68 71
 #ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/docs/mkdocs.yml /docs/mkdocs-swarm.yml
69 72
 ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/docs/index.md /docs/sources/swarm/index.md
70 73
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/swarm/index.md
74
+
71 75
 ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/discovery/README.md /docs/sources/swarm/discovery.md
72 76
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/swarm/discovery.md
77
+
73 78
 ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/api/README.md /docs/sources/swarm/API.md
74 79
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/swarm/API.md
80
+
75 81
 ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/scheduler/filter/README.md /docs/sources/swarm/scheduler/filter.md
76 82
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/swarm/scheduler/filter.md
83
+
77 84
 ADD https://raw.githubusercontent.com/docker/swarm/${SWARM_BRANCH}/scheduler/strategy/README.md /docs/sources/swarm/scheduler/strategy.md
78 85
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/swarm/scheduler/strategy.md
79 86
 
87
+#######################
80 88
 # Docker Machine
89
+#######################
81 90
 #ADD https://raw.githubusercontent.com/docker/machine/${MACHINE_BRANCH}/docs/mkdocs.yml /docs/mkdocs-machine.yml
91
+
82 92
 ADD https://raw.githubusercontent.com/docker/machine/${MACHINE_BRANCH}/docs/index.md /docs/sources/machine/index.md
83 93
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/machine/index.md
84 94
 
95
+#######################
85 96
 # Docker Compose
97
+#######################
98
+
86 99
 #ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/mkdocs.yml /docs/mkdocs-compose.yml
100
+
87 101
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/index.md /docs/sources/compose/index.md
88 102
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/index.md
103
+
89 104
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/install.md /docs/sources/compose/install.md
90 105
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/install.md
106
+
91 107
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/cli.md /docs/sources/compose/cli.md
92 108
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/cli.md
109
+
93 110
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/yml.md /docs/sources/compose/yml.md
94 111
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/yml.md
112
+
95 113
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/env.md /docs/sources/compose/env.md
96 114
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/env.md
115
+
97 116
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/completion.md /docs/sources/compose/completion.md
98 117
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/completion.md
99 118
 
100 119
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/django.md /docs/sources/compose/django.md
101 120
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/django.md
121
+
102 122
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/rails.md /docs/sources/compose/rails.md
103 123
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/rails.md
124
+
104 125
 ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/wordpress.md /docs/sources/compose/wordpress.md
105 126
 RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/wordpress.md
106 127
 
128
+ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/extends.md /docs/sources/compose/extends.md
129
+RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/extends.md
130
+
131
+ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/production.md /docs/sources/compose/production.md
132
+RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/production.md
133
+
107 134
 # Then build everything together, ready for mkdocs
108 135
 RUN /docs/build.sh
109 136
\ No newline at end of file
... ...
@@ -1,5 +1,5 @@
1 1
 site_name: Docker Documentation
2
-#site_url: https://docs.docker.com/
2
+#site_url: http://docs.docker.com/
3 3
 site_url: /
4 4
 site_description: Documentation for fast and lightweight Docker container based virtualization framework.
5 5
 site_favicon: img/favicon.png
... ...
@@ -66,6 +66,8 @@ pages:
66 66
 - ['userguide/level1.md', '**HIDDEN**' ]
67 67
 - ['userguide/level2.md', '**HIDDEN**' ]
68 68
 - ['compose/index.md', 'User Guide', 'Docker Compose' ]
69
+- ['compose/production.md', 'User Guide', '&nbsp;&nbsp;&nbsp;&nbsp;&blacksquare;&nbsp; Use Compose in production' ]
70
+- ['compose/extends.md', 'User Guide', '&nbsp;&nbsp;&nbsp;&nbsp;&blacksquare;&nbsp; Extend Compose services' ]
69 71
 - ['machine/index.md', 'User Guide', 'Docker Machine' ]
70 72
 - ['swarm/index.md', 'User Guide', 'Docker Swarm' ]
71 73
 
... ...
@@ -122,7 +124,6 @@ pages:
122 122
 - ['reference/commandline/cli.md', 'Reference', 'Docker command line']
123 123
 - ['reference/builder.md', 'Reference', 'Dockerfile']
124 124
 - ['faq.md', 'Reference', 'FAQ']
125
-- ['reference/glossary.md', 'Reference', 'Glossary']
126 125
 - ['reference/run.md', 'Reference', 'Run Reference']
127 126
 - ['compose/cli.md', 'Reference', 'Compose command line']
128 127
 - ['compose/yml.md', 'Reference', 'Compose yml']
... ...
@@ -148,10 +149,9 @@ pages:
148 148
 - ['reference/api/docker-io_api.md', 'Reference', 'Docker Hub API']
149 149
 #- ['reference/image-spec-v1.md', 'Reference', 'Docker Image Specification v1.0.0']
150 150
 - ['reference/api/docker_remote_api.md', 'Reference', 'Docker Remote API']
151
-- ['reference/api/docker_remote_api_v1.19.md', 'Reference', 'Docker Remote API v1.19']
152 151
 - ['reference/api/docker_remote_api_v1.18.md', 'Reference', 'Docker Remote API v1.18']
153 152
 - ['reference/api/docker_remote_api_v1.17.md', 'Reference', 'Docker Remote API v1.17']
154
-- ['reference/api/docker_remote_api_v1.16.md', '**HIDDEN**']
153
+- ['reference/api/docker_remote_api_v1.16.md', 'Reference', 'Docker Remote API v1.16']
155 154
 - ['reference/api/docker_remote_api_v1.15.md', '**HIDDEN**']
156 155
 - ['reference/api/docker_remote_api_v1.14.md', '**HIDDEN**']
157 156
 - ['reference/api/docker_remote_api_v1.13.md', '**HIDDEN**']
... ...
@@ -187,17 +187,16 @@ pages:
187 187
 # Project:
188 188
 - ['project/index.md', '**HIDDEN**']
189 189
 - ['project/who-written-for.md', 'Contributor Guide', 'README first']
190
-- ['project/software-required.md', 'Contributor Guide', 'Get required software']
191
-- ['project/set-up-git.md', 'Contributor Guide', 'Configure Git for contributing']
192
-- ['project/set-up-dev-env.md', 'Contributor Guide', 'Work with a development container']
190
+- ['project/software-required.md', 'Contributor Guide', 'Get required software'] 
191
+- ['project/set-up-git.md', 'Contributor Guide', 'Configure Git for contributing'] 
192
+- ['project/set-up-dev-env.md', 'Contributor Guide', 'Work with a development container'] 
193 193
 - ['project/test-and-docs.md', 'Contributor Guide', 'Run tests and test documentation']
194 194
 - ['project/make-a-contribution.md', 'Contributor Guide', 'Understand contribution workflow']
195
-- ['project/find-an-issue.md', 'Contributor Guide', 'Find an issue']
196
-- ['project/work-issue.md', 'Contributor Guide', 'Work on an issue']
197
-- ['project/create-pr.md', 'Contributor Guide', 'Create a pull request']
198
-- ['project/review-pr.md', 'Contributor Guide', 'Participate in the PR review']
195
+- ['project/find-an-issue.md', 'Contributor Guide', 'Find an issue'] 
196
+- ['project/work-issue.md', 'Contributor Guide', 'Work on an issue'] 
197
+- ['project/create-pr.md', 'Contributor Guide', 'Create a pull request'] 
198
+- ['project/review-pr.md', 'Contributor Guide', 'Participate in the PR review'] 
199 199
 - ['project/advanced-contributing.md', 'Contributor Guide', 'Advanced contributing']
200 200
 - ['project/get-help.md', 'Contributor Guide', 'Where to get help']
201 201
 - ['project/coding-style.md', 'Contributor Guide', 'Coding style guide']
202 202
 - ['project/doc-style.md', 'Contributor Guide', 'Documentation style guide']
203
-