Commit Graph

2591 Commits

Author SHA1 Message Date
O.S. Tezer 742b229408 Anglicanisms: Grammatical correction (pos. adj. apost.)
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
2017-06-02 00:06:30 +00:00
Sven Dowideit fe1e15dad4 Add the missing paren to the documentation for docker commit too
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
2017-06-02 00:06:30 +00:00
Sven Dowideit 6c8a3f798b 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)
2017-06-02 00:06:30 +00:00
Jezeniel Zapanta acbbeb39de Fix typo in the docs.
Fix a minor typographical error inside `run.md`.
2017-06-02 00:06:30 +00:00
Johan Euphrosine 56b7c20e46 api/client/build: allow tar as context for docker build -
Docker-DCO-1.1-Signed-off-by: Johan Euphrosine <proppy@google.com> (github: proppy)
2017-06-02 00:06:29 +00:00
Jonathan Boulle 6cc9c5bd42 be consistent in capitalization of Docker
Docker-DCO-1.1-Signed-off-by: Jonathan Boulle <jonathanboulle@gmail.com> (github: jonboulle)
2017-06-02 00:06:29 +00:00
David Gageot faeae5d7b7 Fix flag names 2017-06-02 00:06:29 +00:00
Paul Weaver 983c74aced Clean up some uses on 'an' in builder docs 2017-06-02 00:06:29 +00:00
Paul Weaver 0e185f84fb Fix minor typo and improve wording 2017-06-02 00:06:29 +00:00
Jan Pazdziora 2f908862e3 The docker run --dns does not resolve hostname and having hostname in resolv.conf does not work.
Docker-DCO-1.1-Signed-off-by: Jan Pazdziora <jpazdziora@redhat.com> (github: adelton)
2017-06-02 00:06:29 +00:00
Matthew Heon 45496ca4f1 Updated CLI documentation for docker pull with notes on specifying URL
Docker-DCO-1.1-Signed-off-by: Matthew Heon <mheon@redhat.com> (github: mheon)
2017-06-02 00:06:29 +00:00
Timothy 12be909528 Document the potential insecurity of --net host
Docker-DCO-1.1-Signed-off-by: Timothy <timothyhobbs@seznam.cz> (github: https://github.com/timthelion)
2017-06-02 00:06:29 +00:00
Solomon Hykes 5182afe46e Guillaume is busy full-time on his new business, and no longer available
as a maintainer.

Best of luck on your e-commerce business Guillaume, and thanks for all
the great contributions!

Docker-DCO-1.1-Signed-off-by: Solomon Hykes <solomon@docker.com> (github: shykes)
2017-06-02 00:06:29 +00:00
AJ Bowen 3a348dab9b Fix spelling and grammar errors; remove seemingly out-of-place words
Docker-DCO-1.1-Signed-off-by: AJ Bowen <aj@gandi.net> (github: soulshake)
2017-06-02 00:06:29 +00:00
Michael Prokop 3ca0eb652b Fix several typos
Docker-DCO-1.1-Signed-off-by: Michael Prokop <github@michael-prokop.at> (github: mika)
2017-06-02 00:06:29 +00:00
Álvaro Lázaro 1fa4c8b6b0 Fix typo 2017-06-02 00:06:29 +00:00
James Turnbull cf6acae39b Initial links
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2017-06-02 00:06:29 +00:00
Alexander Larsson 655fe238c5 Add --storage-opt graph driver option and pass through to driver
This lets you add storage specific options for the daemon.

Docker-DCO-1.1-Signed-off-by: Alexander Larsson <alexl@redhat.com> (github: alexlarsson)
2017-06-02 00:06:29 +00:00
Matthew Heon 8fc62f6ec3 Clarify effect of docker start on started container in CLI docs
This behavior changed from v0.9 to v0.10, so document it to prevent
any confusion.

Docker-DCO-1.1-Signed-off-by: Matthew Heon <mheon@redhat.com> (github: mheon)
2017-06-02 00:06:29 +00:00
James Turnbull 52488445a5 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)
2017-06-02 00:06:28 +00:00
James Turnbull faffc555ab Initial links for Docker Hub rename
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2017-06-02 00:06:28 +00:00
Chris Snow 1b06f322c5 Update builder.md 2017-06-02 00:06:28 +00:00
FLGMwt 47f850e550 Change 'Uploading context' wording
Docker-DCO-1.1-Signed-off-by: Ryan Stelly <ryan.stelly@live.com> (github: FLGMwt)
2017-06-02 00:06:28 +00:00
SvenDowideit 6fa1105051 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)
2017-06-02 00:06:28 +00:00
James Turnbull 99e2e8c292 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)
2017-06-02 00:06:28 +00:00
Vincent Batts 601a4809db filters: change untagged to dangling
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
2017-06-02 00:06:28 +00:00
Vincent Batts 3d4ff8babb images: fix markdown documentation
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
2017-06-02 00:06:28 +00:00
Vincent Batts e31bafdc7a images filter: remove the redundant inverted filter
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
2017-06-02 00:06:28 +00:00
Vincent Batts 1f269e43a4 filters, for images: docs
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
2017-06-02 00:06:28 +00:00
Vincent Batts 1d715defb8 filters, for images: start with untagged/tagged boolean
This is a new feature and flag. (replaces the suggestion of a flag for
--untagged images).
The concept is to have a syntax to filter. This begins with this
filtering for the 'images' subcommand, and at that only filtering for
whether images are untagged.
  example like: docker rmi $(docker images -q --filter 'untagged=true')

Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
2017-06-02 00:06:28 +00:00
James Turnbull 74a03f6def 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)
2017-06-02 00:06:28 +00:00
unclejack 5f1114d955 add support for COPY to docker build
This adds a COPY command to docker build which works like ADD, but is
only for local files and it doesn't extract files.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
2017-06-02 00:06:28 +00:00
Robin Speekenbrink 311bc46669 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)
2017-06-02 00:06:28 +00:00
Jérôme Petazzoni 62f9cc3dee Replace 'private' with 'self-hosted' in a couple of places
Docker-DCO-1.1-Signed-off-by: Jérôme Petazzoni <jerome@docker.com> (github: jpetazzo)
2017-06-02 00:06:28 +00:00
Johan Euphrosine 7f3fe5c01e docs/reference/builder: fix USER doc
Docker-DCO-1.1-Signed-off-by: Johan Euphrosine <proppy@google.com> (github: proppy)
2017-06-02 00:06:28 +00:00
unclejack 1c4a18d8bf 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)
2017-06-02 00:06:28 +00:00
Tibor Vass 8ee2a06dcf remove chmod 755: fixes #5941
Docker-DCO-1.1-Signed-off-by: Tibor Vass <teabee89@gmail.com> (github: tiborvass)
2017-06-02 00:06:28 +00:00
Jonathan McCrohan ef717d2e76 docs: cli.md; document docker version output
Commit 3cec63d56f9de6332aa3f33502695283d4feb054 changed the output of
docker version. Updating docs accordingly.

