Commit graph

179 commits

Author SHA1 Message Date
Adam Singer
7f9178c6d1 removing grep command that depends on perl, better for boot2docker
Docker-DCO-1.1-Signed-off-by: Adam Singer <financeCoding@gmail.com> (github: financeCoding)
2014-05-18 10:02:39 -07:00
O.S. Tezer
343c24a5fa Merge pull request #5805 from joelhandwell/patch-2
changed deprecated -name option to --name
2014-05-14 22:09:17 +01:00
Joel Handwell
2d622df835 changed deprecated -name option to --name
changed deprecated -name option to --name
2014-05-14 16:24:08 -04:00
Joel Handwell
137f4b326a changed deprecated -rm option to --rm
changed deprecated -rm option to --rm
2014-05-14 16:22:38 -04:00
James Turnbull
12201e2ea3 Merge pull request #5599 from ostezer/docs-rewrite-examples-mongodb
Rewrite and update the MongoDB service article
2014-05-09 10:25:37 +02:00
O.S.Tezer
fd56723494 Rewrite and update the MongoDB service article
MongoDB article had some fundemental issues.

 - Outdated Dockerfile
 - Insufficient / unclear instructions
 - Unnecessary comments
 - Failed to explain the role of Docker.io
 - Did not have a complete Dockerfile sample
 - Lacked a "learn more" section / link to Trusted Builds

This update aims to address all these issues with a complete re-write.

It also:

 - Corrects the label under which this article is/was listed on the menu

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

 - First run at amending after the initial review process.
 - Make the Dockerfile generic.
 - Revision.
 - Fixes
2014-05-09 09:09:52 +01: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
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
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
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
Sven Dowideit
ada86fc5b7 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)
2014-04-24 22:20:04 +10:00
O.S.Tezer
c932667cd2 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)
2014-04-24 22:19:32 +10:00
O.S.Tezer
7935850005 Mark notes and warnings, fix broken link renderings within.
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
2014-04-18 23:31:38 +03:00
James Turnbull
2f3cb370df Fixed #5283 - literal leftover from cutover
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-04-17 18:58:02 -04:00
O.S.Tezer
1ff66d27b5 Fix for broken in-document links which got scrambled during conversion.
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
2014-04-17 18:09:08 +03:00
Sven Dowideit
ac999a9cb2 now, with shiney markdown
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2014-04-16 11:04:14 +10:00
Sven Dowideit
031e288075 Merge pull request #4996 from rajatpandit/patch-2
Update nodejs_web_app.rst
2014-04-04 14:41:32 +10:00
Rajat Pandit
32d6041cc3 Update nodejs_web_app.rst 2014-04-03 21:05:50 +01:00
Rajat Pandit
3c36f82f18 Update nodejs_web_app.rst 2014-04-03 20:54:57 +01:00
David Röthlisberger
8c4617e0ae docs: Fix typo in hello world example 2014-04-03 09:40:28 +01:00
James Harrison Fisher
64dd77fa0e Add missing port NAT configuration
Missing port translation causes last line to fail

Docker-DCO-1.1-Signed-off-by: James Fisher <jameshfisher@gmail.com> (github: jameshfisher)
2014-03-27 23:02:44 +00:00
noducks
8e434c314e Force flag to prevent file already exists error.
Docker-DCO-1.1-Signed-off-by: No Ducks <onemannoducks@gmail.com> (github: noducks)
2014-03-25 10:26:45 +00:00
Brian Goff
fbd6fee4ab Fix double single dash arg issues in docs
Docker-DCO-1.1-Signed-off-by: Brian Goff <cpuguy83@gmail.com> (github: cpuguy83)
2014-03-20 14:14:54 -04:00
Victor Vieux
12687b7c10 Merge branch 'https_client' of github.com:discordianfish/docker into discordianfish-https_client
Docker-DCO-1.1-Signed-off-by: Victor Vieux <victor.vieux@docker.com> (github: vieux)
2014-03-19 22:03:11 +00:00
James Turnbull
d3c5891486 Merge pull request #4754 from vojnovski/consistent_apt-key_use
refactor($hack,$docs): be consistent in apt-key keyserver URI usage
2014-03-19 07:38:05 -06:00
Viktor Vojnovski
4fd82db4be refactor($hack,$docs): be consistent in apt-key keyserver URI usage, as done in #4740
In #4740, the apt-key call in docs is changed to use the keyserver port 80 instead of
port 11371, as the previous call would fail with a restrictive firewall or proxy.
This commit extends the change to all apt-key calls in the repository.

Docker-DCO-1.1-Signed-off-by: Viktor Vojnovski <vojnovski@gmail.com> (github: vojnovski)
2014-03-19 10:20:10 +01:00
Sven Dowideit
9bbc11b2ae Merge pull request #4758 from crosbymichael/redis-bind
Be explicit about binding to all interfaces in redis example
2014-03-19 13:04:02 +10:00
Michael Crosby
7822b053cb Be explicit about binding to all interfaces in redis example
Fixes #4021

