Signed-off-by: Peter Salvatore <peter@psftw.com>
| ... | ... |
@@ -3,11 +3,10 @@ |
| 3 | 3 |
The source for Docker documentation is here under `sources/` and uses extended |
| 4 | 4 |
Markdown, as implemented by [MkDocs](http://mkdocs.org). |
| 5 | 5 |
|
| 6 |
-The HTML files are built and hosted on `https://docs.docker.com`, and update |
|
| 7 |
-automatically after each change to the master or release branch of [Docker on |
|
| 8 |
-GitHub](https://github.com/docker/docker) thanks to post-commit hooks. The |
|
| 9 |
-`docs` branch maps to the "latest" documentation and the `master` (unreleased |
|
| 10 |
-development) branch maps to the "master" documentation. |
|
| 6 |
+The HTML files are built and hosted on |
|
| 7 |
+[http://docs.docker.com](http://docs.docker.com), and update automatically |
|
| 8 |
+after each change to the `docs` branch of [Docker on |
|
| 9 |
+GitHub](https://github.com/docker/docker) thanks to post-commit hooks. |
|
| 11 | 10 |
|
| 12 | 11 |
## Contributing |
| 13 | 12 |
|
| ... | ... |
@@ -61,25 +60,21 @@ work!](../CONTRIBUTING.md#sign-your-work) |
| 61 | 61 |
|
| 62 | 62 |
## Branches |
| 63 | 63 |
|
| 64 |
+| Branch | Description | URL (published via commit-hook) | |
|
| 65 |
+|----------|--------------------------------|------------------------------------------------------------------------------| |
|
| 66 |
+| `docs` | Official release documentation | [http://docs.docker.com](http://docs.docker.com) | |
|
| 67 |
+| `master` | Unreleased development work | [http://docs.master.dockerproject.com](http://docs.master.dockerproject.com) | |
|
| 68 |
+ |
|
| 64 | 69 |
**There are two branches related to editing docs**: `master` and `docs`. You |
| 65 |
-should always edit the documentation on a local branch of the `master` |
|
| 66 |
-branch, and send a PR against `master`. |
|
| 67 |
- |
|
| 68 |
-That way your fixes will automatically get included in later releases, and docs |
|
| 69 |
-maintainers can easily cherry-pick your changes into the `docs` release branch. |
|
| 70 |
-In the rare case where your change is not forward-compatible, you may need to |
|
| 71 |
-base your changes on the `docs` branch. |
|
| 72 |
- |
|
| 73 |
-Also, now that we have a `docs` branch, we can keep the |
|
| 74 |
-[http://docs.docker.com](http://docs.docker.com) docs up to date with any bugs |
|
| 75 |
-found between Docker code releases. |
|
| 76 |
- |
|
| 77 |
-> **Warning**: When *reading* the docs, the |
|
| 78 |
-> [http://docs-stage.docker.com](http://docs-stage.docker.com) documentation may |
|
| 79 |
-> include features not yet part of any official Docker release. The `beta-docs` |
|
| 80 |
-> site should be used only for understanding bleeding-edge development and |
|
| 81 |
-> `docs.docker.com` (which points to the `docs` branch`) should be used for the |
|
| 82 |
-> latest official release. |
|
| 70 |
+should always edit the documentation on a local branch of the `master` branch, |
|
| 71 |
+and send a PR against `master`. That way your fixes will automatically get |
|
| 72 |
+included in later releases, and docs maintainers can easily cherry-pick your |
|
| 73 |
+changes into the `docs` release branch. In the rare case where your change is |
|
| 74 |
+not forward-compatible, you may need to base your changes on the `docs` branch. |
|
| 75 |
+ |
|
| 76 |
+Also, since there is a separate `docs` branch, we can keep |
|
| 77 |
+[http://docs.docker.com](http://docs.docker.com) up to date with any bugs found |
|
| 78 |
+between Docker code releases. |
|
| 83 | 79 |
|
| 84 | 80 |
## Publishing Documentation |
| 85 | 81 |
|