Browse code

simplify the docs branch process for now

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)

Sven Dowideit authored on 2014/04/17 10:11:32
Showing 1 changed files
... ...
@@ -17,20 +17,21 @@ documentation.
17 17
 ## Branches
18 18
 
19 19
 **There are two branches related to editing docs**: ``master`` and a
20
-``doc*`` branch (currently ``doc0.8.1``). You should normally edit
21
-docs on a local branch of the ``master`` branch. That way your fixes 
20
+``docs`` branch. You should always edit
21
+docs on a local branch of the ``master`` branch, and send a PR against ``master``. 
22
+That way your fixes 
22 23
 will automatically get included in later releases, and docs maintainers 
23
-can easily cherry-pick your changes to bring over to the current docs 
24
-branch. In the rare case where your change is not forward-compatible, 
25
-then you could base your change on the appropriate ``doc*`` branch.
24
+can easily cherry-pick your changes into the ``docs`` release branch. 
25
+In the rare case where your change is not forward-compatible, 
26
+you may need to base your changes on the ``docs`` branch.
26 27
 
27
-Now that we have a ``doc*`` branch, we can keep the ``latest`` docs
28
+Now that we have a ``docs`` branch, we can keep the [http://docs.docker.io](http://docs.docker.io) docs
28 29
 up to date with any bugs found between ``docker`` code releases.
29 30
 
30
-**Warning**: When *reading* the docs, the ``master`` documentation may
31
+**Warning**: When *reading* the docs, the [http://beta-docs.docker.io](http://beta-docs.docker.io) documentation may
31 32
 include features not yet part of any official docker
32
-release. ``Master`` docs should be used only for understanding
33
-bleeding-edge development and ``latest`` (which points to the ``doc*``
33
+release. The ``beta-docs`` site should be used only for understanding
34
+bleeding-edge development and ``docs.docker.io`` (which points to the ``docs``
34 35
 branch``) should be used for the latest official release.
35 36
 
36 37
 Getting Started
... ...
@@ -38,7 +39,7 @@ Getting Started
38 38
 
39 39
 Docker documentation builds are done in a docker container, which installs all
40 40
 the required tools, adds the local ``docs/`` directory and builds the HTML
41
-docs. It then starts a simple HTTP server on port 8000 so that you can connect 
41
+docs. It then starts a HTTP server on port 8000 so that you can connect 
42 42
 and see your changes.
43 43
 
44 44
 In the ``docker`` source directory, run: