docs/cloud-api-docs
Misty Stanley-Jones 15efc2d851 Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
..
source Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
.dockerignore Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
.gitignore Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
Dockerfile Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
Gemfile Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
Gemfile.lock Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
LICENSE Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
Makefile Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
README.md Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
Rakefile Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
config.rb Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
docker-compose.yml Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
font-selection.json Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
publish.sh Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00

README.md

dockercloud/api-docs

Deploy to Docker Cloud

If you find a typo or mismatch between the API and this documentation, please send us a pull request!

Usage

To run it locally:

git clone https://github.com/tutumcloud/cloud-api-docs.git
make docs

The documentation will be available in http://localhost:8000/

Updating the release HTML

As with the HTML generated by the DTR apidocs, the Docker Cloud documentation needs to be generated and the resulting HTML commited into this repository.

After merging all PR's, run make release. This will place the updated HTML into the build directory in your local cloud-api-docs repo.

Create a new Pull Request and get it merged. - now this repository is ready for the release process using docker/docs.docker.com.