Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
| ... | ... |
@@ -7,64 +7,60 @@ Overview |
| 7 | 7 |
The source for Docker documentation is here under ``sources/`` and uses |
| 8 | 8 |
extended Markdown, as implemented by [mkdocs](http://mkdocs.org). |
| 9 | 9 |
|
| 10 |
-The HTML files are built and hosted on https://docs.docker.io, and update |
|
| 11 |
-automatically after each change to the master or release branch of the |
|
| 12 |
-[docker files on GitHub](https://github.com/dotcloud/docker) thanks to |
|
| 13 |
-post-commit hooks. The "release" branch maps to the "latest" |
|
| 14 |
-documentation and the "master" (unreleased development) branch maps to the "master" |
|
| 15 |
-documentation. |
|
| 10 |
+The HTML files are built and hosted on `https://docs.docker.io`, and |
|
| 11 |
+update automatically after each change to the master or release branch |
|
| 12 |
+of [Docker on GitHub](https://github.com/dotcloud/docker) |
|
| 13 |
+thanks to post-commit hooks. The "docs" branch maps to the "latest" |
|
| 14 |
+documentation and the "master" (unreleased development) branch maps to |
|
| 15 |
+the "master" documentation. |
|
| 16 | 16 |
|
| 17 | 17 |
## Branches |
| 18 | 18 |
|
| 19 | 19 |
**There are two branches related to editing docs**: ``master`` and a |
| 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 |
|
| 23 |
-will automatically get included in later releases, and docs maintainers |
|
| 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. |
|
| 27 |
- |
|
| 28 |
-Now that we have a ``docs`` branch, we can keep the [http://docs.docker.io](http://docs.docker.io) docs |
|
| 29 |
-up to date with any bugs found between ``docker`` code releases. |
|
| 30 |
- |
|
| 31 |
-**Warning**: When *reading* the docs, the [http://beta-docs.docker.io](http://beta-docs.docker.io) documentation may |
|
| 32 |
-include features not yet part of any official docker |
|
| 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`` |
|
| 20 |
+``docs`` branch. You should always edit documentation on a local branch |
|
| 21 |
+of the ``master`` branch, and send a PR against ``master``. |
|
| 22 |
+ |
|
| 23 |
+That way your fixes will automatically get included in later releases, |
|
| 24 |
+and docs maintainers can easily cherry-pick your changes into the |
|
| 25 |
+``docs`` release branch. In the rare case where your change is not |
|
| 26 |
+forward-compatible, you may need to base your changes on the ``docs`` |
|
| 27 |
+branch. |
|
| 28 |
+ |
|
| 29 |
+Also, now that we have a ``docs`` branch, we can keep the |
|
| 30 |
+[http://docs.docker.io](http://docs.docker.io) docs up to date with any |
|
| 31 |
+bugs found between ``docker`` code releases. |
|
| 32 |
+ |
|
| 33 |
+**Warning**: When *reading* the docs, the |
|
| 34 |
+[http://beta-docs.docker.io](http://beta-docs.docker.io) documentation |
|
| 35 |
+may include features not yet part of any official docker release. The |
|
| 36 |
+``beta-docs`` site should be used only for understanding bleeding-edge |
|
| 37 |
+development and ``docs.docker.io`` (which points to the ``docs`` |
|
| 35 | 38 |
branch``) should be used for the latest official release. |
| 36 | 39 |
|
| 37 | 40 |
Getting Started |
| 38 | 41 |
--------------- |
| 39 | 42 |
|
| 40 |
-Docker documentation builds are done in a docker container, which installs all |
|
| 41 |
-the required tools, adds the local ``docs/`` directory and builds the HTML |
|
| 42 |
-docs. It then starts a HTTP server on port 8000 so that you can connect |
|
| 43 |
-and see your changes. |
|
| 43 |
+Docker documentation builds are done in a Docker container, which |
|
| 44 |
+installs all the required tools, adds the local ``docs/`` directory and |
|
| 45 |
+builds the HTML docs. It then starts a HTTP server on port 8000 so that |
|
| 46 |
+you can connect and see your changes. |
|
| 44 | 47 |
|
| 45 |
-In the ``docker`` source directory, run: |
|
| 46 |
- ```make docs``` |
|
| 48 |
+In the root of the ``docker`` source directory: |
|
| 49 |
+ |
|
| 50 |
+ cd docker |
|
| 51 |
+ |
|
| 52 |
+Run: |
|
| 53 |
+ |
|
| 54 |
+ make docs |
|
| 47 | 55 |
|
| 48 | 56 |
If you have any issues you need to debug, you can use ``make docs-shell`` and |
| 49 | 57 |
then run ``mkdocs serve`` |
| 50 | 58 |
|
| 51 | 59 |
# Contributing |
| 52 | 60 |
|
| 53 |
-## Normal Case: |
|
| 54 |
- |
|
| 55 | 61 |
* Follow the contribution guidelines ([see |
| 56 | 62 |
``../CONTRIBUTING.md``](../CONTRIBUTING.md)). |
| 57 | 63 |
* [Remember to sign your work!](../CONTRIBUTING.md#sign-your-work) |
| 58 |
-* Work in your own fork of the code, we accept pull requests. |
|
| 59 |
-* Change the ``.md`` files with your favorite editor -- try to keep the |
|
| 60 |
- lines short (80 chars) and respect Markdown conventions. |
|
| 61 |
-* Run ``make clean docs`` to clean up old files and generate new ones, |
|
| 62 |
- or just ``make docs`` to update after small changes. |
|
| 63 |
-* Your static website can now be found in the ``_build`` directory. |
|
| 64 |
-* To preview what you have generated run ``make server`` and open |
|
| 65 |
- http://localhost:8000/ in your favorite browser. |
|
| 66 |
- |
|
| 67 |
-``make clean docs`` must complete without any warnings or errors. |
|
| 68 | 64 |
|
| 69 | 65 |
Working using GitHub's file editor |
| 70 | 66 |
---------------------------------- |
| ... | ... |
@@ -87,7 +83,7 @@ Publishing Documentation |
| 87 | 87 |
------------------------ |
| 88 | 88 |
|
| 89 | 89 |
To publish a copy of the documentation you need a ``docs/awsconfig`` |
| 90 |
-file containing AWS settings to deploy to. The release script will |
|
| 90 |
+file containing AWS settings to deploy to. The release script will |
|
| 91 | 91 |
create an s3 if needed, and will then push the files to it. |
| 92 | 92 |
|
| 93 | 93 |
``` |
| ... | ... |
@@ -97,7 +93,7 @@ aws_secret_access_key = OIUYSADJHLKUHQWIUHE...... |
| 97 | 97 |
region = ap-southeast-2 |
| 98 | 98 |
``` |
| 99 | 99 |
|
| 100 |
-The ``profile`` name must be the same as the name of the bucket you are |
|
| 100 |
+The ``profile`` name must be the same as the name of the bucket you are |
|
| 101 | 101 |
deploying to - which you call from the docker directory: |
| 102 | 102 |
|
| 103 | 103 |
``make AWS_S3_BUCKET=dowideit-docs docs-release`` |