docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
docs/apidocs/cloud-api-source
History
LRubin 55be806bd7 check in apidocs move 
Signed-off-by: LRubin <lrubin@docker.com>
 		2016-10-04 15:53:07 -07:00
..
source fixes up cloud api docs 2016-10-04 11:11:14 -07:00
.dockerignore fixes up cloud api docs 2016-10-04 11:11:14 -07:00
.gitignore fixes up cloud api docs 2016-10-04 11:11:14 -07:00
Dockerfile fixes up cloud api docs 2016-10-04 11:11:14 -07:00
Gemfile fixes up cloud api docs 2016-10-04 11:11:14 -07:00
Gemfile.lock fixes up cloud api docs 2016-10-04 11:11:14 -07:00
LICENSE fixes up cloud api docs 2016-10-04 11:11:14 -07:00
Makefile check in apidocs move 2016-10-04 15:53:07 -07:00
README.md fixes up cloud api docs 2016-10-04 11:11:14 -07:00
Rakefile fixes up cloud api docs 2016-10-04 11:11:14 -07:00
config.rb fixes up cloud api docs 2016-10-04 11:11:14 -07:00
docker-compose.yml fixes up cloud api docs 2016-10-04 11:11:14 -07:00
font-selection.json fixes up cloud api docs 2016-10-04 11:11:14 -07:00
publish.sh fixes up cloud api docs 2016-10-04 11:11:14 -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.