To build the documentation locally.
-
Fork this repo.
-
Change to the
docs
directory. -
Type
make docs
.
The API documentation for the Docker Cloud project is here
https://github.com/docker/cloud-docs
An extra step is needed when making PR's that modify the API - namely to add the generated HTML output to the PR by doing the following:
-
Make changes to the API's Markdown source.
-
Build the HTML for the API in your local branch.
a. Change to the cloud-api-docs
directory
cd cloud-api-docs
b. Generate the HTML
make release
-
Add the Markdown together with the HTML to your pull request:
$ git add apidocs/*
$ git add docs
-
Push your changes to orgin.
-
Create a Pull request as you normally wouled.