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

Tweaking some things 

Signed-off-by: Mary Anthony <mary@docker.com>
This commit is contained in:
Mary Anthony 2015-10-24 18:07:08 -07:00 committed by Tibor Vass
parent 526c844004
commit cd95e0a5c5
1 changed files with 16 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/README.md
View File

@ -18,7 +18,7 @@ Docker has two primary branches for documentation:
| Branch | Description | URL (published via commit-hook) | | Branch | Description | URL (published via commit-hook) |
|----------|--------------------------------|------------------------------------------------------------------------------| |----------|--------------------------------|------------------------------------------------------------------------------|
| `docs` | Official release documentation | [https://docs.docker.com](https://docs.docker.com) | | `docs` | Official release documentation | [https://docs.docker.com](https://docs.docker.com) |
| `master` | Merged but unreleased development work | [http://docs.master.dockerproject.org](http://docs.master.dockerproject.org) | | `master` | Merged but unreleased development work | |
Additions and updates to upcoming releases are made in a feature branch off of Additions and updates to upcoming releases are made in a feature branch off of
the `master` branch. The Docker maintainers also support a `docs` branch that the `master` branch. The Docker maintainers also support a `docs` branch that
@ -26,9 +26,7 @@ contains the last release of documentation.
After a release, documentation updates are continually merged into `master` as After a release, documentation updates are continually merged into `master` as
they occur. This work includes new documentation for forthcoming features, bug they occur. This work includes new documentation for forthcoming features, bug
fixes, and other updates. Docker's CI system automatically builds and updates fixes, and other updates.
the `master` documentation after each merge and posts it to
[http://docs.master.dockerproject.org](http://docs.master.dockerproject.org).
Periodically, the Docker maintainers update `docs.docker.com` between official Periodically, the Docker maintainers update `docs.docker.com` between official
releases of Docker. They do this by cherry-picking commits from `master`, releases of Docker. They do this by cherry-picking commits from `master`,
@ -67,8 +65,7 @@ own.
The `docker/docker` repository contains a `Dockerfile` and a `Makefile`. The `docker/docker` repository contains a `Dockerfile` and a `Makefile`.
Together, these create a development environment in which you can build and Together, these create a development environment in which you can build and
run a container running the Docker documentation website. To build the run a container running the Docker documentation website. To build the
documentation site, enter `make docs` at the root of your `docker/docker` documentation site, enter `make docs` in the `docs` directory of your `docker/docker` fork:
fork:
$ make docs $ make docs
.... (lots of output) .... .... (lots of output) ....
@ -289,7 +286,3 @@ aws cloudfront create-invalidation --profile docs.docker.com --distribution-id
For information on generating man pages (short for manual page), see the README.md For information on generating man pages (short for manual page), see the README.md
document in [the man page directory](https://github.com/docker/docker/tree/master/docker) document in [the man page directory](https://github.com/docker/docker/tree/master/docker)
in this project. in this project.