Browse code

Mention the mkdocs.yml file for adding new documents

and move the complicated discussion about branches lower down,
hopefully most won't need to know

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)

Sven Dowideit authored on 2014/10/08 10:44:01
Showing 1 changed files
... ...
@@ -9,28 +9,6 @@ GitHub](https://github.com/docker/docker) thanks to post-commit hooks. The
9 9
 `docs` branch maps to the "latest" documentation and the `master` (unreleased
10 10
 development) branch maps to the "master" documentation.
11 11
 
12
-## Branches
13
-
14
-**There are two branches related to editing docs**: `master` and a `docs`
15
-branch. You should always edit documentation on a local branch of the `master`
16
-branch, and send a PR against `master`.
17
-
18
-That way your fixes will automatically get included in later releases, and docs
19
-maintainers can easily cherry-pick your changes into the `docs` release branch.
20
-In the rare case where your change is not forward-compatible, you may need to
21
-base your changes on the `docs` branch.
22
-
23
-Also, now that we have a `docs` branch, we can keep the
24
-[http://docs.docker.com](http://docs.docker.com) docs up to date with any bugs
25
-found between Docker code releases.
26
-
27
-**Warning**: When *reading* the docs, the
28
-[http://docs-stage.docker.com](http://docs-stage.docker.com) documentation may
29
-include features not yet part of any official Docker release. The `beta-docs`
30
-site should be used only for understanding bleeding-edge development and
31
-`docs.docker.com` (which points to the `docs` branch`) should be used for the
32
-latest official release.
33
-
34 12
 ## Contributing
35 13
 
36 14
 - Follow the contribution guidelines ([see
... ...
@@ -46,11 +24,21 @@ changes.
46 46
 
47 47
 In the root of the `docker` source directory:
48 48
 
49
-    make docs
49
+    $ make docs
50
+    .... (lots of output) ....
51
+    $ docker run --rm -it  -e AWS_S3_BUCKET -p 8000:8000 "docker-docs:master" mkdocs serve
52
+    Running at: http://0.0.0.0:8000/
53
+    Live reload enabled.
54
+    Hold ctrl+c to quit.
50 55
 
51 56
 If you have any issues you need to debug, you can use `make docs-shell` and then
52 57
 run `mkdocs serve`
53 58
 
59
+## Adding a new document
60
+
61
+New document (`.md`) files are added to the documentation builds by adding them
62
+to the menu definition in the `docs/mkdocs.yml` file.
63
+
54 64
 ## Style guide
55 65
 
56 66
 The documentation is written with paragraphs wrapped at 80 column lines to make
... ...
@@ -83,6 +71,28 @@ Markdown](http://www.mkdocs.org/user-guide/writing-your-docs/)).  Just be
83 83
 careful not to create many commits. And you must still [sign your
84 84
 work!](../CONTRIBUTING.md#sign-your-work)
85 85
 
86
+## Branches
87
+
88
+**There are two branches related to editing docs**: `master` and a `docs`
89
+branch. You should always edit the documentation on a local branch of the `master`
90
+branch, and send a PR against `master`.
91
+
92
+That way your edits will automatically get included in later releases, and docs
93
+maintainers can easily cherry-pick your changes into the `docs` release branch.
94
+In the rare case where your change is not forward-compatible, you may need to
95
+base your changes on the `docs` branch.
96
+
97
+Also, now that we have a `docs` branch, we can keep the
98
+[http://docs.docker.com](http://docs.docker.com) docs up to date with any bugs
99
+found between Docker code releases.
100
+
101
+> **Warning**: When *reading* the docs, the
102
+> [http://docs-stage.docker.com](http://docs-stage.docker.com) documentation may
103
+> include features not yet part of any official Docker release. The `beta-docs`
104
+> site should be used only for understanding bleeding-edge development and
105
+> `docs.docker.com` (which points to the `docs` branch`) should be used for the
106
+> latest official release.
107
+
86 108
 ## Publishing Documentation
87 109
 
88 110
 To publish a copy of the documentation you need to have Docker up and running on your