Moved to debian because the redis installed in ubuntu is really old
and does not support args via the cli.
Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
2014-03-18 17:24:06 -07:00
Michael Crosby
38a3fc3e0e Add sudo clause if your using osx or tcp
Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
2014-03-18 17:07:45 -07:00
zqh
853c5e258f Update nodejs_web_app.rst
the address of epel rpm has change to http://dl.fedoraproject....
2014-03-16 01:07:22 +08:00
Tianon Gravi
44fe8cbbd1 Update to double-dash everywhere
These were found using `git grep -nE '[^-a-zA-Z0-9<>]-[a-zA-Z0-9]{2}'` (fair warning: _many_ false positives there).

Docker-DCO-1.1-Signed-off-by: Andrew Page <admwiggin@gmail.com> (github: tianon)
2014-03-13 11:46:02 -06:00
Sven Dowideit
2ad16c88e2 Merge pull request #4526 from Rovanion/master
All caps variables in normal bash should be avoided not to accidentally collide with environment variables.
2014-03-12 22:24:00 +10:00
Sven Dowideit
8bf63d5326 fixes suggested by James
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2014-03-12 22:02:24 +10:00
Rovanion Luckey
b24be254fa All caps variables in normal bash should be avoided not to accidentally collide with environment variables.
Docker-DCO-1.1-Signed-off-by: Rovanion Luckey <rovanion.luckey@gmail.com> (github: Rovanion)
2014-03-09 11:08:11 +01:00
Johannes 'fish' Ziemke
c000cb6471 Add authenticated TLS support for API
Docker-DCO-1.1-Signed-off-by: Johannes 'fish' Ziemke <github@freigeist.org> (github: discordianfish)
2014-03-09 00:06:44 +01:00
Sven Dowideit
cadd94f44c implement pharvey's suggestions
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2014-03-05 13:12:29 +10:00
Sven Dowideit
28a545d294 Show some ENV / local updated baseimage tricks that use an apt-cacher-ng proxy to make debian based installations instant
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2014-03-05 13:12:25 +10:00
unclejack
73a277eb2f don't skip cert check for an example & use HTTPS
This changes two URLs from http to https and it fixes a Dockerfile to
stop skipping certificate validation. It also adds the ca-certificates
package to that Dockerfile example.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
2014-02-20 01:11:04 +02:00
Andy Rothfusz
836a49a46e Merge pull request #4114 from SvenDowideit/update-sshd-example
update the sshd example to use just a Dockerfile
2014-02-18 12:12:52 -08:00
Andy Rothfusz
3a2fa54857 Merge pull request #4147 from float64/patch-1
Env Clarification
2014-02-18 12:07:39 -08:00
Andy Rothfusz
c14c539c6c Merge pull request #4145 from SvenDowideit/redo-python-example
touch up the examples
2014-02-18 11:08:45 -08:00
Matthias Kühnle
311cb5ca45 Reword - one sentence :-)
Docker-DCO-1.1-Signed-off-by: Matthias Kühnle <git.nivoc@neverbox.com> (github: float64)
2014-02-18 16:04:47 +01:00
Matthias Kühnle
c1dfc63845 Updated environment description
.. to make it even more clear that this env variables are there because of the --link option.

Docker-DCO-1.1-Signed-off-by: Matthias Kühnle <git.nivoc@neverbox.com> (github: float64)
2014-02-18 12:47:44 +01:00
Matthias Kühnle
d73d3b03e4 Reworded description of the environment variables
Removed the "test now..." b/c the code example is only about inspection
of env-variables.
Test follows in the next section.

Docker-DCO-1.1-Signed-off-by: Matthias Kühnle <git.nivoc@neverbox.com> (github: float64)
2014-02-18 12:36:14 +01:00
Matthias Kühnle
8a3cb0c65e Fixed misspelling
Docker-DCO-1.1-Signed-off-by: Matthias Kühnle <git.nivoc@neverbox.com> (github: float64)
2014-02-18 11:38:23 +01:00
Matthias Kühnle
a7f1b74dd8 Env Clarification
Clarified that the env variables here are an example output of env. The user should not set them to the example values.

Docker-DCO-1.1-Signed-off-by: Matthias Kühnle <git.nivoc@neverbox.com> (github: float64)
2014-02-18 11:36:46 +01:00
Yasunori Mahata
68de32888b Fix typo in 'Using Supervisor with Docker' example
Docker-DCO-1.1-Signed-off-by: Yasunori Mahata <mahata777@gmail.com> (github: mahata)
2014-02-17 19:43:56 -08:00
Sven Dowideit
29f7e1bfcb suggested improvements
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2014-02-18 13:23:28 +10:00
Sven Dowideit
b05602a0fe update a new movie: http://asciinema.org/a/7658
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2014-02-18 13:23:28 +10:00
Sven Dowideit
f535a58959 swap busybox for ubuntu, its quicker..
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2014-02-18 13:23:28 +10:00