Docker-DCO-1.1-Signed-off-by: Jonathan McCrohan <jmccrohan@gmail.com> (github: jmccrohan)
2017-06-02 00:06:27 +00:00
Alexandr Morozov 2477e56243 Check uid ranges
Fixes #5647
Docker-DCO-1.1-Signed-off-by: Alexandr Morozov <lk4d4math@gmail.com> (github: LK4D4)
2017-06-02 00:06:27 +00:00
Steven Burgess 1f30fd9bdb Refactor b.tar -> busybox.tar
The file was saved as busybox.tar, but the ls commands named it b.tar.

Docker-DCO-1.1-Signed-off-by: Steven Burgess <steven.a.burgess@hotmail.com> (github: stevenburgess)
2017-06-02 00:06:27 +00:00
SvenDowideit 3901bf025d Update the cli.md docs with the output of the docker command
Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2017-06-02 00:06:27 +00:00
Joel Handwell 043c294859 changed deprecated option styles to supported ones
-name and -rm to --name and --rm
2017-06-02 00:06:27 +00:00
unclejack 4fe816bff2 docs: explain when RUN cache gets invalidated
This adds a few lines to the RUN Dockerfile docs to explain how to
bypass the RUN caching and how ADD can also invalidate the cache for
these instructions.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
2017-06-02 00:06:27 +00:00
SvenDowideit 6a55530c56 Add some more specific help for Dockerfile build contexts.
I've copy and pasted the error message so its googlable.

Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2017-06-02 00:06:27 +00:00
James Turnbull a8f2402b87 Minor fixups to the Docs README
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2017-06-02 00:06:27 +00:00
SvenDowideit 93ee19119b Add a mention of 80 column lines and reflow the document to hide the
evidence.

Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2017-06-02 00:06:27 +00:00
Michael Crosby 91667137f0 Add cpuset cpus support for docker
Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
2017-06-02 00:06:27 +00:00
Jilles Oldenbeuving 875f5489c4 Cleaned up Network settings overview 2017-06-02 00:06:27 +00:00
Max Shytikov 44841e361a Added value format description for VOLUME instruction
In the documentation was not mentioned explicitly that VOLUME value
shoud be a valid JSON array. Because of this I spent time to discovering
the problem with my image where I put `VOLUME ['/data']` (with single quotes).
The `['/data']` mount point was parsed and mounted whole as a string without
any errors and warnings.

