Commit Graph

1666 Commits

Author SHA1 Message Date
Sebastiaan van Stijn
e22984f7d4 use Dockerfile "syntax" directive in examples
BuildKit allows using alternative Dockerfile syntaxes to introduce new features
without having to update Docker itself. The general recommendation is to always
specify a "syntax" directive in a Dockerfile, so that (if needed) older versions
of Docker can download the correct syntax to build the Dockerfile.

This updates our examples to include a syntax directive, to make users more familiar
with these directives, and to illustrate best-pracitces in our documentation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-20 10:19:12 +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
Usha Mandya
0af20e212b Merge pull request #12678 from aiordache/compose_1.29.1
Update release notes for docker-compose 1.29.1
2021-04-15 16:00:41 +01:00
Usha Mandya
023aced24e Fix a typo 2021-04-15 15:54:31 +01:00
Anca Iordache
02ca9a22f6 Update release notes for docker-compose 1.29.1
Signed-off-by: Anca Iordache <anca.iordache@docker.com>
2021-04-14 19:12:25 +02:00
Edgars Baduns
7b6f2d918a Clarify the source name of secrets and configs
The current wording of "name of the config as it exists in Docker" suggests that the real generated name is used, instead the "key" of `configs` object in the docker-compose file is used.

```yml
version: "3.5"

services:
  app:
    image: alpine
    configs:
      # documentation currently suggests this (the "name as in Docker")
      # this causes an error- undefined config "name-as-in-docker"
      - source: name-as-in-docker
        target: /config-with-name-as-in-docker.json

      # the correct source to use is the name (key) from this docker-compose file
      - source: name-as-in-file
        target: /config-with-name-as-in-file.json

configs:
  name-as-in-file:
    name: name-as-in-docker
    file: ./cfg.json
```
2021-04-13 19:28:07 +03:00
Ulysses Souza
ecfa80f583 Update compose-cli compatibility list
Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>
2021-04-09 09:54:35 -03:00
Anca Iordache
e28309aaa3 Release notes for docker-compose 1.29.0
Signed-off-by: Anca Iordache <anca.iordache@docker.com>
2021-04-06 23:13:32 +02:00
Usha Mandya
a255925773 Merge pull request #12542 from sobi3ch/patch-1
Update completion.md
2021-03-25 15:45:31 +00:00
Usha Mandya
dda97d0fe9 Minor style update 2021-03-25 15:29:17 +00:00
Anca Iordache
0effb9f46e Update release notes for docker-compose 1.28.6 (#12553)
* Release notes updates for docker-compose 1.28.6

Signed-off-by: Anca Iordache <anca.iordache@docker.com>

* Fixed a typo

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-03-23 21:46:12 +00:00
Anca Iordache
cc6762ecd3 Update docs on Compose environment files (#12514)
* Reorganize sections for variable substitution and document .env file path change for `1.28`

Signed-off-by: Anca Iordache <anca.iordache@docker.com>

* Minor style edits

* Minor style edits

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-03-23 21:42:08 +00:00
Stig124
830a0071ad Debugging the codeblock in the Linux install for Compose CLI (#12551)
* Fixed the codeblock in cli_command.md

* Add a prompt to ensure the command is selectable

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-03-23 21:37:57 +00:00
Piotr Sobieszczański
8b0e7fa79a Update completion.md
Reload your bash after installation
2021-03-22 11:43:13 +01:00
Usha Mandya
5be8260c40 Merge pull request #12461 from irlcatgirl/patch-1
Fix docker-compose database volume configuration
2021-03-18 15:04:33 +00:00
Usha Mandya
ddf8543d28 Fix comment from Chris and update a note format
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-03-16 13:41:11 +00:00
Usha Mandya
dacfbd27e3 Remove another warning on V1 file reference
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-03-16 11:29:19 +00:00
Usha Mandya
5c64b4230a Remove references to v1 from other topics
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-03-15 19:35:03 +00:00
Usha Mandya
55b4fb8f37 Remove Compose file v1 ref docs
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-03-15 19:15:17 +00:00
Ulysses Souza
13a616b29a Update project directory precedence
Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>
2021-03-10 11:15:40 -03:00
Usha Mandya
63c0c825c4 Merge pull request #12467 from usha-mandya/compose-update-patch
Minor wording update
2021-03-09 14:50:42 +00:00
Usha Mandya
7c23883e19 Update desktop version number
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-03-09 14:46:50 +00:00
Usha Mandya
f839daebff Merge pull request #12456 from JoshuaSchlichting/patch-1
Fixed networking.md malformed whitespace
2021-03-09 14:39:05 +00:00
Usha Mandya
2355e7f32c Merge pull request #12458 from StefanScherer/fix-django-ps-command
Django: Use docker ps to be in sync with the sample output
2021-03-09 14:30:52 +00:00
Usha Mandya
c3bc63edf1 Minor wording update
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-03-09 13:59:05 +00:00
Guillaume Tardif
fd6a291c0b Compose command doc (#12433)
* Compose in Docker CLI overview

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Add compatibility list page for compose command

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Apply suggestions from Usha

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

* Apply suggestions from Usha

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

* Latest update on compatibility list

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Add install instructions

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Suggestions by Marina

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Subsection for compose CLI Tech Preview

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-03-09 10:59:03 +00:00
Catgirl
66c659a3e7 Add db volume information in docker-compose.yml 2021-03-08 15:55:03 -05:00
Stefan Scherer
8d2f2b639f Django: Use docker ps to be in sync with the sample output
Signed-off-by: Stefan Scherer <stefan.scherer@docker.com>
2021-03-08 12:51:02 +01:00
Joshua Schlichting
11608ecb55 Fixed networking.md malformed whitespace
Adjusted what appeared to be malformed yaml whitespace in the 'Specify custom networks' section
2021-03-07 10:31:58 -05:00
Simon
5e78271505 TASK: Add codeblocks to code examples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-03-04 12:06:54 +01:00
Guillaume Tardif
5d4a84d638 Compose minor improvements (#12426)
* remove duplicate compose release notes in TOC

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Add link to awesome compose samples

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Minor style update

* Fix a typo

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-03-02 17:01:51 +00:00
Anca Iordache
cb2e2e6986 Update release notes for docker-compose 1.28.5 (#12401)
* Update release notes  for docker-compose 1.28.5

Signed-off-by: aiordache <anca.iordache@docker.com>

* Minor style updates

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-02-26 18:23:33 +00:00
Usha Mandya
99fd84490c Merge pull request #12326 from rfay/patch-1
Show the 3-part port syntax more clearly
2021-02-19 12:23:00 +00:00
Usha Mandya
e4d16ed579 Fixed heading 2021-02-19 09:41:35 +00:00
aiordache
df16fac8ab Release notes updates for docker-compose 1.28.4
Signed-off-by: aiordache <anca.iordache@docker.com>
2021-02-19 10:03:27 +01:00
Anca Iordache
1caceda0fe Release notes update for docker-compose 1.28.3 (#12349)
* Release notes update for docker-compose 1.28.3

Signed-off-by: aiordache <anca.iordache@docker.com>

* Minor style updates

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-02-18 10:55:28 +00:00
Usha Mandya
2d47fdfa53 Merge pull request #12334 from ulyssessouza/pip-deps-update
Update dependencies on install
2021-02-16 10:41:07 +00:00
Usha Mandya
0e8576d5c0 Updated the link to use relative path 2021-02-16 10:24:11 +00:00
Chris Crone
c6b0f82cb7 compose.gpu: Fix prerequisites link
Signed-off-by: Chris Crone <christopher.crone@docker.com>
2021-02-16 11:00:19 +01:00
Ulysses Souza
ad4f02e066 Update dependencies on install
Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>
2021-02-15 12:40:55 -03:00
Randy Fay
5b2b270b3b Show the 3-part port syntax more clearly
The 3-part (IP:HOSTPORT:CONTAINERPORT) syntax in `ports` has been there a long time, but isn't adequately described here.
2021-02-13 06:08:43 -07:00
Sebastiaan van Stijn
3e9b407952 Fix broken link in compose-file docs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-02-12 19:46:37 +01:00
Anca Iordache
008dfe496d Document GPU support in Docker Compose (#12315)
* Document GPU support in Docker Compose

Signed-off-by: aiordache <anca.iordache@docker.com>

* Update the note format

Added target=blank to enable external links to open in a new tab.

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-02-12 17:18:00 +00:00
Usha Mandya
6c15e5466f Add note on Compose file v1 deprecation
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-02-12 11:05:37 +00:00
Ulysses Souza
40af359350 Update pip install requirements
Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>
2021-02-08 12:55:24 -03:00
Usha Mandya
4b176c5cfc Fix Compose install tab display issue
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-02-04 16:33:47 +00:00
Roman Anasal
6c64eeca65 Fix long line wrapping on Compose service profiles page 2021-01-27 14:47:40 +01:00
Roman Anasal
927ea24b04 Fix broken link in Compose service profiles page
broken by unclean rebase of
ca88315234
2021-01-27 14:40:54 +01:00