Commit graph

1570 commits

Author SHA1 Message Date
Kevin Menard
b25208ee3e It's its. 2014-05-05 15:43:11 -04:00
Victor Vieux
f369278725 Merge pull request #5569 from vieux/add__ping_to_the_API
Add  ping to the api
2014-05-05 10:09:31 -07:00
James Turnbull
30d458c534 Merge pull request #5592 from SvenDowideit/docs-simplify-osx-install
Several OSX install reader issues fixed
2014-05-05 16:46:03 +02:00
Sven Dowideit
56d71ae79b 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)
2014-05-05 22:52:12 +10:00
Sven Dowideit
46755dfc1a 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)
2014-05-05 22:18:12 +10:00
lukemarsden
6799d14cb8 Update devenvironment.md
`git clone` should use `https` URL.
2014-05-04 17:52:48 +01:00
James Turnbull
bfac0b24ed Fixed a couple of single dashes in links document
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-05-04 03:16:21 +02:00
O.S. Tezer
54e20b8f7b Merge pull request #5578 from msulima/patch-1
hello_world.md - $container_id variable case sensitivity
2014-05-03 12:53:14 +01:00
O.S. Tezer
f33298024b Merge pull request #5568 from felixrabe/patch-6
cli.md: More typos
2014-05-03 12:50:57 +01:00
O.S. Tezer
49af92a7a9 Merge pull request #5572 from felixrabe/patch-5
run.md: Close braces
2014-05-03 12:42:04 +01:00
O.S. Tezer
d0c97d5bd2 Merge pull request #5564 from felixrabe/patch-4
cli.md: sudo at the right place
2014-05-03 12:36:31 +01:00
Sven Dowideit
b2268d1ac0 Merge pull request #5551 from felixrabe/patch-1
cli.md: Fix up Markdown formatting by adding one `
2014-05-03 21:02:25 +10:00
Mateusz Sulima
dca1c0073f 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)
2014-05-03 12:22:33 +02:00
Felix Rabe
4a3b0e8d5d run.md: Close braces
Docker-DCO-1.1-Signed-off-by: Felix Rabe <felix@rabe.io> (github: felixrabe)
2014-05-03 02:20:59 +02:00
Felix Rabe
205bd91fca run.md: Convert some backticks to apo's 2014-05-03 02:11:00 +02:00
Felix Rabe
015a2abafa 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)
2014-05-03 00:52:48 +02:00
O.S. Tezer
cefb0d1277 Merge pull request #5563 from felixrabe/patch-3
cli.md: Add space
2014-05-02 23:33:48 +01:00
Victor Vieux
c65de2c020 return write error
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
2014-05-02 22:03:59 +00:00
Felix Rabe
e318af6fb0 cli.md: sudo at the right place
Docker-DCO-1.1-Signed-off-by: Felix Rabe <felix@rabe.io> (github: felixrabe)
2014-05-02 23:58:05 +02:00
Victor Vieux
3c422fe5bf add doc
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
2014-05-02 21:51:20 +00:00
Felix Rabe
4706a1ad76 cli.md: Add another sudo 2014-05-02 23:13:28 +02:00
Felix Rabe
12a4b376fd cli.md: Add space 2014-05-02 22:56:35 +02:00
Felix Rabe
877ad96d89 cli.md: Fix up Markdown formatting by adding one ` 2014-05-02 16:53:59 +02:00
Sven Dowideit
41db175626 Force the older API docs to be generated.
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2014-05-02 10:46:41 +10:00
Sven Dowideit
5a8ffe7ef1 make sure the intermediate index.html files are generated consistently
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2014-05-02 10:08:25 +10:00
Sven Dowideit
de49e7c0a6 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)
2014-05-02 09:47:33 +10:00
James Turnbull
edab1bd5e5 Merge pull request #5524 from ostezer/docs-fix-codeblocks
Improve code/comment/output markings & display consistency
2014-05-01 19:39:06 -04:00
Alexandr Morozov
d1297feef8 Timestamps for docker logs.
Fixes #1165
Docker-DCO-1.1-Signed-off-by: Alexandr Morozov <lk4d4math@gmail.com> (github: LK4D4)
2014-05-01 20:40:36 +04:00
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
O.S. Tezer
51a39563fa Merge pull request #5519 from SvenDowideit/remove-rst-docs
remove rst/sphinx documentation
2014-05-01 16:33:54 +03:00
Sven Dowideit
adf04681b4 remove rst/sphinx documentation
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2014-05-01 15:31:58 +10:00
Sven Dowideit
8ae53ef167 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)
2014-05-01 12:41:57 +10:00
Guillaume J. Charmes
2a711d16e0 Merge pull request #5448 from crosbymichael/selinux-defaults
Add selinux label support for processes and mount
2014-04-30 14:14:39 -07:00
Sven Dowideit
ebaff50bd2 for want of a comma, the kingdom was lost
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2014-04-30 10:12:21 +10:00
O.S. Tezer
34a3d41d17 Merge pull request #5440 from ostezer/docs-improve-code-block-rendering
Docs/CSS: Amend code block rendering.
2014-04-30 00:45:04 +03:00
amangoel
83a5f2a192 Update working-with-docker.md 2014-04-29 13:49:36 -07:00
Sam Rijs
9651ff46bf docs: DisableNetwork -> NetworkDisabled
Docker-DCO-1.1-Signed-off-by: Samuel Reis <srijs@airpost.net> (github: srijs)
2014-04-29 21:18:26 +02:00
Michael Crosby
64d0f7e39b Add cli flag to docs for selinux support
Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
2014-04-29 03:40:06 -07:00
O.S. Tezer
797a4151a0 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
2014-04-29 12:37:22 +03:00
Sven Dowideit
53c35412f9 Merge pull request #5438 from ostezer/docs-expand-viewport
Docs/CSS fix: Allow viewport expand to user's preference
2014-04-29 13:35:10 +10:00
Sven Dowideit
33f36177e9 add redirects from index/ -> docker-io/ and for the docker-io_api too
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2014-04-29 13:33:22 +10:00
Sven Dowideit
6c4e5ee826 Merge pull request #5414 from jamtur01/privreg
Addressed regression of private repository documentation.
2014-04-29 13:28:21 +10:00
James Turnbull
81d6c0f106 Merge pull request #5439 from ostezer/docs-mkdocs-theme-maintainer-update
Docs/theme/MAINTAINERS: Modify/Update list of MAINTAINERS
2014-04-28 23:12:10 -04:00
James Turnbull
548cadd0a2 Merge pull request #5441 from ostezer/docs-fix-notes-warnings-bg
Docs/CSS: Fix Notes/Warnings blocks' BG colour to improve its state.
2014-04-28 23:09:13 -04:00
James Turnbull
a8871b93b9 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)
2014-04-28 16:08:55 -04:00
Andy Goldstein
bba1dd046d 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)
2014-04-28 13:38:58 -04:00
O.S.Tezer
abf3baf4eb Docs/CSS: Fix Notes/Warnings blocks' BG colour to improve its state.
Docs' BG was original "#fff" and blocks such as code blocks or
warning-notes blocks were coloured in #F2F2F2.

