mirror of
https://github.com/docker/docs.git
synced 2026-03-27 14:28:47 +07:00
15efc2d85179b45dd39fdd3afaf1c7c59ece2f07
Documentation for Docker Cloud
To build the documentation locally.
-
Fork this repo.
-
Change to the
docsdirectory. -
Type
make docs.
API Documentation Pull Requests
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.
Description
Languages
Markdown
97.3%
HTML
1.7%
CSS
0.4%
JavaScript
0.2%
Go
0.1%