Commit Graph

3109 Commits

Author SHA1 Message Date
Sebastiaan van Stijn
efc625fcd0 Cleanup: new project docs fix-ups (alternative)
This cleans up the recently added project docs and
fixes some minor issues.

- remove inline styles where possible
- add redirects for renamed/replaced documents
- add styles for GitHub labels to match the style on GitHub
- fix minor markdown issues causing some code-blocks
  to be shown as text
- wrap the documents to 80-chars
- use 4 spaces in stead of tabs for identing and remove
  trailing whitespace/redundant blank lines
- optimized 'gordon' image

NOTE:
This alternative commit/PR re-introduces some inline
styles because the docs/base image has not yet been
updated for the current docs.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2015-03-07 23:40:34 +01:00
moxiegirl
faa6fd40f4 Merge pull request #11097 from thaJeztah/11069-run-reference-restart-policies
Docs: add restart-policies to 'Run reference'
2015-03-06 22:08:29 -08:00
Mary Anthony
efde5ec9be Fixing two bad files that got borked in the last rebase
Signed-off-by: Mary Anthony <mary.anthony@docker.com>
2015-03-06 14:21:17 -08:00
Mary Anthony
8c575f263d Rewrite the Contributing tree as Project in preparation for the Docker birthday.
Signed-off-by: Mary Anthony <mary.anthony@docker.com>

Optimize images, remove old file, add metadata tagging

Signed-off-by: Mary Anthony <mary.anthony@docker.com>
2015-03-06 14:10:55 -08:00
Sven Dowideit
e058b7980d Merge pull request #11195 from ahmetalpbalkan/doc/remote-api-kind
doc/api: explain Kind (ChangeType)
2015-03-07 07:19:29 +10:00
moxiegirl
55fc7f5c9d Merge pull request #11204 from duglin/VolumeDocs
Tell users about how VOLUME initializes the new mount point/volume
2015-03-06 10:44:03 -08:00
Doug Davis
9be2ca2394 Tell users about how VOLUME initializes the new mount point/volume
Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-03-06 10:25:47 -08:00
Ahmet Alp Balkan
957bc8ac50 remote api: explain Kind (ChangeType)
Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2015-03-05 19:39:14 -08:00
Zhang Wentao
06a40f0f28 docker info display http/https_proxy setting
Signed-off-by: Zhang Wentao <zhangwentao234@huawei.com>
2015-03-06 09:02:21 +08:00
Michael Crosby
0bf6015745 Merge pull request #11172 from duglin/5169-LinkEnvDocs
Add some text about env vars when linking containers
2015-03-05 12:18:04 -08:00
Fred Lifton
e4a90897e1 Merge pull request #11151 from chenhanxiao/See-also-export-import-save-load
docs: add See Also for description of export/import and save/load
2015-03-05 10:35:37 -08:00
Doug Davis
3c9425d40d Add some text about env vars when linking containers
In particular, the security implications.

