Commit Graph

92 Commits

Author SHA1 Message Date
4369605adb move api docs to APIv1.13
Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: cf513185b0803ac02bbd8cef05e3372e7fc3b269
Component: engine
2014-06-24 12:25:18 +10:00
90c80009e3 Add Sockets (-H) list to docker -D info.
This will allow us to _know_ what the user's -H settings are, which may
be useful for debugging later.

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: f54823bf05af1d549aee4f0d1f56f9a8995eb268
Component: engine
2014-06-24 12:25:17 +10:00
c4f9cd6161 Merge pull request #6240 from pmorie/docs
Add ApiVersion to doc example for remote API 1.12 /version
Upstream-commit: 8f6162f17ba6684641312526b2bfd8b39607b714
Component: engine
2014-06-17 09:21:21 +10:00
db3540c189 Merge pull request #6378 from evanderkoogh/patch-1
Linking containers added to API example
Upstream-commit: 50d49d0db887453b6c5483c9086cbdb68ad466d2
Component: engine
2014-06-15 20:29:50 -04:00
9cacf9c04c docker-java has moved to new location
Upstream-commit: 520163a00ee22ddb3d689f7304db2af2784d3bdb
Component: engine
2014-06-15 20:16:51 +02:00
99ccd1838c Fix several typos
Docker-DCO-1.1-Signed-off-by: Michael Prokop <github@michael-prokop.at> (github: mika)
Upstream-commit: c0c58b6b46626c0ae5cc9c0b37519c505f5a8484
Component: engine
2014-06-14 23:16:30 +02:00
dfd42b4d5f docs: add spotify docker-client link
Docker-DCO-1.1-Signed-off-by: Daniel Norberg <daniel.norberg@gmail.com> (github: danielnorberg)
Upstream-commit: 27b2d7ff7245ad57dcaa7f9ce8eeeee743373a85
Component: engine
2014-06-13 14:20:31 -04:00
ab4671a371 Linking containers added to API example
Linking containers was not covered in the API documentation. I looked it up in the client source code and testing it manually.
Upstream-commit: 0bdadfe4e7547f58c7c32582c61912dfe1fc7302
Component: engine
2014-06-12 17:15:14 +08:00
a88207cb57 Fixed API 1.12 links and misc other fixes
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: 11fee48c2daa254a724836cad59cced7dc96e267
Component: engine
2014-06-08 17:59:22 -07:00
c408832b20 Docs: Rename index with hub for ref. section
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: b0a46d1cb981418f6447b7bc43db907367b77829
Component: engine
2014-06-08 16:34:47 -07:00
757c6e1688 Initial links
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: ef364f7e1faedddab502cf91c0551154c6c48176
Component: engine
2014-06-08 14:54:32 -07:00
2b1c8a35c7 Docs: add ApiVersion to /version for remote API 1.12
Docker-DCO-1.1-Signed-off-by: Paul Morie <pmorie@gmail.com> (github: pmorie)
Upstream-commit: 92f46d233e69a2134ddeaa4843d4b99be00de096
Component: engine
2014-06-06 15:13:25 -04:00
1492ef2c06 Revert "Initial links for Docker Hub rename"
This reverts commit 2819677c215bd409b4ce4da51f0ddfb303760796.

Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: fad14eda3af8b4ffa59f74dc5c6583d22bcc9471
Component: engine
2014-06-05 14:52:06 -07:00
a0d36a9d79 Merge pull request #6156 from jamtur01/links
Initial link update for Docs
Upstream-commit: 6fa3acc96c2d39c75193f140c5ed2e654cc77208
Component: engine
2014-06-05 14:46:33 -07:00
81d8873d1e Fixes incorrect API spec for items moved to HostConfig
DNS and VolumesFrom were moved to HostConfig and as such are part of the
container start and not create.
For some reason 0.10 docs are correct (except for a missing quote in the
JSON") but 0.11 and latest are not.

Docker-DCO-1.1-Signed-off-by: cpuguy83 <cpuguy83@gmail.com> (github: cpuguy83)
Upstream-commit: 8c646ebf16bd0e2618cbca430bc129ee7416a21c
Component: engine
2014-06-05 09:50:27 -04:00
d0a1649e4a Move doc section in Remote API about removing insert from v1.11 to v1.12
Docker-DCO-1.1-Signed-off-by: Tibor Vass <teabee89@gmail.com> (github: tiborvass)
Upstream-commit: 0d1906feea511cbfd1695adbb0b39dfdfae2caeb
Component: engine
2014-06-04 18:30:10 -07:00
e29c2c6bde Totally remove insert feature
Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
Upstream-commit: 7a145b022a3b50b0d04cb0471d517f7c6c5efc67
Component: engine
2014-06-04 17:35:15 -07:00
a1eeb95682 Initial links for Docker Hub rename
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: 2819677c215bd409b4ce4da51f0ddfb303760796
Component: engine
2014-06-04 16:48:49 -07:00
02bad2214b Merge pull request #6181 from SvenDowideit/change-out-port-number
IANA allocated Docker port: 2375
Upstream-commit: a2ec8fa1db6e2e77d29f58623f35c2b2ded8e3b7
Component: engine
2014-06-04 01:07:48 +03:00
ddc2df6d84 IANA allocated Docker port: 2375
2375/2376 are assigned:
http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=docker

For #1440

Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: 5febba93babcf8c4b01862e88b6f6e11a1532bc8
Component: engine
2014-06-04 06:54:19 +10:00
6fe0f07752 Changed all references from Trusted Builds to Automated Builds
* Updated docker images output
* Deprecated docker images -t/--trusted option and replace with --automated
* Changed *trusted variables to *automated
* Changed added support for is_automated alongside deprecated is_trusted
* Updated man pages, docs and completion
* Updated API documentation

Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: 9fc8028c987ac560ceb3b29eb609d77a82abdacc
Component: engine
2014-06-03 12:55:30 -07:00
0c475a0cf3 filters: don't encode empty set. API docs
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
Upstream-commit: 02255ddaa4948fd94450fd5d9d2ee9b147e88352
Component: engine
2014-06-03 12:19:26 -04:00
77921a7a55 Merge pull request #6130 from vieux/standardize_api_keys
Standardize api keys to CamelCase
Upstream-commit: 3e13aaec000aeaa16718e2408b0c371e4de69137
Component: engine
2014-06-02 12:03:11 -07:00
1b1746cd69 Adding User Guide
* Added User Guide section outlines.
* Added User Guide to menu.
* Moved HTTPS example to articles.
* Replaced Hello World example with User Guide.
* Moved use cases out of examples.
* Updated Introduction to add User Guide.
* Redirected migrated /use and /articles links.
* Added Docker.io section
* Added Dockerized section
* Added Using Docker section
* Added Docker Images section
* Added Docker Links section
* Added Docker Volumes section

Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: a7b2c4804b2d98c2b5622db40d3d70b88529d7fe
Component: engine
2014-06-01 17:34:07 -04:00
636c18b736 update docs
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
Upstream-commit: 1dd02ff4a09218eab47533032d1222008d6419b8
Component: engine
2014-05-31 01:28:08 +00:00
62daf025f0 updated documentation for mentioning images vs containers
Docker-DCO-1.1-Signed-off-by: Robin Speekenbrink <robin@kingsquare.nl> (github: fruitl00p)

rebased by

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: a0505edc9a890b3d4cdf5cf1850273c250c3dc41
Component: engine
2014-05-29 11:20:41 +10:00
4c017922d1 default to deleting images via the remote api
This makes the remote API version 1.12 and newer default to
automatically deleting intermediate containers when the build has
succeedeed.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
Upstream-commit: b60d6471721bc914dca179a4372303d41913cc4c
Component: engine
2014-05-19 23:10:54 +03:00
978fda27ac bump remote api to 1.12 & add --force-rm to build
This adds a `--force-rm` flag to docker build which makes the Docker
daemon clean up all containers, even when the build has failed.

This new flag requires that we bump the remote API, so we also bump the
remote API version.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
Upstream-commit: 667e2bd4ea5fbc8698c34565f955cb92cff92890
Component: engine
2014-05-19 23:10:49 +03:00
22e627f918 docs: add back build to remote api v1.10 & v1.11
This adds back the rm query parameter to the remote api docs for api
v1.10 and v1.11.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
Upstream-commit: e39299ca1d50df90b085e6a2e3e3f4b6897e5a59
Component: engine
2014-05-19 22:46:19 +03:00
18e1876580 return write error
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
Upstream-commit: c65de2c0207ac67e5023ada8709490ef4627bd01
Component: engine
2014-05-02 22:03:59 +00:00
16cdcfd13d add doc
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
Upstream-commit: 3c422fe5bf45391a509fd3c7f33033baefb0a234
Component: engine
2014-05-02 21:51:20 +00:00
491fb4c32b Bring back archived remote API versions
- git mv archived/* .
- put the links back into the summary document
- reduce the header depth by 1 so the TOC lists each API version
- update the mkdocs.yaml to render the archived API docs, but not add
  them to the menu/nav

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: de49e7c0a640aada97ace458a4e5d63f5f52d4eb
Component: engine
2014-05-02 09:47:33 +10:00
0f91626b0e Merge pull request #5524 from ostezer/docs-fix-codeblocks
Improve code/comment/output markings & display consistency
Upstream-commit: edab1bd5e5b3b179ea91e675cff6199de109558b
Component: engine
2014-05-01 19:39:06 -04:00
6a260a1e42 Timestamps for docker logs.
Fixes #1165
Docker-DCO-1.1-Signed-off-by: Alexandr Morozov <lk4d4math@gmail.com> (github: LK4D4)
Upstream-commit: d1297feef8b124e69efc99a58294f498ecb8c022
Component: engine
2014-05-01 20:40:36 +04:00
3db0ad0993 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)
Upstream-commit: f87a97f7df838742a602f1984f4552b803e3f92d
Component: engine
2014-05-01 17:52:01 +03:00
549ce4c50e remove rst/sphinx documentation
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: adf04681b4bd7293675b77b2397d87a5361b383b
Component: engine
2014-05-01 15:31:58 +10:00
20591f6a0e docs: DisableNetwork -> NetworkDisabled
Docker-DCO-1.1-Signed-off-by: Samuel Reis <srijs@airpost.net> (github: srijs)
Upstream-commit: 9651ff46bfc19b815e3f78bc5d6895a352db2d37
Component: engine
2014-04-29 21:18:26 +02:00
7e080a1c66 Merge pull request #5414 from jamtur01/privreg
Addressed regression of private repository documentation.
Upstream-commit: 6c4e5ee826e1ae08674ef6e517c77583796a844b
Component: engine
2014-04-29 13:28:21 +10:00
4821b84026 Addressed regression of private repository documentation.
This adds back in the references to private repositories and
provides some refactoring to the Working with repositories
documentation including updating references to the "Central"
registry to Docker.io.

It also:

* Fixes some links and references to Central Index
* Fixes anchors in other files to updated titles in Working with Repositories.
* Renamed Central Index in the remaining places.
* Updated terms documentation to reflect Docker.io
* Updated some Docker Index naming to be consistent.
* Updates menu labels and hyperlinks.

Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: a8871b93b95d1220c860987ae1da4e49c943bfea
Component: engine
2014-04-28 16:08:55 -04:00
1f9a09d037 Docs fix: correct /commit info
Correct documentation for POST /commit to reflect that the container's
configuration is supplied in the request body, and not as a query
parameter.

Also correct a small typo in the example JSON for create container.

Docker-DCO-1.1-Signed-off-by: Andy Goldstein <agoldste@redhat.com> (github: ncdc)
Upstream-commit: bba1dd046dd39405877c9f0b53502e68dddf36b1
Component: engine
2014-04-28 13:38:58 -04:00
f234533b25 Merge pull request #4576 from Soulou/4549-doc-kill-signal-param
Add missing 'signal' parameter for kill endpoint
Upstream-commit: 41558744432f1399f7c2dd77178bc29ff6747705
Component: engine
2014-04-28 04:39:25 -04:00
a11d66ea07 Added back OAuth and Accounts API docs pages
Removed a now unused endpoint from the accounts API.
Updated some of the accounts links to point to www.docker.io
as the account signup and resend-email-confirmation links should
no longer point to the index.

Docker-DCO-1.1-Signed-off-by: Josh Hawn <josh.hawn@docker.com> (github: jlhawn)
Upstream-commit: c6060a3b25b94ae4738ac27bbf62cbb914af7ced
Component: engine
2014-04-27 11:17:48 -07:00
268409eaa5 [Documentation - API] Add missing 'signal' parameter for /containers/:id/kill endpoint
Docker-DCO-1.1-Signed-off-by: Leo Unbekandt <leo.unbekandt@appsdeck.eu> (github: Soulou)
Upstream-commit: 91deb591c8a52a974612b4c6885d989251f819bd
Component: engine
2014-04-27 18:10:30 +01:00
72e7e8f048 small api doc formatting fixup
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: c7bd1f4e648c6615eafebbfcaeb1c30020fc0aba
Component: engine
2014-04-25 20:36:31 +10:00
b6080f6f5b Looking into some broken links, I noticed that we don't need to use
relative paths, and also fixed some broken images.

There are still more todo - next PR I think :)

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: ada86fc5b736d8b3209429c584384fd9974a148a
Component: engine
2014-04-24 22:20:04 +10:00
772ac62a9b Docs auto-conversion fixes and MD marking and structure improvements.
- Remove redundant chars and all errors caused by RST->MD conversion.
   e.g. [/#, /\, \<, />, etc.]
 - Fix broken inter-document links
 - Fix outbound links no-longer active or changed
 - Fix lists
 - Fix code blocks
 - Correct apostrophes
 - Replace redundant inline note marks for code with code marks
 - Fix broken image links
 - Remove non-functional title links
 - Correct broken cross-docs links
 - Improve readability

Note: This PR does not try to fix/amend:

 - Grammatical errors
 - Lexical errors
 - Linguistic-logic errors etc.

It just aims to fix main structural or conversion errors to serve as
a base for further amendments that will cover others including but
not limited to those mentioned above.

Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)

Update:

 - Fix backtick issues

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: c932667cd26f00bb64ddf0c1a7c7de3ac95aa4be
Component: engine
2014-04-24 22:19:32 +10:00
4690619ea9 Add missing blank lines in between list items
Lists with paragraphs as items need blank lines in between
items to generate correct layout.

Docker-DCO-1.1-Signed-off-by: Lance Chen <cyen0312@gmail.com> (github: Lance0312)
Upstream-commit: b87cb76976da57a6765acd9a85494c68a4e6b948
Component: engine
2014-04-21 01:32:00 +08:00
e0138ab848 Introducing spīritus lēnis to fix code highlighting issues due to apostrophe.
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: 2d6324e06a1e2ea8bb2236472a99c3dc4b5f66d1
Component: engine
2014-04-19 03:35:45 +03:00
c565574306 Mark notes and warnings, fix broken link renderings within.
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: 7935850005b775e0cd1a99f9bab1b8cd53784c3a
Component: engine
2014-04-18 23:31:38 +03:00
1bbbedd397 Fixed #5283 - literal leftover from cutover
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: 2f3cb370dfaca1f1c41bbd7af5f064f70ad8267b
Component: engine
2014-04-17 18:58:02 -04:00