tyler.durden
/
compose
mirror of https://github.com/docker/compose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
4,655 Commits 25 Branches 262 Tags 66 MiB
Commit Graph

22 Commits

Author SHA1 Message Date
Piotr Dąbrowski e330f5905b
docs: unify no trailing dots in docstrings and help (#11301) 2024-02-14 14:02:37 -05:00
Nicolas De Loof 16c4241c0b log we don't expose service ports when --verbose 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-11-29 11:40:16 +01:00
Milas Bowman baea5a48f5 deps: bump docker/cli-docs-tool to v0.6.0 
Required re-running `make docs` to pick up changes.

Signed-off-by: Milas Bowman <milas.bowman@docker.com>
 2023-07-10 12:23:48 +02:00
aroramrinaal 3906a7a67c Updated documentation files for my contribution 
Ran 'make docs' to generate updated doc files from the reference.

Signed-off-by: aroramrinaal <aroramrinaal@gmail.com>
 2023-06-27 22:48:17 +02:00
Nicolas De Loof c61b8aa5ac introduce run --cap-add to run maintenance commands using service image 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
 2023-06-19 14:20:20 +02:00
Guillaume Lours 312f0d1d61 Update dry-run documentation 
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
 2023-05-15 09:39:46 +02:00
Matt Armand dadad01e63 Update docs programatically like you're supposed to 
Signed-off-by: Matt Armand <marmand68@gmail.com>
 2023-01-11 13:20:30 -05:00
Matt Armand 1adc9f54d5 fix docs yaml 
Signed-off-by: Matt Armand <marmand68@gmail.com>
 2023-01-11 12:24:15 -05:00
Matt Armand bd8e57447a Add remove-orphans functionality to run, because it recommends that in error messages 
Signed-off-by: Matt Armand <marmand68@gmail.com>
 2023-01-11 10:31:56 -05:00
Laura Brehm 6fe03e935e
Update docs 
Signed-off-by: Laura Brehm <laurabrehm@hey.com>
 2022-11-17 12:29:19 +01:00
Sebastiaan van Stijn 9db79856be
update usage strings for consistency 
This updates the format of various usage strings to be more consistent
with other parts of the CLI.

- Use `[OPTIONS]` to indicate where command-specific options should be added
- Use `[SERVICE...]` to indicate zero-or-more services
- Remove some usage strings for specific options (e.g. `-e NAME=VAL`), as that
  option is part of the already mentioned `[OPTIONS]` and we don't provide usage
  for each possible option that can be passed.
- Remove `[--]`, which (I think) was needed for the Python implementation, but is
  a general feature to stop processing flag-options.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2022-08-02 13:32:29 +02:00
Guillaume Lours 0e6adb2884
update cli-doc-tool and update the doc with this new version 
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
 2022-07-26 14:58:08 +02:00
Eric Freese d871cb98e5 Fix search/replace typo in --no-TTY documentation 
Commit abbba74b27 looks to have
accidentally replaced `pseudo-tty` with `pseudo-noTty` in several
places. In other places, it looks like it replaced `pseudo-tty` with
`pseudo-TTY`, so I used the uppercased version in these places as well.

For example, running version 2.3.3, I get this output:

```
% docker-compose run --help

...

Options:
  ...
  -T, --no-TTY                Disable pseudo-noTty allocation. By default docker compose run allocates a TTY
  ...
```

Signed-off-by: Eric Freese <ericdfreese@gmail.com>
 2022-04-04 19:06:03 +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 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 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
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
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
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