Closes #5169

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-03-05 09:39:10 -08:00
Phil Estes
9057ca2541 Don't test resolv.conf updater on overlay filesystem
The overlay filesystem does not support inotify at this time. The
resolv.conf updater test was passing on overlay-based Jenkins because of
a fluke--because it was DIND, /etc/resolv.conf on the "host" was really
a bind-mounted resolv.conf from the outer container, which means a watch
directly on that file worked as it was not overlay backed.  The new test
(from #10703) unmounts the bind-mounted copy to test create and modify
code-paths, which caused us to hit the issue.

This PR also adds a note to the docs about the lack of auto-update when
using the overlay storage driver.

See https://lkml.org/lkml/2012/2/28/223 for more info on inotify and
overlay.

Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com> (github: estesp)
2015-03-05 00:22:01 -05:00
Chen Hanxiao
cbb149f52f docs: add See Also for description of export/import and save/load
make them reference to each other.

Signed-off-by: Chen Hanxiao <chenhanxiao@cn.fujitsu.com>
2015-03-04 20:21:38 -05:00
Sebastiaan van Stijn
8833779ae0 Docs: add restart-policies to 'Run reference'
This moves some information on restart-policies from
the "command line" page to "run reference".

Also fixes some minor typos and adds a "NOTE"
about --rm and --restart not allowed to be combined.

Also removes inline CSS styles from tables,
which will be styled by the stylesheet, and fixes
some minor MarkDown errors (`<` -> &lt;)

depends on https://github.com/docker/docs-base/pull/1

resolves #11069

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2015-03-05 01:13:53 +01:00
Jessie Frazelle
7b3ffd5cc0 Merge pull request #10586 from resouer/10532-fix-cors-hardcode
Fix 10532 to change --api-enable-cors to string.
2015-03-04 18:42:20 +00:00
Jessie Frazelle
4bccf278bd Merge pull request #11046 from bfirsh/rename-fig-to-compose
Rename fig to compose
2015-03-04 08:39:01 -08:00
Ben Firshman
a6824ea7f2 Rename fig to compose
It's now at https://github.com/docker/compose

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
2015-03-04 16:35:56 +00:00
Jessie Frazelle
ffc755ac14 Merge pull request #11134 from duglin/CheckMultiLineHelp
Fix 'docker ps --help' so the options don't span more than one line
2015-03-04 05:53:47 -08:00
Jessie Frazelle
df7ba57f5f Merge pull request #9437 from cpuguy83/set_rlimits_in_container
Allow setting ulimits for containers
2015-03-04 04:00:17 -08:00
Jessie Frazelle
beea697be3 Merge pull request #10858 from duglin/10807-MixedcaseDockerfile
Support dockerfile and Dockerfile
2015-03-04 03:52:49 -08:00
moxiegirl
98630b2ef6 Merge pull request #11051 from bdehamer/add-registry-api-client-library
Add reference to docker-reg-client
2015-03-03 20:41:42 -08:00
Doug Davis
15924f2385 Support dockerfile and Dockerfile
Closes #10807

Adds support for `dockerfile` ONLY when `Dockerfile` can't be found.
If we're building from a Dockerfile via stdin/URL then always download
it a `Dockerfile` and ignore the -f flag.

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-03-03 18:38:50 -08:00
Fred Lifton
5929f401fc Merge pull request #11091 from chenhanxiao/See-also-login-start
docs: add See Also for description of login/logout and start/stop
2015-03-03 14:49:59 -08:00
Sven Dowideit
93c82360a6 Notes should be indented
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-03-03 13:58:35 -08:00
Doug Davis
5595da2bde Fix 'docker ps --help' so the options don't span more than one line
and add a testcase to catch this in the future.

While in there I also:
- removed extra periods from the few options that had them (new test)
- made the --filter option consistent across all command

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-03-03 10:02:23 -08:00
resouer
dc0a6c1f5e Rebase & update api doc v1.18 instead
Signed-off-by: harry zhang <resouer@163.com>
2015-03-03 12:32:17 +08:00
resouer
f3dd2db4ff Add cors header flag and leave boolean flag not changed
Deprecate api-enable-cors

Update docs & man files

Signed-off-by: harry zhang <resouer@163.com>
2015-03-03 11:21:19 +08:00
moxiegirl
6bbf5c3e99 Merge pull request #11060 from dmitrygusev/docs-improvements
Docs improvements typo fixes and consistency
2015-03-02 06:46:17 -08:00
Chen Hanxiao
41dc0e08d3 docs: add See Also for description of login/logout and start/stop
make them reference to each other.

Signed-off-by: Chen Hanxiao <chenhanxiao@cn.fujitsu.com>
2015-03-01 01:36:00 -05:00
Sebastiaan van Stijn
1d4b2524ec Fix incorrect https example in mac.md (carry of 11063)
The document referenced https but was using the http port. I changed the
examples from https to http.

Also, fyi, when I tried accessing https using the correct 443 port, it
did not work. I have not investigated why. Port 80 worked fine.

For me:
jay-mac:.ssh jay$ docker port web
80/tcp -> 0.0.0.0:49153
443/tcp -> 0.0.0.0:49154
jay-mac:.ssh jay$ boot2docker ip
192.168.59.103

works: http://192.168.59.103:49153/
fails: https://192.168.59.103:49154/

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2015-02-28 22:13:03 +01:00
Dmitry Gusev
39b3690ba1 Update cli.md
Use `-it` combination in example instead of `-ti`, because this is how it used everywhere in examples.

Update dockerfile_best-practices.md

Fix typo in command name

Signed-off-by: Dmitry Gusev <dmitry.gusev@gmail.com>
2015-02-27 23:18:32 +03:00
Jessie Frazelle
94553f1ba6 Merge pull request #10902 from estesp/10855-fix-add-host-doc
Correct --add-host documentation regarding host IP address retrieval
2015-02-26 17:25:01 -08:00
Brian DeHamer
4835430165 Add reference to docker-reg-client
Update the "Docker Remote API Client Libraries" documentation page to
include a reference to the Go-based docker-reg-client package.

Signed-off-by: Brian DeHamer <brian@dehamer.com>
2015-02-26 13:03:39 -08:00
Mary Anthony
02639c03b7 Smaller image
Signed-off-by: Mary Anthony <mary.anthony@docker.com>
2015-02-26 08:48:58 -08:00
Jessie Frazelle
9324cdac07 Merge pull request #10831 from MalteJ/ipv6-ndp-proxy
Adding IPv6 NDP Proxying documentation
2015-02-26 07:19:36 -08:00
Sven Dowideit
7646e3f957 Missed to added doc files
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-27 01:10:50 +10:00
Tibor Vass
7e2328b76e Merge pull request #10869 from SvenDowideit/extract-docs-base
Extract docs base
2015-02-25 23:16:46 -05:00
Sven Dowideit
6d4b0f5334 update the mkdocs.yml to add new docs
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-26 12:11:29 +10:00
James Turnbull
f8dbcdc599 Merge pull request #10940 from 1HLtd/master
docs/man/docker.1.md: spelling mistake fix
2015-02-25 20:45:46 -05:00
Sven Dowideit
0365e8c204 set the document meta-data for the orchestration docs to turn off the docker-version documentation dropdown, asit doesn't apply
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-26 11:41:39 +10:00
Sven Dowideit
ac47a87740 Manually place the orchestration docs into the menu
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-26 11:41:39 +10:00
Sven Dowideit
8d4459fffb Don't require Docker 1.5.0 for docker build -f docs/Dockerfile
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-26 11:41:39 +10:00
Sven Dowideit
3e84b9e56a Import docs from swarm, machine and compose repositories,
Also add the image spec from the code area to show we're building from the repo-root now

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-26 11:41:39 +10:00
Sven Dowideit
ab545aed4c Simplify the existing docs building by extracting the main Dockerfile into a docs/base Hub image
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-26 11:41:39 +10:00
Brian Goff
3f39050637 Allow setting ulimits for containers
Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2015-02-25 19:37:43 -05:00
Michael Crosby
9a2e58dd29 Merge pull request #10498 from ashahab-altiscale/9875-lxc-stats
Implements stats for lxc driver
2015-02-25 13:46:18 -08:00
Phil Estes
f8a146311d Correct --add-host documentation regarding host IP address retrieval
Fixes: 10855

The example was actually incorrect for many situations, and also, now
that we have IPv6 we should not that the example is for IPv4 and note
how to find IPv6 addresses.  Also, the device they want to connect to
could be the bridge, or main ethernet device, or some other device
name, so note that as well.

Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com> (github: estesp)
2015-02-25 09:56:58 -05:00
Dan Walsh
17abfc3ddc pass --change changes to the import job
Docker-DCO-1.1-Signed-off-by: Dan Walsh <dwalsh@redhat.com> (github: rhatdan)
2015-02-24 13:01:36 -05:00
Dan Walsh
5767548fa7 add docs for commit --change
Docker-DCO-1.1-Signed-off-by: Daniel, Dao Quang Minh <dqminh89@gmail.com> (github: dqminh)

Docker-DCO-1.1-Signed-off-by: Dan Walsh <dwalsh@redhat.com> (github: rhatdan)
2015-02-24 13:01:36 -05:00