Commit Graph

1581 Commits

Author SHA1 Message Date
b4dfa516c6 The Go template is a better pattern for documentation.
Upstream-commit: 7549199cc5e1de910f5dbd539831095739524ea6
Component: engine
2014-05-07 00:21:02 -07:00
9f2043420a update the docs to reflect the nice \n handling
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: cfb232cff27da2dd46ec04a5bf6699ab1d1df91c
Component: engine
2014-05-07 09:40:49 +10:00
49adbc4838 Merge pull request #5622 from SvenDowideit/net-host-docs
Update the run --net cli help to include the 'host' option
Upstream-commit: d7166536e7f71ca87a8c37d2eb1c06184c9f3bd6
Component: engine
2014-05-07 07:11:41 +10:00
670dbc4add Merge pull request #5616 from nirvdrum/patch-2
Use the contraction for "it is."
Upstream-commit: ba6a732357ce9e2fa3292ce8b46d17dadfe22468
Component: engine
2014-05-06 11:33:41 +01:00
65cf6af87c Update the run --net cli help to include the 'host' option
and then add that to the run and cli docs

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: 9eeff6d099a951c3a3e45d63ce2f8cb158aaeb6c
Component: engine
2014-05-06 20:26:44 +10:00
1d128ba235 add linked containers to hosts file
Docker-DCO-1.1-Signed-off-by: Bryan Murphy <bmurphy1976@gmail.com> (github: bmurphy1976)

