History

Misty Stanley-Jones a4f5e30249 Various copyedits to reduce future tense, wordiness, and use of 'please' (#5788 ) * Reword lots of instances of 'will' * Reword lots of instances of won't * Reword lots of instances of we'll * Eradicate you'll * Eradicate 'be able to' type of phrases * Eradicate 'unable to' type of phrases * Eradicate 'has / have to' type of phrases * Eradicate 'note that' type of phrases * Eradicate 'in order to' type of phrases * Redirect to official Chef and Puppet docs * Eradicate gratuitous 'please' * Reduce use of e.g. * Reduce use of i.e. * Reduce use of N.B. * Get rid of 'sexagesimal' and correct some errors		2018-01-25 17:37:23 -08:00
..
source	Various copyedits to reduce future tense, wordiness, and use of 'please' (#5788 )	2018-01-25 17:37:23 -08:00
.dockerignore	…
.gitignore	…
Dockerfile	…
Gemfile	…
Gemfile.lock	…
LICENSE	…
Makefile	…
README.md	Various copyedits to reduce future tense, wordiness, and use of 'please' (#5788 )	2018-01-25 17:37:23 -08:00
Rakefile	…
config.rb	…
docker-compose.yml	…
font-selection.json	…
publish.sh	…

README.md

dockercloud/api-docs

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.