* 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>
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>
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>
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>
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
```
* 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>
* 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>
* 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>
Zane Dufour