History

Adrien Duermael b193b00826 `cf6fc379` fix had to be made in /apidocs/cloud-api-source Signed-off-by: Adrien Duermael <adrien@duermael.com>		2017-01-11 12:06:08 -08:00
..
source	`cf6fc379` fix had to be made in /apidocs/cloud-api-source	2017-01-11 12:06:08 -08: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	CLOUD-2789 update api docs to include namespace	2016-11-04 16:25:46 -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

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/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.