Commit Graph

21 Commits

Author SHA1 Message Date
Allie Sadler
8be114620e ENGDOCS-1269 (#16936)
* ENGDOCS-1269

* feedback changes
2023-03-22 13:47:11 +00:00
Mike Bland
e04f063645 Add detailed project name requirements, mechanisms (#16915)
* Add detailed project name requirements, mechanisms

These changes reflect updated `docker compose` behavior regarding
acceptable project names.

compose-spec/compose-go#261 changed `docker compose` behavior to require
normalized project names as input when using `-p`. Previously `docker
compose` normalized project names automatically, leading to errors for
some users after the change landed in compose-spec/compose-go v1.2.5 and
docker/compose v2.5.1.

compose-spec/compose-spec#314 updated the compose spec, effectively
enforcing the same constraint for the `name:` config file property.
compose-spec/compose-go#362 added information to the error message
specifying the correct project name format. compose-spec/compose-go#364
added enforcement of the new project name requirements for all project
name mechanisms (`-p`, `name:`, `COMPOSE_PROJECT_NAME`, project dir,
working dir).

Local development URLs:
- http://localhost:4000/compose/reference/#use--p-to-specify-a-project-name
- http://localhost:4000/compose/environment-variables/envvars/#compose_project_name
- http://localhost:4000/engine/reference/commandline/compose/#use--p-to-specify-a-project-name

Production URLs:
- https://docs.docker.com/compose/reference/#use--p-to-specify-a-project-name
- https://docs.docker.com/compose/environment-variables/envvars/#compose_project_name
- https://docs.docker.com/engine/reference/commandline/compose/#use--p-to-specify-a-project-name

Signed-off-by: Mike Bland <mbland@acm.org>

* Revert _data/compose-cli/docker_compose.yaml

This reverts part of commit 9ce29a8aec.

As @glours noted in the review of #16915, this content comes from the
upstream docker/compose repo. He's opened docker/compose#10390 to apply
the update there instead.

Signed-off-by: Mike Bland <mbland@acm.org>

---------

Signed-off-by: Mike Bland <mbland@acm.org>
2023-03-22 08:59:55 +00:00
Allie Sadler
d165097c0d ENGDOCS-1166a (#16641) 2023-01-31 15:27:52 +00:00
Allie Sadler
3a09816b5c Engdocs 1067a (#16628)
* updated toc

* move env-file.md

* update env-file.md content

* move envvars-precedence.md

* change envvars-precedence content

* move envvars.md

* change content of envvars.md

* move and rename environment-variables.md

* change content for set-environment-variables.md

* fix links

* format fix
2023-01-30 11:27:59 +00:00
Stefan Scherer
f4b7461dd9 Move compose samples to awesome-compose repo (#16001)
Signed-off-by: Stefan Scherer <stefan.scherer@docker.com>

Signed-off-by: Stefan Scherer <stefan.scherer@docker.com>
2022-10-28 09:00:13 +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
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
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
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
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
Victoria Bialas
93bab5a66f Vnext compose (#2509)
* Adds documentation about the `--ignore-override` option

For PR https://github.com/docker/compose/pull/4543

When option `--ignore-override` is provided the `docker-compose.override.yml`
file, if it exists, will not be considered for any command. This option
has no effect when the `-f` option is used as that explicitly lists the
set of files to be considered.

Signed-off-by: Dennis Gove <dpgove@gmail.com>

* Compose 1.12.0 additions (#2472)

* Add mem_reservation to list of v2 options

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add dns_opt to v2 service configuration

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add pids_limit to service configurations

Signed-off-by: Joffrey F <joffrey@docker.com>

* Update list of options for docker-compose rm

Signed-off-by: Joffrey F <joffrey@docker.com>

* Update list of options for docker-compose config

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add --exit-code-from to docker-compose up documentation

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add --parallel to docker-compose pull reference

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add build-args to docker-compose build reference

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add --volume to docker-compose run reference

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add --project-directory to list of docker-compose options

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add reference docs for images command

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add documentation for COMPOSE_PATH_SEPARATOR

Signed-off-by: Joffrey F <joffrey@docker.com>

* Add documentation for cache_from option

Signed-off-by: Joffrey F <joffrey@docker.com>
2017-03-28 10:50:44 -07:00
Victoria Bialas
4a70dd4cb2 removed on-page topic menu from ref pages
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-02-17 18:02:58 -08:00
John Mulhausen
9abc9e9f41 Add documentation for new top command (#1534) (#1601)
Update command lists to include recent additions

Signed-off-by: Joffrey F <joffrey@docker.com>
2017-02-10 13:59:06 -08:00
Gaetan
2ea564166d fix type of keywords entry in frontmatter (in /compose/ dir) (#481)
keywords should be a string, not an array containing one string

Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2016-11-07 13:18:56 -08:00
John Mulhausen
558314bf56 Converges titles to imperative-form, front-matter based, and sentence-case (#438)
Multiple title fixes, consistency fixes, convergence into metadata-based titles.
2016-11-04 15:38:40 -07:00
Misty Stanley-Jones
0827ba283c Revert "fix frontmatter keywords values in compose/reference/ files" 2016-11-04 13:28:43 -07:00
Gaetan de Villele
bb4f3be02e fix frontmatter keywords values in compose/reference/ files
Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2016-11-03 10:13:21 -07:00
Misty Stanley-Jones
d53c6798c9 Convert TOML to YAML, tweaks to work with Jekyll 2016-09-29 17:16:03 -07:00
Misty Stanley-Jones
701f170a21 Move docker-hub docs to docker-hub subdirectory 2016-09-29 10:38:52 -07:00
Misty Stanley-Jones
7629f462d5 Moved compose docs to compose subdirectory 2016-09-28 14:52:24 -07:00