Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

simplify the docs branch process for now 

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
This commit is contained in:
Sven Dowideit 2014-04-17 11:11:32 +10:00 committed by Tibor Vass
parent 88a30886e5
commit 742c981b37
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/README.md
View File

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