Commit Graph

95 Commits

Author SHA1 Message Date
Sebastiaan van Stijn 3a794b3197
(temporarily) replace compose-file deep links to v3 docs
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>
2021-01-07 14:21:37 +01:00
Brennan Kinney 12cf9156fd
[fix]: Fix links to Compose File v3 reference [Docs: docker-compose restart] (#12026)
* Fix links to Compose File v3 reference

No longer `compose-file/index.md`, but `compose-file/compose-file-v3.md`.

* Update compose/reference/restart.md

Co-authored-by: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>
2021-01-06 14:51:45 +01:00
Rob Cowsill 16b8c5ecab
Explain Compose file relative path resolution
Explain relative path handling when multiple Compose files are specified
Mention use of the --project-directory option to override the path
2020-11-23 23:53:14 +00:00
George 00619263f4
Update up.md
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.
2020-10-31 23:40:22 -04:00
Hélène Martin e9e8e72304
Add note about anonymous volumes to docker-compose down (#11601)
* Add note about anonymous volumes

* Minor style update

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2020-10-28 16:38:31 +00:00
Usha Mandya e885a5aeaa Remove Docker Toolbox docs
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2020-10-20 18:05:36 +01:00
Ulysses Souza 411bf944cb
Update docs on command help (#11341)
* 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>
2020-09-08 11:57:19 +01:00
Usha Mandya 9031d87295
Update to use lowercase 2020-07-01 16:58:28 +01:00
Usha Mandya ff1578ba9d Update image push reference 2020-07-01 16:30:02 +01:00
Alan Bondarchuk ea11c50410
Add missing space (#11061) 2020-06-30 10:32:22 +01:00
Sebastiaan van Stijn 0f3caaca6a
compose: use relative markdown links
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>
2020-04-23 13:03:10 +02:00
Sebastiaan van Stijn 331554f4b3
Fix various links that were generating URLs with `.md` (#10548)
* 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>
2020-04-01 12:05:50 +01:00
Sebastiaan van Stijn d4ead1b120
Remove "bundle" subcommand and support for DAB files
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>
2020-01-22 15:34:58 +01:00
lena-larionova c620742964
turned deprecated notes into warnings (#9912)
Signed-off-by: Lena Larionova <lena.larionova@docker.com>
2019-11-19 15:24:22 -08:00
Douglas Naphas 3512d96117 Make minor grammar corrections (#9471) 2019-09-19 10:50:33 +01:00
Peter Nagy 83ad9157d6 Adds `--no-interpolate` to `docker-compose config` (#8409)
* Adds `--no-interpolate` to `docker-compose config`

As per https://github.com/docker/compose/pull/6368

* Fix typo
2019-09-06 11:58:27 +01:00
Sebastiaan van Stijn 7bbff2a2ee
Update compose-version to 1.24.0
https://github.com/docker/compose/releases/tag/1.24.0

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-03-28 20:53:39 +01:00
Usha Mandya 53b9498ab4
Revert "Compose: Update build docs, Add --quiet flag" 2019-03-13 17:49:32 +00:00
Akshit Grover 816fff73ae
Compose: Update build docs, Add --quiet flag 2019-03-07 19:46:32 +05:30
Adzim Zul Fahmi cd7f8e5246 fixing typo 2019-01-18 22:55:50 +07:00
Victoria Bialas fc805761fd re-wrote intro per review comments
Signed-off-by: Victoria Bialas <vicky@thoughtspot.com>
2018-12-25 17:39:59 -08:00
Victoria Bialas 8e9e0813ba related pages links for docs per suggestion in PR#3903
Signed-off-by: Victoria Bialas <vicky@thoughtspot.com>
2018-12-17 12:49:45 -08:00
Maria Bermudez 441c5b572b
Minor edits 2018-10-30 14:20:20 -07:00
Joffrey F 5a2e15dc04 Final Compose 1.23.0 updates
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-10-29 11:50:49 -07:00
Joffrey F d5b9b8bf0f Update release notes and reference for upcoming Compose 1.23.0 release
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-09-28 12:42:43 -07:00
Alec Clews bcaaad7c3c
Fix after review 2018-06-29 17:08:58 +10:00
Alec Clews 410d05cc4d
FIx broken link
Link to variable substitution was borked
2018-06-28 07:33:41 +10:00
Oren f490bd1752 Update docker-compose run --rm doc (#6803)
* 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.
2018-06-19 14:58:30 -07:00
CrimsonGlory e4eb29caa1 Update scale.md
Added a link to the old issue:
https://github.com/docker/compose/issues/5251
2018-05-03 16:58:36 -07:00
Joffrey F 636c626e49 New Compose CLI options
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-04-11 10:45:28 -07:00
Benjamin White e5e8051b59 Fix events JSON blob format (#6195)
* 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
2018-03-27 11:17:37 -07:00
Joffrey F 12757bf953 Compose 1.20.0 (#6266) 2018-03-20 11:23:36 -07:00
BANO.notIT eb8f177865 Fix docker compose to docker-compose (#6033) 2018-02-20 10:00:15 -08:00
Joffrey F c399e1e479 Docs for Compose 1.19.0 release (#5826)
* Docs for Compose 1.19.0 release

Signed-off-by: Joffrey F <joffrey@docker.com>
2018-02-07 13:18:54 -08:00
Misty Stanley-Jones a55ddf60a9
Move /engine/installation to /install (#5651)
* Move /engine/installation to /install

* Add Docker for IBM Cloud to the matrix
2018-01-26 10:29:14 -08:00
Magnus Klingenberg 3e7bd5d26f Fix typo in build.md (#5821) 2018-01-25 18:00:00 -08:00
Misty Stanley-Jones a4f5e30249
Various copyedits to reduce future tense, wordiness, and use of 'please' (#5788)
* 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
2018-01-25 17:37:23 -08:00
Dan Nissenbaum 2abb491a2d A frustrating typo (#5605) 2017-12-26 12:39:36 -08:00
Logan Rakai 1ff98b6467 Typo Correction (#5550) 2017-12-18 15:37:13 -08:00
Joffrey F 6e4339fc4d Update Compose docs to reflect changes in 1.18 release
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-12-18 15:11:03 -08:00
Misty Stanley-Jones a9314c7ec7 Document new features in Compose 1.17 (#5019) (#5021)
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-11-01 18:40:56 -07:00
Misty Stanley-Jones d8adc37e74 Revert "Document new features in Compose 1.17 (#5019) (#5021)" (#5038)
This reverts commit 52fe0df34b.
2017-10-18 16:07:20 -07:00
Misty Stanley-Jones 52fe0df34b Document new features in Compose 1.17 (#5019) (#5021)
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-10-17 21:17:28 -07:00
Wang Jie 0a96073f07 Update envvars.md (#4999) 2017-10-17 17:40:46 -07:00
Wang Jie 1fae282146 Update build.md (#4986) 2017-10-16 16:59:31 -07:00
locofocos 955d8b37f4 Update "docker-compose up" doc to explain logging (#4672)
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.
2017-10-16 16:09:52 -07:00
Joffrey F 0702f23aae Document Compose 1.16.0 additions (#4293)
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-08-31 15:52:18 -07:00
Joffrey F d03920a6e8 Rewrite exit codes paragraph (#4100)
Improved accuracy and fixed grammar

Signed-off-by: Joffrey F <joffrey@docker.com>
2017-08-08 14:15:50 -07:00
Joffrey F 181a0c6346 Compose 1.15.0 additions (#3950)
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-07-26 16:08:44 -07:00
Lucile df8c9c3e76 Add bash information about return codes. (#3547)
* Add bash information about return codes.

* Update shell return values after shin-'s comment
2017-06-14 09:55:59 -07:00