mirror of https://github.com/docker/docs.git
29 lines
906 B
Markdown
29 lines
906 B
Markdown
dockercloud/api-docs
|
|
====================
|
|
|
|
[](https://cloud.docker.com/stack/deploy/)
|
|
|
|
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`.
|