be187bae64
use a temp directory to generate doc to be sure working tree is clean
...
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
2022-03-18 10:42:05 +01:00
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
bf26cbd498
contenairized documetation generation
...
add docs validation (using same process a BuildX project)
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
2022-03-18 10:42:05 +01:00
35ba6f68e5
generate reference api
...
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
2022-03-18 10:42:05 +01:00
c843d373de
restore TTY auto-detection using dockerCli.Out.IsTerminal
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2022-03-16 16:34:26 +01:00
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
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
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
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
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
fcff39631a
Add documentation for COMPOSE_IGNORE_ORPHANS
...
Signed-off-by: Zixuan James Li <359101898@qq.com>
2022-03-05 22:54:16 +01:00
981aea674d
bump buildx to 0.7.1
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2022-02-21 14:28:22 +01:00
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
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
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
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
fdc362bf55
[v2] docs: markdown and link fixes
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-09-13 21:54:26 +02:00
1c01e9d00f
[v2] docs: regenerate yaml docs
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-09-13 21:54:26 +02:00
1ae9b3cb5d
move compose-cli code into docker/compose/v2
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-08-31 19:09:19 +02:00
fcb91096b8
remove all references to cli from compose.v2 cmd package
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-08-31 15:41:20 +02:00
1754282871
Fix typo
...
Signed-off-by: Omer An <csioan@nus.edu.sg>
2021-08-11 12:09:23 +08:00
c3db7909ad
Fix typo
...
Signed-off-by: iibrahimli <imranibrahimli98@gmail.com>
2021-08-09 14:54:14 +04:00
90a879fa3f
Fix references to docker-compose command
...
Signed-off-by: Manuel Grabowski <git@manuelgrabowski.de>
2021-06-28 16:45:44 +02:00
e2ea24ceb7
move compose-plugin commands under /cmd
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-06-15 15:52:48 +02:00
abbba74b27
update reference docs
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-06-08 09:39:49 +02:00
d61e62563e
Update compose docs
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2021-05-05 17:37:08 +02:00
ebbe86f18d
Merge pull request #1632 from rosven/documentation_fixes
...
fix documentation errors
2021-05-04 12:35:27 +02:00
f92c1ebb3e
fix documentation errors
...
Signed-off-by: Robin Svensson <euleriancycle@gmail.com>
2021-05-04 11:18:58 +02:00
ad42fc6c4d
Merge pull request #1578 from rjruizes/patch-1
...
fix typo in ecs-architecture.md
2021-04-23 11:02:00 +02:00
d8aa00a766
wrap compose cobra command to set exitcode according to metrics status
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-04-22 17:51:29 +02:00
0bdad7e551
pass compose.Service to cobra commands, dependency-injection style
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-04-22 17:50:56 +02:00
39b70e56ee
fix typo in ecs-architecture.md
...
Signed-off-by: Roman Ruiz-Esparza <rjruizes@ncsu.edu>
2021-04-22 11:10:35 -04:00
e0344ea7b4
Merge pull request #1415 from ulyssessouza/add-restart
...
Add restart command
2021-03-19 15:04:57 +01:00
3271801681
reference documentation
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-03-17 09:11:23 +01:00
2fdc3bad48
Add restart command
...
Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>
2021-03-16 02:02:36 -03:00
59d4382f3c
generate reference documentation
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-03-09 13:44:13 +01:00
43ecf005cb
Fix typos in docs/ecs-compose-features.md
2021-03-01 03:36:33 +00:00
aca816d5d6
Remove example backend.
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2021-01-19 11:29:48 +01:00
0ea97920c1
Move Context & context/store => api/context & api/context/store
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2021-01-15 16:31:59 +01:00
fef73b8af3
Parse reservation.devices for GPU requests
...
Signed-off-by: aiordache <anca.iordache@docker.com>
2021-01-07 16:27:15 +01:00
01fe40cd07
Add metadata for docs included in docs.docker.com (see https://github.com/docker/docker.github.io/pull/11865 )
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2021-01-04 15:22:48 +01:00
b91fbb934f
Fix typos
...
symetrical -> symmetrical
resoure -> resource
Signed-off-by: Hollow Man <hollowman@hollowman.ml>
2020-11-21 22:12:37 +08:00
38d2dd9b41
Merge pull request #907 from docker/aci_healthcheck_threshold
2020-11-17 13:35:01 +01:00
ebd81a2144
Merge pull request #895 from mreferre/main
...
Added IAM roles/policies examples and re-ordered some of the text
2020-11-17 11:59:29 +01:00
a6823c1092
Fix run health check doc
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-11-13 14:14:41 +01:00
bbaac2048c
Added IAM roles/policies examples and re-ordered some of the text
...
Signed-off-by: Massimo Re Ferre <massimo@it20.info>
2020-11-13 13:14:53 +01:00
12d7ab55d6
Merge pull request #903 from docker/ecs_mapping
2020-11-12 10:29:57 +01:00
5ee75c70c9
Document ECS supported compose attributes
...
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2020-11-12 10:24:12 +01:00
a0bd23ade9
Apply suggestions from code review
...
Co-authored-by: Chris Crone <christopher.crone@docker.com>
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-11-10 17:07:13 +01:00
ef5e78dc14
Updated health check docs
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-11-10 15:37:07 +01:00
f6509ac814
Add Healthchecks to ACI
...
Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>
2020-11-06 12:21:12 +01:00
498072452f
Remove sci-integration.md, all info moved to docs.docker.com
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-10-28 16:07:30 +01:00
e881c8c7c4
Apply suggestions from code review
...
Co-authored-by: Chris Crone <christopher.crone@docker.com>
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-10-28 14:35:40 +01:00
c1504d484f
Docs: adding docs README, moving ecs docs in docs folder, removing obsolete cli docs
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-10-28 10:44:42 +01:00
3fadf9068e
Small fixes in secrets docs
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-10-26 15:13:02 +01:00
853dd000d5
Add absolute path docs
...
Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>
2020-10-21 11:56:45 +02:00
27f7949782
Fix secrets docs on mounts
...
Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>
2020-10-21 10:52:11 +02:00
85c94a2f7f
Replace `docker run —envFile` with `docker run —env-file`
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-10-16 18:03:47 +02:00
869a0b8dd8
Apply suggestions from code review
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-10-16 17:01:52 +02:00
6a4d14e03d
Apply suggestions from code review
...
Co-authored-by: Chris Crone <christopher.crone@docker.com>
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-10-16 17:01:51 +02:00
e705d4915c
Adding documentation for single container run and `docker run flags` support in ACI
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-10-16 17:01:51 +02:00
a1a99786b0
Add log section for compose application, Add log limitation. Fix sections links
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-10-16 17:01:51 +02:00
9e69386d75
Add examples for several features
...
Signed-off-by: aiordache <anca.iordache@docker.com>
2020-10-16 10:37:02 +02:00
45212c6e21
Squash all secrets in a single one
...
Also adds an e2e test
Signed-off-by: Ulysses Souza <ulyssessouza@gmail.com>
2020-10-12 14:17:37 +02:00
808715d740
Adding secrets details
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-10-08 14:58:08 +02:00
c3983eea78
More changes from feedback
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-10-07 12:15:17 +02:00
e3b22ecd0b
Apply suggestions from code review
...
Co-authored-by: Chris Crone <christopher.crone@docker.com>
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-10-07 10:52:14 +02:00
c85a584046
Compose to ACI mapping documentation
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-10-05 14:48:05 +02:00
e10424e316
Normalize case of command and flag help
...
Signed-off-by: Amos Law <ahlaw.dev@gmail.com>
2020-10-03 20:43:18 -04:00
61d1ce17c5
Apply suggestions from code review
...
Co-authored-by: Chris Crone <christopher.crone@docker.com>
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-09-30 14:33:50 +02:00
3cebb4e58a
Additional fixes
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-09-30 12:39:29 +02:00
216159244f
Apply suggestions from code review
...
Co-authored-by: Chris Crone <christopher.crone@docker.com>
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-09-30 12:38:24 +02:00
cc2d610063
Apply suggestions from code review
...
Co-authored-by: Chris Crone <christopher.crone@docker.com>
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-09-29 17:51:43 +02:00
4b7e690758
ACI integration doc, listing main feature mapping and noticeable differences between local docker experience and ACI deployment.
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-09-29 16:24:27 +02:00
f72b2c4958
install: Fix Linux install instructions and script
...
Signed-off-by: Chris Crone <christopher.crone@docker.com>
2020-09-25 17:01:00 +02:00
198d830c55
docs: Update install doc
...
Signed-off-by: Chris Crone <christopher.crone@docker.com>
2020-09-24 21:14:53 +02:00
d154c41586
Update copyright
...
Signed-off-by: Chris Crone <christopher.crone@docker.com>
2020-09-22 12:13:00 +02:00
2ce4e98d88
In version, replace “Azure integration” version info by “Cloud integration”
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-09-11 17:29:40 +02:00
c3210a3973
Minor doc update on architecture
...
Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
2020-09-04 13:20:20 +02:00
e149fa29b9
docs: Add architecture diagram
...
Signed-off-by: Chris Crone <christopher.crone@docker.com>
2020-09-03 15:49:00 +02:00
95de770e87
Update or add license header which are not valid
...
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
2020-08-17 16:55:25 +02:00
f442eafe0b
Validate run restart option value. Default value is “none”, instead of “no”, this is more in line with compose values, and changes only the default so should not have too much impact on legacy usage.
2020-08-04 17:11:21 +02:00
6e6ed0648f
docs: Add Linux install instructions
...
Signed-off-by: Christopher Crone <christopher.crone@docker.com>
2020-06-24 17:51:36 +02:00
0de2522079
Renamed Moby backend to “local” backend. This will leave “moby” available for default type contexts
2020-06-15 12:20:03 +02:00
44712ab3c4
Move CLI UX docs into folder
...
Signed-off-by: Christopher Crone <christopher.crone@docker.com>
2020-05-14 13:29:11 +02:00
dac5558885
Initial CLI notes for context and run
...
Some things undecided still, and more commands needed.
Signed-off-by: Justin Cormack <justin.cormack@docker.com>
2020-05-14 13:27:43 +02:00
Guillaume Lours
Nicolas De Loof
Sebastiaan van Stijn
Zixuan James Li
Dan Bámíkíyá
Ömer An
Imran Ibrahimli
Manu
Guillaume Tardif
Robin Svensson
Guillaume Tardif
Roman Ruiz-Esparza
Ulysses Souza
Sylvain Bellemare
aiordache
Hollow Man
Massimo Re Ferre
Amos Law
Chris Crone
Justin Cormack