Docker-DCO-1.1-Signed-off-by: Max Shytikov <mshytikov@gmail.com> (github: mshytikov)
2017-06-02 00:06:27 +00:00
Mason Malone 1af0c1584d Fix link to daemon/execdriver/lxc/lxc_template.go 2017-06-02 00:06:27 +00:00
Sven Dowideit cbdde9c15a update the docs to reflect the nice \n handling
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:27 +00:00
Sven Dowideit 35c4f1426e 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)
2017-06-02 00:06:27 +00:00
Bryan Murphy 2ff41c5365 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)
2017-06-02 00:06:27 +00:00
Michael Crosby 4e22cf681e Add docs for --net flag
Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
2017-06-02 00:06:27 +00:00
Sven Dowideit 0137184cb6 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)
2017-06-02 00:06:27 +00:00
Felix Rabe df1d6ee946 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)
2017-06-02 00:06:27 +00:00
Felix Rabe 4cf7b28b9a run.md: Close braces
Docker-DCO-1.1-Signed-off-by: Felix Rabe <felix@rabe.io> (github: felixrabe)
2017-06-02 00:06:26 +00:00
Felix Rabe 2d514f7543 cli.md: sudo at the right place
Docker-DCO-1.1-Signed-off-by: Felix Rabe <felix@rabe.io> (github: felixrabe)
2017-06-02 00:06:26 +00:00
Felix Rabe e134bb174e cli.md: Fix up Markdown formatting by adding one ` 2017-06-02 00:06:26 +00:00
Felix Rabe a3595e6a6e run.md: Convert some backticks to apo's 2017-06-02 00:06:26 +00:00
Felix Rabe 12d91c5137 cli.md: Add space 2017-06-02 00:06:26 +00:00
Felix Rabe c617aa0ea7 cli.md: Add another sudo 2017-06-02 00:06:26 +00:00
O.S.Tezer b8073c74a7 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)
2017-06-02 00:06:26 +00:00
Alexandr Morozov 381334d3d2 Timestamps for docker logs.
Fixes #1165
Docker-DCO-1.1-Signed-off-by: Alexandr Morozov <lk4d4math@gmail.com> (github: LK4D4)
2017-06-02 00:06:26 +00:00
Sven Dowideit 15fb9e2087 remove rst/sphinx documentation
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:26 +00:00
Michael Crosby 4d694e02eb Add cli flag to docs for selinux support
Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
2017-06-02 00:06:26 +00:00
James Turnbull cb003686e4 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)
2017-06-02 00:06:26 +00:00
James Turnbull d5b9bea76f Replaced all double backticks in README with singles
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2017-06-02 00:06:26 +00:00
James Turnbull 1e3f899705 Updated Docs README
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2017-06-02 00:06:26 +00:00
Sven Dowideit 53eedfc835 add a reference to multiple -H options, and update the other example of -H option
and copy changes to the cli.md file

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:26 +00:00
Mike MacCana da8e2310c6 - unix://path/to/socket should read unix:///path/to/socket like the rest of the documentation (a slash was missing)
- Mention that [] options may be specified multiple times on the Usage page

Docker-DCO-1.1-Signed-off-by: Mike MacCana <mike.maccana@gmail.com> (github: mikemaccana)

Docker-DCO-1.1-Signed-off-by: Mike MacCana <mike.maccana@gmail.com> (github: SvenDowideit)
2017-06-02 00:06:26 +00:00
Sven Dowideit ecc2740a94 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)
2017-06-02 00:06:26 +00:00
O.S.Tezer 148a2be878 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)
2017-06-02 00:06:26 +00:00
O.S.Tezer 149437ff87 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)
2017-06-02 00:06:26 +00:00
O.S.Tezer 34628fa8a4 Mark notes and warnings, fix broken link renderings within.
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
2017-06-02 00:06:26 +00:00
James Turnbull 57acc3cd5d Fixed #5283 - literal leftover from cutover
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2017-06-02 00:06:26 +00:00
O.S.Tezer 35710efce1 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)
2017-06-02 00:06:25 +00:00
Sven Dowideit 742c981b37 simplify the docs branch process for now
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:25 +00:00
Sven Dowideit 88a30886e5 now, with shiney markdown
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:25 +00:00
Sven Dowideit d39c8aea47 move the documentation to markdown
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: )
2017-06-02 00:06:25 +00:00
Isabel Jimenez b002e5ff8e Adding timestamp end to events endpoint. Modifying api docs.
Docker-DCO-1.1-Signed-off-by: Isabel Jimenez <contact@isabeljimenez.com> (github: jimenez)
2017-06-02 00:06:25 +00:00
Sven Dowideit 0f4461a8b2 add some more text to the cli docs
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:25 +00:00
Solomon Hykes 8777b52219 Early deprecation warning for 'docker commit --run'
Warn users of the planned deprecation of 'docker commit --run', and hide
it from the docs and usage message. The option continues to work.

Note that an alternative to 'commit --run' is being implemented but is
not yet available. We are printing the warning anyway because on
the basis that it never hurts to give more advance warning.

The 'commit --run' flag is a leftover from the very early days of Docker,
and has several problems:

1) It is very user unfriendly. You have to pass a literal json dict
which is poorly documented and changes regularly (see PortSpecs vs
ExposedPorts). The merge behavior is not clear and also changes
regularly. it's not possible to unset a value.

2) It overlaps with the Dockerfile syntax. There are 2 ways to set
a default command, expose a port or change an env variable. Some
things can be done in a Dockerfile but not in --run. Some things
can be done in --run but not in a Dockerfile. It would be better
to push a single syntax, allow using it both in a file and via
the command line, and make improvements in a single place.

3) It exposes data structures which should not be publicly exposed.
There are several planned improvements to Docker which require moving
around the content and schema of the various Config, Image and Container
structures. The less of those we expose in public interfaces, the easier
it is to move things around without a reverse compatibility nightmare.

Docker-DCO-1.1-Signed-off-by: Solomon Hykes <solomon@docker.com> (github: shykes)
2017-06-02 00:06:25 +00:00
Sven Dowideit 5717858626 use the docs sidebar to be the TOC means that level 2 headings are the most important
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:25 +00:00
Sven Dowideit df48712193 intermediate image layers are used for more than the build
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:25 +00:00
Solomon Hykes a9ae270842 Deprecate 'docker insert'
'docker insert' is an old command which predates 'docker build'. We no
longer recommend using it, it is not actively maintained, and can be
replaced with the combination of 'docker build' and 'ADD'.

This removes the command from usage and documentation, and prints a
warning when it is called.

The command still works but it will be removed in a future version.

Docker-DCO-1.1-Signed-off-by: Solomon Hykes <solomon@docker.com> (github: shykes)
2017-06-02 00:06:25 +00:00
Solomon Hykes 3a5697d52a Deprecate 'docker images --tree' and 'docker images --viz'
* The commands are no longer listed or documented.
* The commands still work but print a deprecation warning.
* The commands should be removed in a future version.

Docker-DCO-1.1-Signed-off-by: Solomon Hykes <solomon@docker.com> (github: shykes)
2017-06-02 00:06:25 +00:00
unclejack 8cf995efcf docs: explain what docker run -a does
This adds a bit of documentation for the `-a` flag for docker run.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
2017-06-02 00:06:25 +00:00
Guillaume J. Charmes bf4255afd0 Update docs. Make PULL up to date, remove deprecated falg and update PUSH
Docker-DCO-1.1-Signed-off-by: Guillaume J. Charmes <guillaume@charmes.net> (github: creack)
2017-06-02 00:06:25 +00:00
Vincent Batts 40f100517d --env-file: simple line-delimited
match dock functionality, and not try to achieve shell-sourcing compatibility

Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
2017-06-02 00:06:24 +00:00
Vincent Batts 552c1d2899 env-file: update functionality and docs
Multiple flags allowed. Order prescribed. Examples provided. Multiline
accounted for.

Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
2017-06-02 00:06:24 +00:00
Vincent Batts 46d697f30b Fixing doc references to --env-file
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
2017-06-02 00:06:24 +00:00
Vincent Batts 39880a5829 --env-file instead of --envfile
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
2017-06-02 00:06:24 +00:00
Vincent Batts f29511550b support for `docker run` environment variables file
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
2017-06-02 00:06:24 +00:00
Jason Plum 1c21055985 Fix daemon's documentation for -bip flag 2017-06-02 00:06:24 +00:00
Justin Simonelis 3d29e3bf8e typo fix 2017-06-02 00:06:24 +00:00
Vincent Batts bdebc378c9 docker load: added example of a multiple tag image
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
2017-06-02 00:06:24 +00:00
Vincent Batts c7e8b69f3f docker load: doc clarification
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
2017-06-02 00:06:24 +00:00
Vincent Batts de4aba1b65 docker load: add --input flag
for those that do not care to read from redirected stdin

Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
2017-06-02 00:06:24 +00:00
Sven Dowideit 5fdc8456ca I'm not looking forward to documenting cli arguments that may or may not show depending on what plugins / drviers you choose
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:24 +00:00
Vincent Batts dd1f12fe6c docker save: add and improve docs
add usage examples for `docker save ...`

Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
2017-06-02 00:06:24 +00:00
Michael Crosby ea3cd0f065 Revert "Disable automatic killing of containers when docker stop fails"
This reverts commit 8b5cf51d600dc4f3611cf063c52cf3448e7b01e5.

Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
2017-06-02 00:06:24 +00:00
Daniel Norberg e12226771d fix typo in documentation
Docker-DCO-1.1-Signed-off-by: Daniel Norberg <daniel.norberg@gmail.com> (github: danielnorberg)
2017-06-02 00:06:24 +00:00
Daniel Norberg ac0787dbab configurable dns search domains
Add a --dns-search parameter and a DnsSearch
configuration field for specifying dns search
domains.

Docker-DCO-1.1-Signed-off-by: Daniel Norberg <daniel.norberg@gmail.com> (github: danielnorberg)
2017-06-02 00:06:24 +00:00
Johannes 'fish' Ziemke f07cb7c233 Add authenticated TLS support for API
Docker-DCO-1.1-Signed-off-by: Johannes 'fish' Ziemke <github@freigeist.org> (github: discordianfish)
2017-06-02 00:06:23 +00:00
Tianon Gravi dfd2d9f1ea Add some documentation about relative WORKDIR values
Docker-DCO-1.1-Signed-off-by: Andrew Page <admwiggin@gmail.com> (github: tianon)
2017-06-02 00:06:23 +00:00
Michael Crosby ec1254275d Add image size to history docs
Fixes #3147
Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
2017-06-02 00:06:23 +00:00
LK4D4 41429fd727 Using names in docker ps --since-id/--before-id, resolves #3565
Also renames --since-id/--before-id to --since/--before and add errors
on non-existent containers.
Docker-DCO-1.1-Signed-off-by: Alexandr Morozov <lk4d4math@gmail.com> (github: LK4D4)
2017-06-02 00:06:23 +00:00
Brian Goff d45a91a56b Disable automatic killing of containers when docker stop fails
Docker-DCO-1.1-Signed-off-by: Brian Goff <cpuguy83@gmail.com> (github: cpuguy83)
2017-06-02 00:06:23 +00:00
Victor Vieux e4111339bb Add missing client doc
Docker-DCO-1.1-Signed-off-by: Victor Vieux <victor.vieux@docker.com> (github: vieux)
2017-06-02 00:06:23 +00:00
Victor Vieux 2f33a8e6bd move git clone from daemon to client
Docker-DCO-1.1-Signed-off-by: Victor Vieux <victor.vieux@docker.com> (github: vieux)

add a little doc
2017-06-02 00:06:23 +00:00
Tianon Gravi 974b760644 Fix sphinx header underline warnings I introduced...
Docker-DCO-1.1-Signed-off-by: Andrew Page <admwiggin@gmail.com> (github: tianon)
2017-06-02 00:06:23 +00:00
Tianon Gravi 6f6214866a 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)
2017-06-02 00:06:23 +00:00
Ken ICHIKAWA fb3a8f17c3 Add missing options -t and -v to images subcommand doc
Docker-DCO-1.1-Signed-off-by: Ken ICHIKAWA <ichikawa.ken@jp.fujitsu.com> (github: ichik1)
2017-06-02 00:06:23 +00:00
Ken ICHIKAWA cdd5e423aa Remove duplicated description of --mtu
commit baa70e975186bb0ee8a4b16b9374cb6e794f8975 duplicates
the description of --mtu.
This patch removes the duplicated description.

Docker-DCO-1.1-Signed-off-by: Ken ICHIKAWA <ichikawa.ken@jp.fujitsu.com> (github: ichik1)
2017-06-02 00:06:23 +00:00
Wes Morgan 60cd5ec3b7 merge existing config when committing
Fixes #1141

Docker-DCO-1.1-Signed-off-by: Wes Morgan <cap10morgan@gmail.com> (github: cap10morgan)
2017-06-02 00:06:23 +00:00
Ken ICHIKAWA bb64095f4b Update daemon docs and help messages for --iptables and --ip-forward
Fix docs and help messages of --iptables and --ip-forward to describe the true case behaviour

Docker-DCO-1.1-Signed-off-by: Ken ICHIKAWA <ichikawa.ken@jp.fujitsu.com> (github: ichik1)
2017-06-02 00:06:23 +00:00
Scott Collier 771de961bf Removing HEAD tag from last commit
Docker-DCO-1.1-Signed-off-by: Scott Collier <emailscottcollier@gmail.com> (github: scollier)
2017-06-02 00:06:23 +00:00
Scott Collier f07bd8fb8a Adding CLI options to the commandline reference documentation.
Fixing bad DCO sig

URLs of pages are:
http://docs.docker.io/en/latest/reference/commandline/cli/

Docker-DCO-1.1-Signed-off-by: Scott Collier <emailscottcollier@gmail.com> (github: scollier)
2017-06-02 00:06:23 +00:00
Scott Collier 9fbf050286 Adding the new options to the `docker ps` documentation.
URL of documentation page is: http://docs.docker.io/en/latest/reference/commandline/cli/#ps

Docker-DCO-1.1-Signed-off-by: Scott Collier <emailscottcollier@gmail.com> (github: scollier)

Adding the new options to the `docker ps` documentation.

URL of documentation page is: http://docs.docker.io/en/latest/reference/commandline/cli/#ps

Docker-DCO-1.1-Signed-off-by: Scott Collier <emailscottcollier@gmail.com> (github: scollier)

Adding CLI options to the commandline reference documentation.

URLs of pages are:
http://docs.docker.io/en/latest/reference/commandline/cli/

Docker-DCO-1.1-Signed-off-by: Scott Collier <emailscottcollier@gmail.com> (github: scollier)

changing indention

Docker-DCO-1.1-Signed-off-by: Scott Collier <emailscottcollier@gmail.com> (github: scollier)
2017-06-02 00:06:23 +00:00
Scott Collier f742182359 Adding options to `docker restart` documentation
URL of page is: http://docs.docker.io/en/latest/reference/commandline/cli/#restart

Docker-DCO-1.1-Signed-off-by: Scott Collier <emailscottcollier@gmail.com> (github: scollier)
2017-06-02 00:06:23 +00:00
Scott Collier 151dd6d3f1 Adding the new options to the `docker ps` documentation.
URL of documentation page is: http://docs.docker.io/en/latest/reference/commandline/cli/#ps

Docker-DCO-1.1-Signed-off-by: Scott Collier <emailscottcollier@gmail.com> (github: scollier)
2017-06-02 00:06:23 +00:00
Guillaume J. Charmes 939dd00e47 Update email + add self to pkg/signal
Docker-DCO-1.1-Signed-off-by: Guillaume J. Charmes <guillaume@charmes.net> (github: creack)
2017-06-02 00:06:23 +00:00
Tom Fotherby 5348fdca04 Correct Docker run --host param to --hostname 2017-06-02 00:06:22 +00:00
Brian Goff 1abc7e3c7c Add ability to force removal of running container via docker rm -f
Docker-DCO-1.1-Signed-off-by: Brian Goff <cpuguy83@gmail.com> (github: cpuguy83)
2017-06-02 00:06:22 +00:00
Evan Krall 920d1683e2 Create a -G option that specifies the group which unix sockets belong to.
Docker-DCO-1.1-Signed-off-by: Evan Krall <krall@yelp.com> (github: EvanKrall)
2017-06-02 00:06:22 +00:00
James Turnbull a625f00d0d Consistently capitalize CLI options
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2017-06-02 00:06:22 +00:00
Michael Crosby 86b133528c Update daemon docs for exec drivers
Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
2017-06-02 00:06:22 +00:00
unclejack 7bce027176 handle symlinks for Docker's root dir & TMPDIR
This removes the incomplete symlink handling from engine.go and it adds
it one place in docker.go.

It also enables handling symlinks for TMPDIR.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
2017-06-02 00:06:22 +00:00
ILYA Khlopotov 87b94808dc Support json output in --format flag of docker inspect
Docker-DCO-1.1-Signed-off-by: ILYA Khlopotov <ilya.khlopotov@gmail.com> (github: khia)
2017-06-02 00:06:22 +00:00
Sven Dowideit 0db1996a26 add a little bit mentioning commandline option combinations
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:22 +00:00
Sven Dowideit 29d73de168 one ponted out by lukaspustina, and one that I bet I added
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:22 +00:00
Victor Vieux 231c00296b add missing doc
Docker-DCO-1.1-Signed-off-by: Victor Vieux <victor.vieux@docker.com> (github: vieux)
2017-06-02 00:06:22 +00:00
Brian Goff 730417f46f make docker build -rm=true default #4292
Docker-DCO-1.1-Signed-off-by: Brian Goff <cpuguy83@gmail.com> (github: cpuguy83)
2017-06-02 00:06:22 +00:00
Vincent Batts 9d1894a44c execdriver flag for docker daemon
like the storage-driver flag, this implements a flag for choosing the
  execdriver to be used, defaulting to lxc.

Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
2017-06-02 00:06:21 +00:00
Brian Goff 92d8b836a7 Remove uneeded wording in Dockerfile format
Docker-DCO-1.1-Signed-off-by: Brian Goff <cpuguy83@gmail.com> (github: cpuguy83)
2017-06-02 00:06:21 +00:00
Danny Berger dcea86eb25 Drop -mtu from docs in favor of --mtu only
Docker-DCO-1.1-Signed-off-by: Danny Berger <dpb587@gmail.com> (github: dpb587)
2017-06-02 00:06:21 +00:00
Danny Berger 16e959358b Fix cli argument usage typo for docker --mtu
Docker-DCO-1.1-Signed-off-by: Danny Berger <dpb587@gmail.com> (github: dpb587)
2017-06-02 00:06:21 +00:00
unclejack a79fae655d forbid chained onbuild, from & maintainer triggers
This changes the way onbuild works:
- forbids the chaining of onbuild instructions
- forbids the use of `onbuild from`
- forbids the use of `onbuild maintainer`

It also makes docker throw errors when encountering such triggers when
executing the triggers during `FROM`.

Three tests have been added:
- ensure that chained onbuild (`onbuild onbuild`) is forbidden
- ensure that `onbuild from` is forbidden
- ensure that `onbuild maintainer` is forbidden

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
2017-06-02 00:06:21 +00:00
Sven Dowideit 0793ff9774 reinforce that docker build --rm is a good default to use
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:21 +00:00
Andy Rothfusz 2be94a6d55 update links
Docker-DCO-1.1-Signed-off-by: Andy Rothfusz <github@developersupport.net> (github: metalivedev)
2017-06-02 00:06:21 +00:00
Andy Rothfusz 2af848ac2c Update the documentation docs with new branch information.
Docker-DCO-1.1-Signed-off-by: Andy Rothfusz <github@developersupport.net> (github: metalivedev)
2017-06-02 00:06:21 +00:00
Brian Goff bdb4174a7f Add extra info regarding docker run funcationality
Docker-DCO-1.1-Signed-off-by: Brian Goff <cpuguy83@gmail.com> (github: cpuguy83)
2017-06-02 00:06:21 +00:00
Sven Dowideit 4e224b4218 my attempt to disentagle repository and registry (Issue #1439)
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:21 +00:00
Sven Dowideit 0bf10f83a1 add a little reenforcement to the help for docker build -q
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2017-06-02 00:06:21 +00:00
Song Gao 4e4c5547b8 Support submodules when building from a gh repo
Docker-DCO-1.1-Signed-off-by: Song Gao <song@gao.io> (github: songgao)
2017-06-02 00:06:21 +00:00
unclejack 0c427d6796 disallow tcp:// from defaulting to 127.0.0.1:4243
This stops docker from accepting tcp:// as a valid bind address.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
2017-06-02 00:06:21 +00:00
Dafydd Crosby bb10fef646 Fix RST formatting 2017-06-02 00:06:21 +00:00
Sven Dowideit ba6266c648 add a little more information about the docker run -P option
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2017-06-02 00:06:21 +00:00
Sven Dowideit 605f913fc5 point out that ENV DEBIAN_FRONTEND will persist, so its not recommended
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2017-06-02 00:06:21 +00:00
Sven Dowideit 808f83bc5c please, for the love of Docker, do. not. use. symlinks
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:21 +00:00
Sven Dowideit ff4a5b431b be a little more explicit about what WORKDIR does
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2017-06-02 00:06:21 +00:00
Solomon Hykes 8bef3842d7 New build instruction: ONBUILD defines a trigger to execute when extending an image with a new build
Docker-DCO-1.1-Signed-off-by: Solomon Hykes <solomon@docker.com> (github: shykes)
2017-06-02 00:06:20 +00:00
Johan Euphrosine 05c073b292 docs/cli: add mtu option
Docker-DCO-1.1-Signed-off-by: Johan Euphrosine <proppy@google.com> (github: google)
2017-06-02 00:06:20 +00:00
Sven Dowideit 3b5e659814 add a known issue for lxc-1.0.0.beta3 and beyond for removeal of lxc-kill see #3844
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:20 +00:00
Andy Rothfusz baded3bcc0 Address feedback from @jamtur01.
Docker-DCO-1.1-Signed-off-by: Andy Rothfusz <github@developersupport.net> (github: metalivedev)
2017-06-02 00:06:20 +00:00
Andy Rothfusz ef0eb78f58 Fix 2720 -- Expanded documentation for docker run.
Docker-DCO-1.1-Signed-off-by: Andy Rothfusz <github@developersupport.net> (github: metalivedev)
2017-06-02 00:06:20 +00:00
Brandon Philips f9e5fa6aeb fix(cli.rst): add missing underscores
As suggested by @metalivedev

Docker-DCO-1.1-Signed-off-by: Brandon Philips <brandon.philips@coreos.com> (github: philips)
2017-06-02 00:06:20 +00:00
Brandon Philips 27a2933df4 Allow fd:// like unix:// and tcp://
Somthing like 20605eb310f0b57bd06eea80ec63c5022fc83bde

Docker-DCO-1.1-Signed-off-by: Brandon Philips <brandon.philips@coreos.com> (github: philips)
2017-06-02 00:06:20 +00:00
Brandon Philips 43cea0e97c fix(docs): add Systemd in front of socket activation
Suggested by SvenDowideit.

Docker-DCO-1.1-Signed-off-by: Brandon Philips <brandon.philips@coreos.com> (github: philips)
2017-06-02 00:06:20 +00:00
Brandon Philips 8922f0314a docs: improve the socket activation cli docs
as suggested by SvenDowideit expand the docs to have more information on
socket activation.

Docker-DCO-1.1-Signed-off-by: Brandon Philips <brandon.philips@coreos.com> (github: philips)
2017-06-02 00:06:20 +00:00
Brandon Philips a25ce61e87 fix(docs): fixup based on changes in master
Docker-DCO-1.1-Signed-off-by: Brandon Philips <brandon.philips@coreos.com> (github: philips)
2017-06-02 00:06:20 +00:00
Sven Dowideit c046828392 talk about the new exec form of RUN (Closes #3723) implemented by #3558
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2017-06-02 00:06:20 +00:00
Sven Dowideit 5bfb9bf093 change the documentation only - It looks like we have a number of cmdline params to completely update from the code version
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2017-06-02 00:06:20 +00:00
Paul Lietar 9a20d94d97 Add a --signal option to the kill command to specify a signal.
Docker-DCO-1.1-Signed-off-by: Paul Lietar <paul@lietar.net> (github: plietar)
2017-06-02 00:06:20 +00:00
Maxime Petazzoni f0d44c8bc1 Documentation about automatic bind-mount dir creation
Docker-DCO-1.1-Signed-off-by: Maxime Petazzoni <max@signalfuse.com> (github: mpetazzoni)
2017-06-02 00:06:20 +00:00
Sven Dowideit 4e48cc274e add a little info about ghosts
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
2017-06-02 00:06:20 +00:00
Tianon Gravi d24c5c599d Switch `docker run --username` to `docker run --user` which is more accurate (while we can still do so without breaking anyone's scripts)
Docker-DCO-1.1-Signed-off-by: Andrew Page <admwiggin@gmail.com> (github: tianon)
2017-06-02 00:06:20 +00:00
Victor Vieux 33415ebe36 update commands.go
update docker.go

move to pkg

update docs

update name and copyright

change --sinceId to --since-id, update completion and docs

Docker-DCO-1.1-Signed-off-by: Victor Vieux <victor@docker.com> (github: vieux)
2017-06-02 00:06:19 +00:00
James Turnbull 98b39c91de Added Reference Manual
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2017-06-02 00:06:19 +00:00
Paul fb17f9fcab Mac OSX command for pip was incorrect 2017-06-02 00:06:19 +00:00
Sven Dowideit 2d576ea3b6 make docs is more consistent 2017-06-02 00:06:19 +00:00
Sven Dowideit 3091ba88fa change the policy wrt $ sudo docker to simplify auto-testing 2017-06-02 00:06:19 +00:00
John Feminella 01d4e98cc8 Corrects misspellings of 'Sphinx' 2017-06-02 00:06:19 +00:00
John Feminella b52c999103 Suggest users install dependencies by using requirements.txt, not manually 2017-06-02 00:06:19 +00:00
Sven Dowideit 23e91a6d7f add links to the Dockerfiles as canonical external requirements, add example of building and exposing the docs and simplify the Dockerfile for cacheability 2017-06-02 00:06:19 +00:00
Andy Rothfusz bed37d2204 Clean up level 3 headers. 2017-06-02 00:06:19 +00:00
Andy Rothfusz ce220ef43b Fix #1919 document how to edit and release docs. 2017-06-02 00:06:19 +00:00
Pascal Borreli 147b04ce2b Fixed typos 2017-06-02 00:06:19 +00:00
Thatcher Peskens 22ab3ddc8a Fixed some typo's and formatting issues in remote api documentation. 2017-06-02 00:06:19 +00:00
Thatcher 2216afb617 Some more improvements on the docs readme. Removed references to website. 2017-06-02 00:06:19 +00:00
Thatcher Peskens 9c5f4391e1 Updated docs README with instructions to preview the generated manfile, and where to get the one generated by sphinx. 2017-06-02 00:06:19 +00:00
Thatcher Peskens 77926c6033 Enabled the docs to generate manpages.
* changed conf.py to reference toctree.rst instead of index
* Added note to README to upgrade your sphinx to the latest version to prevent a bug with .. note:: blocks.
2017-06-02 00:06:19 +00:00
Daniel Gasienica 74428120af Make style consistent 2017-06-02 00:06:19 +00:00
Daniel Gasienica 3c035fa508 Add Mac OS X instructions for doc tools 2017-06-02 00:06:19 +00:00
Daniel Gasienica 99dfa4e7e8 Add `make server` command to preview docs 2017-06-02 00:06:18 +00:00
Thatcher Peskens 6d79cab514 Updated index to reflect new (short) 'engine' message (merged with solomon's new text), also moved around the layout a bit and fixed some small text errors. 2017-06-02 00:06:18 +00:00
Thatcher Peskens f4399fe403 Added code and color for 'note' and updated the hello world note. 2017-06-02 00:06:18 +00:00
Thatcher Peskens 8a39a45f05 Improved README 2017-06-02 00:06:18 +00:00
Thatcher Peskens 244477e27f Merge of docker-website into the docker documentation. 2017-06-02 00:06:18 +00:00
dhrp f35a9d8098 create README.md at this place for preview. 2017-06-02 00:06:18 +00:00