In order to make it easier to read everything, the BG colour was
changed to #fff. However, the switch missed to convert other blocks'
BG colour.

This commit aims to re-introduce the correct contrast by changing the
BG colour of warning/notes block to #fff.

Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
2014-04-28 19:02:50 +03:00
O.S.Tezer
f334dbe82d Docs/CSS: Amend code block rendering.
This commit aims to improve the rendering of code blocks by
reducing the padding, matching the font-size with the rest of the
documentation text and finally, by changing the background colour
back to white from its current gray-ish state which matches the
background colour and making it really hard to spot the code.

Note: The BG colouring issue is due to converting the main BG
to gray whilst missing to change parts that where gray to white, i.e.,
not making the complete switch.

Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
2014-04-28 18:58:15 +03:00
O.S.Tezer
442b70c65a Docs/theme/MAINTAINERS: Modify/Update list of MAINTAINERS
So far it has been mostly my duty to create and maintain docs' design/theme.

This commit adds myself to the list of maintainers by modifying
the MAINTAINERS file under the docs/theme directory.

Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
2014-04-28 18:36:40 +03:00
O.S.Tezer
b6699111db Docs/CSS fix: Aallow viewport expand to user's preference
This commit removes the "max-width" property of DOM "containers";
Thus letting the viewport to expand to fill the available space.

This commit aims to bring pleasure to Docker docs' readers' eyes,
And to make them happy by letting them profit more from their large
monitors. (or use more efficiently their smaller ones).

Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
2014-04-28 18:30:31 +03:00