tyler.durden/compose
1
0
Fork 0
mirror of https://github.com/docker/compose.git synced 2025-04-08 17:05:13 +02:00
Code Issues Packages Projects Releases Wiki Activity
3,221 Commits 23 Branches 268 Tags
Commit Graph

23 Commits

Author SHA1 Message Date
Matthias Schoettle
6dbd6ffe11 fix typo in ssh option description 
Signed-off-by: Matthias Schoettle <git@mattsch.com>
 2022-03-31 10:14:13 -04:00
Guillaume Lours
ff73827a6f Add support of ssh authentications defined in compose file or via cli flags 
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
 2022-03-31 12:47:15 +02:00
Guillaume Lours
099715fb6f update run no-TTY flag description as auto-detected by default 
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
 2022-03-18 10:42:05 +01:00
Guillaume Lours
35ba6f68e5 generate reference api 
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
 2022-03-18 10:42:05 +01:00
Sebastiaan van Stijn
2d32d7450c ps: un-deprecate --filter, and enhance docs 
Compose currently only supports a single filter options on --filter,
for which reason the --status flag was added, which is more convenient
to use.

However, the `--filter` flag is common among various docker commands, and
it's possible that additional filters get added at some point (which may
be less "commonly" used, and not warrant a dedicated flag).

This PR removes the "deprecated" mention from the flag, to keep consistency
with other commands, but adds documentation to explain how they relate to
eachother.

Also added a short example for the `--format` flag.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2022-03-10 20:39:19 +01:00
Sebastiaan van Stijn
42710b7c43 docs: also generate "usage" in MarkDown files 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2022-03-09 14:40:35 +01:00
Sebastiaan van Stijn
b9b3a3d91f docs: update cli-docs-tool to v0.4.0 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2022-03-09 14:40:35 +01:00
Sebastiaan van Stijn
1d06741032 docs: fix trailing whitespace from markdown and regenerate 
Trailing whitespace in Markdown can force line-breaks, which doesn't seem to
be the intent on these;

    find . -type f -print0 | xargs -0 perl -pi -e 's/ +$//'

The trailing whitespace also can cause the YAML to go wonky (although the
cli-docs-tool now takes that into account), and caused the "examples" section
to be missed in the `docker compose pull` page (something we should fix in
the tool).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2022-03-09 14:40:35 +01:00
Sebastiaan van Stijn
35b790dcdf docs: fix "source" path for YAML generator, and regenerate 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2022-03-09 14:40:35 +01:00
Zixuan James Li
fcff39631a Add documentation for COMPOSE_IGNORE_ORPHANS 
Signed-off-by: Zixuan James Li <359101898@qq.com>
 2022-03-05 22:54:16 +01:00
Dan Bámíkíyá
336b825fdd Fix the typo in the corresponding Yaml file also 
Signed-off-by: Dan Bámíkíyá <dudeawesome732@gmail.com>
 2022-02-11 15:10:08 +01:00
Dan Bámíkíyá
213d9166dc Fix typo in reference/compose_up 
Signed-off-by: Dan Bámíkíyá <dudeawesome732@gmail.com>
 2022-02-11 15:08:33 +01:00
Sebastiaan van Stijn
0b896c69ce [v2] docs: fix stray backtick, and add compose_version yaml 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2021-09-14 07:49:29 +02:00
Sebastiaan van Stijn
3678deed14 [v2] use "docker/cli-docs-tool" to generate docs 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2021-09-13 21:54:26 +02:00
Sebastiaan van Stijn
fdc362bf55 [v2] docs: markdown and link fixes 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2021-09-13 21:54:26 +02:00
Sebastiaan van Stijn
1c01e9d00f [v2] docs: regenerate yaml docs 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2021-09-13 21:54:26 +02:00
Manu
90a879fa3f Fix references to docker-compose command 
Signed-off-by: Manuel Grabowski <git@manuelgrabowski.de>
 2021-06-28 16:45:44 +02:00
Nicolas De Loof
abbba74b27
update reference docs 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2021-06-08 09:39:49 +02:00
Guillaume Tardif
d61e62563e Update compose docs 
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
 2021-05-05 17:37:08 +02:00
Guillaume Tardif
e0344ea7b4
Merge pull request #1415 from ulyssessouza/add-restart 
Add restart command
 2021-03-19 15:04:57 +01:00
Nicolas De Loof
3271801681
reference documentation 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2021-03-17 09:11:23 +01:00
Ulysses Souza
2fdc3bad48 Add restart command 
Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>
 2021-03-16 02:02:36 -03:00
Nicolas De Loof
59d4382f3c
generate reference documentation 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2021-03-09 13:44:13 +01:00