Signed-off-by: Mary Anthony <mary@docker.com>
| ... | ... |
@@ -18,7 +18,7 @@ Docker has two primary branches for documentation: |
| 18 | 18 |
| Branch | Description | URL (published via commit-hook) | |
| 19 | 19 |
|----------|--------------------------------|------------------------------------------------------------------------------| |
| 20 | 20 |
| `docs` | Official release documentation | [https://docs.docker.com](https://docs.docker.com) | |
| 21 |
-| `master` | Merged but unreleased development work | [http://docs.master.dockerproject.org](http://docs.master.dockerproject.org) | |
|
| 21 |
+| `master` | Merged but unreleased development work | | |
|
| 22 | 22 |
|
| 23 | 23 |
Additions and updates to upcoming releases are made in a feature branch off of |
| 24 | 24 |
the `master` branch. The Docker maintainers also support a `docs` branch that |
| ... | ... |
@@ -26,9 +26,7 @@ contains the last release of documentation. |
| 26 | 26 |
|
| 27 | 27 |
After a release, documentation updates are continually merged into `master` as |
| 28 | 28 |
they occur. This work includes new documentation for forthcoming features, bug |
| 29 |
-fixes, and other updates. Docker's CI system automatically builds and updates |
|
| 30 |
-the `master` documentation after each merge and posts it to |
|
| 31 |
-[http://docs.master.dockerproject.org](http://docs.master.dockerproject.org). |
|
| 29 |
+fixes, and other updates. |
|
| 32 | 30 |
|
| 33 | 31 |
Periodically, the Docker maintainers update `docs.docker.com` between official |
| 34 | 32 |
releases of Docker. They do this by cherry-picking commits from `master`, |
| ... | ... |
@@ -58,7 +56,7 @@ own. |
| 58 | 58 |
|
| 59 | 59 |
By basing from `master` your work is automatically included in the next |
| 60 | 60 |
release. It also allows docs maintainers to easily cherry-pick your changes |
| 61 |
- into the `docs` release branch. |
|
| 61 |
+ into the `docs` release branch. |
|
| 62 | 62 |
|
| 63 | 63 |
4. Modify existing or add new `.md` files to the `docs` directory. |
| 64 | 64 |
|
| ... | ... |
@@ -67,17 +65,16 @@ own. |
| 67 | 67 |
The `docker/docker` repository contains a `Dockerfile` and a `Makefile`. |
| 68 | 68 |
Together, these create a development environment in which you can build and |
| 69 | 69 |
run a container running the Docker documentation website. To build the |
| 70 |
- documentation site, enter `make docs` at the root of your `docker/docker` |
|
| 71 |
- fork: |
|
| 72 |
- |
|
| 70 |
+ documentation site, enter `make docs` in the `docs` directory of your `docker/docker` fork: |
|
| 71 |
+ |
|
| 73 | 72 |
$ make docs |
| 74 | 73 |
.... (lots of output) .... |
| 75 | 74 |
docker run --rm -it -e AWS_S3_BUCKET -p 8000:8000 "docker-docs:master" mkdocs serve |
| 76 | 75 |
Running at: http://0.0.0.0:8000/ |
| 77 | 76 |
Live reload enabled. |
| 78 | 77 |
Hold ctrl+c to quit. |
| 79 |
- |
|
| 80 |
- |
|
| 78 |
+ |
|
| 79 |
+ |
|
| 81 | 80 |
The build creates an image containing all the required tools, adds the local |
| 82 | 81 |
`docs/` directory and generates the HTML files. Then, it runs a Docker |
| 83 | 82 |
container with this image. |
| ... | ... |
@@ -166,7 +163,7 @@ If this happens, set the Docker host. Run the following command to get the |
| 166 | 166 |
variables in your shell: |
| 167 | 167 |
|
| 168 | 168 |
docker-machine env <machine-name> |
| 169 |
- |
|
| 169 |
+ |
|
| 170 | 170 |
Then, set your environment accordingly. |
| 171 | 171 |
|
| 172 | 172 |
## Cherry-picking documentation changes to update an existing release. |
| ... | ... |
@@ -182,13 +179,13 @@ For example, to update the current release's docs, do the following: |
| 182 | 182 |
1. Go to your `docker/docker` fork and get the latest from master. |
| 183 | 183 |
|
| 184 | 184 |
$ git fetch upstream |
| 185 |
- |
|
| 185 |
+ |
|
| 186 | 186 |
2. Checkout a new branch based on `upstream/docs`. |
| 187 | 187 |
|
| 188 | 188 |
You should give your new branch a descriptive name. |
| 189 | 189 |
|
| 190 | 190 |
$ git checkout -b post-1.2.0-docs-update-1 upstream/docs |
| 191 |
- |
|
| 191 |
+ |
|
| 192 | 192 |
3. In a browser window, open [https://github.com/docker/docker/commits/master]. |
| 193 | 193 |
|
| 194 | 194 |
4. Locate the merges you want to publish. |
| ... | ... |
@@ -200,9 +197,9 @@ For example, to update the current release's docs, do the following: |
| 200 | 200 |
5. Copy the commit SHA from GitHub. |
| 201 | 201 |
|
| 202 | 202 |
6. Cherry-pick the commit. |
| 203 |
- |
|
| 203 |
+ |
|
| 204 | 204 |
$ git cherry-pick -x fe845c4 |
| 205 |
- |
|
| 205 |
+ |
|
| 206 | 206 |
7. Repeat until you have cherry-picked everything you want to merge. |
| 207 | 207 |
|
| 208 | 208 |
8. Push your changes to your fork. |
| ... | ... |
@@ -224,13 +221,13 @@ For example, to update the current release's docs, do the following: |
| 224 | 224 |
13. Fetch your merged pull request from `docs`. |
| 225 | 225 |
|
| 226 | 226 |
$ git fetch upstream/docs |
| 227 |
- |
|
| 227 |
+ |
|
| 228 | 228 |
14. Ensure your branch is clean and set to the latest. |
| 229 | 229 |
|
| 230 | 230 |
$ git reset --hard upstream/docs |
| 231 |
- |
|
| 231 |
+ |
|
| 232 | 232 |
15. Copy the `awsconfig` file into the `docs` directory. |
| 233 |
- |
|
| 233 |
+ |
|
| 234 | 234 |
16. Make the beta documentation |
| 235 | 235 |
|
| 236 | 236 |
$ make AWS_S3_BUCKET=beta-docs.docker.io BUILD_ROOT=yes docs-release |
| ... | ... |
@@ -284,12 +281,8 @@ aws cloudfront create-invalidation --profile docs.docker.com --distribution-id |
| 284 | 284 |
aws cloudfront create-invalidation --profile docs.docker.com --distribution-id $DISTRIBUTION_ID --invalidation-batch '{"Paths":{"Quantity":1, "Items":["/v1.1/reference/api/docker_io_oauth_api/"]},"CallerReference":"6Mar2015sventest1"}'
|
| 285 | 285 |
``` |
| 286 | 286 |
|
| 287 |
-### Generate the man pages |
|
| 287 |
+### Generate the man pages |
|
| 288 | 288 |
|
| 289 | 289 |
For information on generating man pages (short for manual page), see the README.md |
| 290 | 290 |
document in [the man page directory](https://github.com/docker/docker/tree/master/docker) |
| 291 | 291 |
in this project. |
| 292 |
- |
|
| 293 |
- |
|
| 294 |
- |
|
| 295 |
- |