Commit Graph

109 Commits

Author SHA1 Message Date
Marco Marra
43daee99e1 Update envvars.md
Replace underscores with hyphens in container names.
2022-03-29 09:41:08 +02:00
Usha Mandya
0a1c0aebd7 Merge pull request #14022 from Flyingmana/patch-1
add Deprecated warning to --log-level argument
2022-02-25 11:49:26 +00:00
Usha Mandya
87dbb07f2c Update the usage of docker-compose cli commands
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2022-01-28 12:45:52 +00:00
Jared Leach
b6b19516d0 Update build.md
This page has a large number of downvotes and I think it's because the confusion of docker-compose --build and docker-compose build --arg. It definitely confused me and made it appear that the instructions contained did not work.
2022-01-27 13:36:47 -08:00
Daniel Fahlke
d8816a5b90 add Deprecated warning to --log-level argument
see https://github.com/docker/compose-cli/issues/1891
2021-12-21 11:05:05 +01:00
Sebastiaan van Stijn
173d3c65f8 fix broken (anchor) links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-09-13 15:07:49 +02:00
Sebastiaan van Stijn
1583678203 Add missing code-hints, and minor markdown edits
- Add missing code-hints (console, yaml)
- Consistently add an empty line after code-blocks
- Combine some examples where the output and the command were
  put in separate blocks. With the "console" code-hint, this
  is no longer nescessary.
- fix indentation in cloud/ecs-integration.md, which caused the
  numbered-list to be interrupted.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-16 12:59:23 +02:00
Sebastiaan van Stijn
ac1be36710 compose/reference: use "console" for shell examples
This allows for easier copying of the commands, without selecting the
prompt.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-06 17:20:07 +02:00
Sebastiaan van Stijn
8563a00ad8 compose: move reference/overview page
This makes the compose command-line reference available at;

https://docs.docker.com/compose/reference/

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-19 10:54:04 +02:00
Sebastiaan van Stijn
91ac76ae80 compose: remove old "index" page in favor of "overview"
First step: remove the old "index" page, as it was not linked from the TOC, and
was serving the same purpose as the "overview" page.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-19 10:43:11 +02:00
Sebastiaan van Stijn
f4ed09424b move compose examples to the samples directory
Unifying all "examples" in this directory; some of these should still be
reviewed and/or removed in favor of examples from "awesome compose"

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-19 10:38:56 +02:00
Roman Anasal
ca88315234 Add documentation for Compose service profiles
Adds docs for the new service profiles feature introduced
in docker/compose#7930

Co-authored-by: Chris Crone <christopher.crone@docker.com>
2021-01-25 14:42:20 +01:00
Usha Mandya
8489de14df Merge pull request #11858 from thaJeztah/compose_native_build
Compose: add documentation on enabling/disabling native build
2021-01-20 15:46:35 +00:00
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
Sebastiaan van Stijn
027b9b6bcf Compose: add documentation on enabling/disabling native build
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-12-08 12:45:51 +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