The documentation curently doesn't contain reference docs for the
unified (version-less) compose-file syntax, so for now replacing
all links to point to the v3 compose-file reference, which is still
present.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
An option's short form should not be used in descriptions since they are intentionally terse and as such does throw away the otherwise nice narrative provide by using the long form.
* Update docs on command help
This is change is based on the output of the script proposed by @smola
in: https://github.com/docker/docker.github.io/pull/11173
Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>
* Formatting updates
* Minor style update
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
Unfortunately, the only reliable way to create internal links
is to use relative links to other Markdown files. This does
match the way links on GitHub work, but makes it harder to
create these links.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Fix incorrect links in compose section
there's a bug causing wrapped links to not work, and replacing
some links to point to the .md file, so that IDE's can check
if the anchors are valid. Also replaced some links to point
to their new location.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* engine/swarm: update links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Fix various broken links
There's a bug in the "jekyll-relative-links" plugin that causes wrapped links to not work.
Also replacing some links to point to the .md file, so that IDE's can check if the anchors
are valid. Finally, replaced some links to point to their new locations, so that users don't
get redirected..
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Deploying stacks using the "Docker Application Bundle" (`.dab`) file
format was introduced as an experimental feature in Docker 1.13 /
17.03, but superseded by support for Docker Compose files in the CLI.
With no development being done on this feature, and no active use of the file
format, support for the DAB file format and the top-level `docker deploy` command
(hidden by default in 19.03), will be removed from the CLI, in favour of
`docker stack deploy` using compose files.
This patch removes documentation for the `docker-compose bundle` subcommand,
which was used to convert compose files into DAB files (and given the above,
will no longer be needed).
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Update docker-compose run --rm doc
To make the functionality added in
24ab933ebf
explicit in the docs
* Rewrite change as an addendum
Rewrite the change to the end of the page as an addendum to the description of the inner workings of the run command.
* Update example events JSON blob
The example JSON blob given doesn't match up with the values I experience when running `docker-compose events` myself, so I'm updating the documentation to save someone else some time.
* Add link to event types for convenience
* Reword lots of instances of 'will'
* Reword lots of instances of won't
* Reword lots of instances of we'll
* Eradicate you'll
* Eradicate 'be able to' type of phrases
* Eradicate 'unable to' type of phrases
* Eradicate 'has / have to' type of phrases
* Eradicate 'note that' type of phrases
* Eradicate 'in order to' type of phrases
* Redirect to official Chef and Puppet docs
* Eradicate gratuitous 'please'
* Reduce use of e.g.
* Reduce use of i.e.
* Reduce use of N.B.
* Get rid of 'sexagesimal' and correct some errors
After running "docker-compose up", the console shows a nice aggregated output of each container. When running this in detached mode, it's not clear how to later view this aggregated output again. Added a quick note on how this is done.
Sebastiaan van Stijn
Brennan Kinney
Rob Cowsill
George
Hélène Martin
Usha Mandya
Ulysses Souza
Usha Mandya
Alan Bondarchuk
Sebastiaan van Stijn
lena-larionova
Douglas Naphas
Peter Nagy
Akshit Grover
Adzim Zul Fahmi
Victoria Bialas
Maria Bermudez
Joffrey F
Alec Clews
Oren
CrimsonGlory
Benjamin White
Joffrey F
BANO.notIT
Misty Stanley-Jones
Magnus Klingenberg
Dan Nissenbaum
Logan Rakai
Wang Jie
locofocos
Lucile