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
Oscar Caballero 269c80d2d9 Spelling revision 2018-09-23 21:43:11 +02:00
..
source Spelling revision 2018-09-23 21:43:11 +02: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 Various copyedits to reduce future tense, wordiness, and use of 'please' (#5788) 2018-01-25 17:37:23 -08: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, send us a pull request!

Usage

To run it locally:

$ git clone --recursive https://github.com/docker/docker.github.io.git
$ make release

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 committed to this repository.

After merging all PR's, run make release. This will place the updated HTML into the apidocs/docker-cloud directory.

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