1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
moby--moby/docs/sources/reference/api
O.S.Tezer f87a97f7df Improve code/comment/output markings & display consistency
This PR aims to increase the consistency across the docs for
code blocks and code/comment/output markings.

Rule followed here is "what's visible on the screen should be reflected"

Issue:

 - Docs had various code blocks showing: comments, commands & outputs.
 - All three of these items were inconsistently marked.

Some examples as to how this PR aims to introduce improvements:

1. Removed `> ` from in front of the "outputs". Eg,
`    > REPOSITORY                 TAG       ID              CREATED` replaced with:
`    REPOSITORY                 TAG       ID              CREATED`.

2. Introduced `$` for commands. Eg,
`    sudo chkconfig docker on` replaced with:
`    $ sudo chkconfig docker on`

3. Comments:
`    > # ` replaced with:
`    # `.

> Please note:
> Due to a vast amount of items reviewed and changed for this PR, there
> might be some individually incorrect replacements OR patterns of incorrect
> replacements. This PR needs to be reviewed and if there is anything missing,
> it should be improved or amended.

Closes:
https://github.com/dotcloud/docker/issues/5286

Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
2014-05-01 17:52:01 +03:00
..
_static Updated OAuth docs per arothfusz's comments 2014-02-27 14:21:24 -08:00
archive Improve code/comment/output markings & display consistency 2014-05-01 17:52:01 +03:00
docker-io_api.md Addressed regression of private repository documentation. 2014-04-28 16:08:55 -04:00
docker_io_accounts_api.md Added back OAuth and Accounts API docs pages 2014-04-27 11:17:48 -07:00
docker_io_oauth_api.md Looking into some broken links, I noticed that we don't need to use 2014-04-24 22:20:04 +10:00
docker_remote_api.md small api doc formatting fixup 2014-04-25 20:36:31 +10:00
docker_remote_api_v1.9.md Improve code/comment/output markings & display consistency 2014-05-01 17:52:01 +03:00
docker_remote_api_v1.10.md Improve code/comment/output markings & display consistency 2014-05-01 17:52:01 +03:00
docker_remote_api_v1.11.md Improve code/comment/output markings & display consistency 2014-05-01 17:52:01 +03:00
README.md Docs auto-conversion fixes and MD marking and structure improvements. 2014-04-24 22:19:32 +10:00
registry_api.md Docs auto-conversion fixes and MD marking and structure improvements. 2014-04-24 22:19:32 +10:00
registry_index_spec.md Improve code/comment/output markings & display consistency 2014-05-01 17:52:01 +03:00
remote_api_client_libraries.md Docs auto-conversion fixes and MD marking and structure improvements. 2014-04-24 22:19:32 +10:00

This directory holds the authoritative specifications of APIs defined and implemented by Docker. Currently this includes:

  • The remote API by which a docker node can be queried over HTTP
  • The registry API by which a docker node can download and upload container images for storage and sharing
  • The index search API by which a docker node can search the public index for images to download
  • The docker.io OAuth and accounts API which 3rd party services can use to access account information