docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Source repo for Docker's Documentation
42,242 Commits 25 Branches 28 Tags 827 MiB
HTML 65.6%
CSS 16.2%
Go 5.6%
Dockerfile 3.8%
JavaScript 3.2%
Other 5.6%
Go to file
Misty Stanley-Jones 15efc2d851 Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
.github Initial import of https://github.com/docker/pinata 2016-09-28 20:36:30 -07:00
apidocs Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
cloud-api-docs Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
cs-engine Moved cs-engine docs to the cs-engine subdirectory 2016-09-28 14:19:05 -07:00
docker-hub Move docker-hub docs to docker-hub subdirectory 2016-09-29 10:38:52 -07:00
docker-store Move docker-store docs to docker-store subdirectory 2016-09-28 14:40:26 -07:00
docker-trusted-registry Moved docker-trusted-registry imported docs to apidocs and docker-trusted-registry subdirectories 2016-09-28 14:29:59 -07:00
docs Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
engine Moved engine imported docs to the engine subdirectory 2016-09-29 11:19:31 -07:00
images Initial import of https://github.com/docker/pinata 2016-09-28 20:40:01 -07:00
kitematic Move kitematic docs to kitematic subdirectory 2016-09-28 16:46:17 -07:00
machine Move machine docs to machine subdirectory 2016-09-28 20:45:49 -07:00
notary Move notary docs to notary subdirectory 2016-09-28 16:35:14 -07:00
opensurce Move opensource docs to opensource subdirectory 2016-09-28 16:42:34 -07:00
registry Initial import of https://github.com/docker/docker 2016-09-29 11:17:56 -07:00
swarm Move swarm docs to swarm subdirectory 2016-09-28 14:54:30 -07:00
toolbox Move toolbox docs to toolbox subdirectory 2016-09-28 16:39:30 -07:00
ucp Moved imported orca docs into ucp directory 2016-09-28 14:35:02 -07:00
.arcconfig Imitial import of https://github.com/docker/hub2-demo 2016-09-28 14:36:23 -07:00
.babelrc Initial commit -f https://github.com/docker/mercury-ui 2016-09-28 14:39:20 -07:00
.bumpversion.cfg Imitial import of https://github.com/docker/hub2-demo 2016-09-29 10:35:53 -07:00
.dockercfg.template Imitial import of https://github.com/docker/hub2-demo 2016-09-28 14:36:23 -07:00
.drone.yml Initial commit -f https://github.com/docker/orca 2016-09-28 14:33:25 -07:00
.editorconfig Imitial import of https://github.com/docker/hub2-demo 2016-09-28 14:36:23 -07:00
.eslintignore Initial commit -f https://github.com/docker/mercury-ui 2016-09-28 14:39:20 -07:00
.flowconfig Imitial import of https://github.com/docker/hub2-demo 2016-09-28 14:36:23 -07:00
.gitattributes Imitial import of https://github.com/docker/hub2-demo 2016-09-29 10:35:53 -07:00
.gitmodules Initial import of https://github.com/docker/dhe-engine 2016-09-28 14:25:04 -07:00
.htmllintrc Initial commit -f https://github.com/docker/mercury-ui 2016-09-28 14:39:20 -07:00
.lfsconfig Initial import of https://github.com/docker/pinata 2016-09-28 20:36:30 -07:00
.mailmap Initial import of https://github.com/docker/distribution 2016-09-28 14:45:00 -07:00
.npmrc Initial commit -f https://github.com/docker/mercury-ui 2016-09-28 14:39:20 -07:00
.pre-commit-config.yaml Tests use updated get_config_paths_from_options signature 2016-03-24 10:57:01 -07:00
.stylelintrc Initial commit -f https://github.com/docker/mercury-ui 2016-09-28 14:39:20 -07:00
Jenkinsfile Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00
README.md Initial import of https://github.com/docker/cloud-docs 2016-09-29 11:31:42 -07:00

README.md

Documentation for Docker Cloud

To build the documentation locally.

  1. Fork this repo.

  2. Change to the docs directory.

  3. 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:

  1. Make changes to the API's Markdown source.

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

  1. Add the Markdown together with the HTML to your pull request:

    $ git add apidocs/*

    $ git add docs

  2. Push your changes to orgin.

  3. Create a Pull request as you normally wouled.