Docker-DCO-1.1-Signed-off-by: Solomon Hykes <solomon@docker.com> (github: shykes)
Tested-by: Solomon Hykes <solomon@docker.com> (github: shykes)
Upstream-commit: 53f38a14cd6b61a6b5df68cc3694dcba2b0c1eb7
Component: engine
2014-05-05 19:40:27 -07:00
e892d9d992 Use the correct "it's."
Upstream-commit: 2b0f88383afba28fe7b0bba989d115c2f5e2cc87
Component: engine
2014-05-05 20:08:35 -04:00
80dddf62f3 Merge pull request #5597 from jamtur01/docs-simplify-osx-install
Fixed the horrible OSX installation docs
Upstream-commit: df5827dd02f115811ba82bf8ae979ada292967f5
Component: engine
2014-05-06 08:55:14 +10:00
d5f89ec02b Merge pull request #4441 from crosbymichael/add-net-flag
Add --net flag to docker run and allow host network stack
Upstream-commit: 70fef1460a9d253bdf164d70d7057ec4ee497e08
Component: engine
2014-05-05 13:54:55 -07:00
dae2f35ca5 It's its.
Upstream-commit: b25208ee3e4d652d8b1f86ffac343b718118b745
Component: engine
2014-05-05 15:43:11 -04:00
eebd02a00b Merge pull request #5569 from vieux/add__ping_to_the_API
Add  ping to the api
Upstream-commit: f369278725a2c31f5fa2ba2da33ad513f54a5897
Component: engine
2014-05-05 10:09:31 -07:00
ab8f143867 Add docs for --net flag
Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
Upstream-commit: c1c6b3ccd915084bc9472992afa16f677a074785
Component: engine
2014-05-05 10:08:59 -07:00
a347ba17b5 Fixed the horrible OSX installation docs
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: c34bb099e51300f4355f949cc514bab8370c82c1
Component: engine
2014-05-05 17:02:03 +02:00
339b3d71d5 Merge pull request #5592 from SvenDowideit/docs-simplify-osx-install
Several OSX install reader issues fixed
Upstream-commit: 30d458c53414e6b55506c5fa841a0cac7c8c64d4
Component: engine
2014-05-05 16:46:03 +02:00
7225779c77 Several reader issues fixed
- Fix boot2docker url
- move HomeBrew instructions to a separate section
- fix docker client 5-liner to work (its still ugly)
- fix and update program output

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: 56d71ae79bbbdd0d1eb97408c6132687a33ec113
Component: engine
2014-05-05 22:52:12 +10:00
1d1a0132b4 Rearrange the existing info a little, and add example style guide
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: 46755dfc1aa30a418a11dc8e352c600ef365b969
Component: engine
2014-05-05 22:18:12 +10:00
907fa6b5fd Update devenvironment.md
`git clone` should use `https` URL.
Upstream-commit: 6799d14cb8cb9986d4a38473cddd009b96e717c8
Component: engine
2014-05-04 17:52:48 +01:00
9cf8b76f14 Fixed a couple of single dashes in links document
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: bfac0b24ed66277c66807466e9d429624b1179e6
Component: engine
2014-05-04 03:16:21 +02:00
2247041861 Merge pull request #5578 from msulima/patch-1
hello_world.md - $container_id variable case sensitivity
Upstream-commit: 54e20b8f7b27fa28bf60f78900d812ce5f0bf8b9
Component: engine
2014-05-03 12:53:14 +01:00
429d160907 Merge pull request #5568 from felixrabe/patch-6
cli.md: More typos
Upstream-commit: f33298024ba1f3bbcc9f51faefa16ee4de84f429
Component: engine
2014-05-03 12:50:57 +01:00
f47e440d42 Merge pull request #5572 from felixrabe/patch-5
run.md: Close braces
Upstream-commit: 49af92a7a98eba22303bd5d796bc3a2c88193948
Component: engine
2014-05-03 12:42:04 +01:00
e52ce63fdc Merge pull request #5564 from felixrabe/patch-4
cli.md: sudo at the right place
Upstream-commit: d0c97d5bd2ae3565736dabe4c44958f68e2b2355
Component: engine
2014-05-03 12:36:31 +01:00
7886f3a367 Merge pull request #5551 from felixrabe/patch-1
cli.md: Fix up Markdown formatting by adding one `
Upstream-commit: b2268d1ac0e98440b0145040b13b99c3a0ac9c58
Component: engine
2014-05-03 21:02:25 +10:00
fe7021118f hello_world.md - $container_id variable case sensitivity
If you run the tutorial step-by-step, following error occurs:

```$ sudo docker logs $container_id
Usage: docker logs CONTAINER
Fetch the logs of a container
  -f, --follow=false: Follow log output```

This is obviously because bash variables are case-sensitive, so it mustn't be `CONTAINER_ID` above.

Docker-DCO-1.1-Signed-off-by: Mateusz Sulima <sulima.mateusz@email.com> (github: github_handle)
Upstream-commit: dca1c0073f42b0d75e914119eae863d6e6087cd6
Component: engine
2014-05-03 12:22:33 +02:00
bb98c4c7b3 run.md: Close braces
Docker-DCO-1.1-Signed-off-by: Felix Rabe <felix@rabe.io> (github: felixrabe)
Upstream-commit: 4a3b0e8d5d2653cfecbfee370be2406265211253
Component: engine
2014-05-03 02:20:59 +02:00
937cae5963 run.md: Convert some backticks to apo's
Upstream-commit: 205bd91fcab30292ac5f246ce9bdbb045ad1023f
Component: engine
2014-05-03 02:11:00 +02:00
57e3f2c8d8 cli.md: More typos
I've seen one other missing space that I addressed in another PR already.
I don't know whether that is a common occurrence in the docs.

About the second diff chunk, it looks like some copy-paste mistake to me.

Docker-DCO-1.1-Signed-off-by: Felix Rabe <felix@rabe.io> (github: felixrabe)
Upstream-commit: 015a2abafa92ecc61fe5828a285a1e6dcfa07693
Component: engine
2014-05-03 00:52:48 +02:00
554600b198 Merge pull request #5563 from felixrabe/patch-3
cli.md: Add space
Upstream-commit: cefb0d12775c92ed0ae439b126008bcedd7b2ce0
Component: engine
2014-05-02 23:33:48 +01: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
5f23d92b72 cli.md: sudo at the right place
Docker-DCO-1.1-Signed-off-by: Felix Rabe <felix@rabe.io> (github: felixrabe)
Upstream-commit: e318af6fb097ce5157b6766d8dfe921403858756
Component: engine
2014-05-02 23:58:05 +02: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
6ac22e7613 cli.md: Add another sudo
Upstream-commit: 4706a1ad76ed9bc6c0555499d0bd8b8eea3b3604
Component: engine
2014-05-02 23:13:28 +02:00
0275c825eb cli.md: Add space
Upstream-commit: 12a4b376fd42931d959cd925983243e94c981de4
Component: engine
2014-05-02 22:56:35 +02:00
d4a39f6488 cli.md: Fix up Markdown formatting by adding one `
Upstream-commit: 877ad96d89093af8b16112c3534f4ceceaf1b7b3
Component: engine
2014-05-02 16:53:59 +02:00
dea6c0da0b Force the older API docs to be generated.
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: 41db1756268376465fd92038dfba1cca7f219595
Component: engine
2014-05-02 10:46:41 +10:00
61922080fe make sure the intermediate index.html files are generated consistently
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: 5a8ffe7ef1c33996b9032fec2cf7cb2bf64793f0
Component: engine
2014-05-02 10:08:25 +10: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
8195178553 Merge pull request #5519 from SvenDowideit/remove-rst-docs
remove rst/sphinx documentation
Upstream-commit: 51a39563fa31ddde9742b9e8a9b847b7c0307c73
Component: engine
2014-05-01 16:33:54 +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
99009c27fd add page_description and page_keywords md meta to mkdocs html template
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: 8ae53ef167d684ed41fd9bd1a04f7a70a1ad20b6
Component: engine
2014-05-01 12:41:57 +10:00
87fcb82bfa Merge pull request #5448 from crosbymichael/selinux-defaults
Add selinux label support for processes and mount
Upstream-commit: 2a711d16e05b69328f2636f88f8eac035477f7e4
Component: engine
2014-04-30 14:14:39 -07:00
6630e05dd5 for want of a comma, the kingdom was lost
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: ebaff50bd2c94f2353f4bd738e077c7baef3e879
Component: engine
2014-04-30 10:12:21 +10:00
1c4e288ba8 Merge pull request #5440 from ostezer/docs-improve-code-block-rendering
Docs/CSS: Amend code block rendering.
Upstream-commit: 34a3d41d17a3f7090680b2f240a540c40184c573
Component: engine
2014-04-30 00:45:04 +03:00
dd5d56fcd2 Update working-with-docker.md
Upstream-commit: 83a5f2a192f4c8bb87e9cbd80df42a0496615a1a
Component: engine
2014-04-29 13:49:36 -07: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
20f9d39967 Add cli flag to docs for selinux support
Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
Upstream-commit: 64d0f7e39b395a3fc52f441a53f188a19bd53cf3
Component: engine
2014-04-29 03:40:06 -07:00
096d11e72f Merge pull request #5458 from SvenDowideit/add-redirects-for-docker-io-pr-5414
add redirects from index/ -> docker-io/ and for the docker-io_api too
Upstream-commit: 797a4151a04ae5b3ad8aae6ed09a376e5c68108f
Component: engine
2014-04-29 12:37:22 +03:00