Commit Graph

24 Commits

Author SHA1 Message Date
David Winiecki f0b643fb26
Remove misleading "This is the newest version." from "Compose file version 3 reference" (#17108)
Compose file version 3 is not the newest version, the Compose Specification is.

This change is consistent with https://github.com/docker/docs/blob/main/compose/compose-file/index.md
2023-04-14 08:57:29 +01:00
Allie Sadler 8e16fb9373
keywords (#16691) 2023-02-08 14:42:21 +00:00
Allie Sadler d165097c0d
ENGDOCS-1166a (#16641) 2023-01-31 15:27:52 +00:00
Allie Sadler f979ff4405
ENGDOCS-1064 (#16443)
* ENGDOCS-1064

* fix broken links

* fix broken links

* Apply suggestions from code review

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-01-09 13:20:06 +00:00
Sebastiaan van Stijn a7b9985e00
engine: update reference docs (yaml), and fix anchor links
The updated version uses new anchors for flags, so updates are needed
elsewhere to update those anchors.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-09 10:29:43 +01:00
CrazyMax d775c8a6bf
build: multi-stage builds
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-15 13:37:37 +02:00
Justin Chadwell ad45d2d936 lint: tidy spaces inside spans 2022-07-28 11:27:10 +01:00
Usha Mandya 9403431ff7
Add Compose v2 reference (#14716)
* Add compose v2 reference
* Fix broken links
* Remove v1 compose reference files
* Remove Compose CLI completion

Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2022-06-21 13:12:05 +02:00
Dora Ribeiro d49af6a449
ENGDOCS 711 Revisited Compose Install Page (#14838)
Revisiting Compose installation
2022-06-02 18:10:37 +01:00
Ulysses Souza 8b6e052eee
Add inline comments section (#14507)
* Add inline comments section

Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>

* Update compose/compose-file/compose-file-v3.md

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2022-04-06 16:10:06 +01:00
PeterBParker eef12c06a4
Update compose-file-v3.md
corrected duplicate being verb
2022-03-30 11:55:05 -05:00
QuantumGhost d0e96b140a
Update compose-file-v3.md
The docs says `deploy` does not work for `docker-compose`, however, the `deploy.resources` do work.

ref: https://sourcegraph.com/github.com/docker/compose@v2/-/blob/pkg/compose/create.go?L511-514
2022-03-01 14:36:42 +08:00
Kayla Reopelle (she/her) b730e42610
Update ipv6 instructions for 3.x Compose files (#14168)
* Update ipv6 instructions for 3.x Compose files

IPv6 instructions on https://github.com/docker/compose/issues/4958, are compatible with Docker Compose 3.x

* Update code block to use yaml syntax

With @usha-mandya

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

* Update text about using IPv6

By @usha-mandya

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

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2022-02-04 14:03:19 +00: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
shokkunrf 3d64de6303 Fix a typo by adding a quote 2021-06-09 20:07:50 +09:00
Porter Darby c947472050
`condition` is supported for `depends_on`
Removed a statement about `condition` not being supported for `depends_on` in Version 3, as it is supported.
2021-04-24 22:05:45 -04:00
Zane Dufour 7e7645082e
Add --service-ports note to ports section (#12658)
* Add --service-ports note to ports section

## Description

Add note in `ports` section of file reference docs pointing to the `run` command's `--service-ports` flag

## Motivation

Spent quite a few hours spinning my wheels before I came across `run`'s `--service-ports` flag.

I'm struggling to find the issue where I found this, but the comment pointing to `--service-ports` had a lot of reacts, so this might be a relatively common 

## Things I'd still like to do

- [ ] link to the [`--service-ports` docs](https://github.com/docker/docker.github.io/blob/master/compose/reference/run.md) -- not sure how to do this
- [ ] clean up location of this note -- not sure if I've put the note in a good place -- we can shunt it to the bottom
- [ ] Duplicate for older versions

Thanks

* Minor style update

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-04-23 16:17:59 +01:00
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
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
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
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
aiordache 00119346fe Reference compose spec in compose file formats
Signed-off-by: aiordache <anca.iordache@docker.com>
2020-11-17 10:42:36 +01:00
aiordache d0f70fdbb9 Move v3 info to dedicated file
Signed-off-by: aiordache <anca.iordache@docker.com>
2020-11-17 10:39:45 +01:00