Commit Graph

70 Commits

Author SHA1 Message Date
Sebastiaan van Stijn de338473e1 compose-file: remove reference to custom init path (#8628)
* compose-file: remove reference to custom init path

This option was never functional, and was not intended
to be added to the "container create" API, so let's
remove it, because it has been removed in Docker 17.05,
and was broken in versions before that; see

- docker/docker-py#2309 Remove init_path from create
- moby/moby#32355 --init-path does not seem to work
- moby/moby#32470 remove --init-path from client

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* Update index.md
2019-04-12 19:04:12 +02:00
Sebastiaan van Stijn e295a6e6cb Use site parameter to use latest compose file versions in examples (#8630)
* Use site parameter to use latest compose file versions in examples

Make sure that examples use the latest version of the compose file
format, to encourage using the latest version, and to prevent
users from running into "not supported by this version" problems
when copy/pasting, and combining examples that use different
versions.

Also add a note about `version: x` not being equivalent to
`version: x.latest`.

Note that there are still some examples using fixed versions
in the UCP sections; we need to evaluate those to make sure
the right (and supported) versions are used for UCP (which may
be different than "latest").

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* Address some v3/v2 issues, and YAML syntax error

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* Minor edit

* Final updates

- Added note around v2 and v3 versioning
- Updated note for v3 to match the v2 update
2019-04-12 15:25:47 +02:00
Maria Bermudez 773ff41ddd
Link to ARG and FROM interaction section 2019-03-18 12:00:47 -07:00
paigehargrave c191ecf594
Minor syntax fixes 2019-03-17 12:46:01 -04:00
paigehargrave e7fc879f08
Update compose-file-v2.md 2019-03-17 12:44:15 -04:00
Frank Lemanschik 918a65fb46
Update compose-file-v2.md 2019-03-16 03:43:19 +01:00
Frank Lemanschik d913946246
Update compose-file-v2.md
corrected typo buld => build
2019-02-14 08:49:56 +01:00
Frank Lemanschik f314f2cd51
Update compose-file-v2.md
Updated Documentation section ARGS added a note about the fact that ARG defined befor FROM is not there after FROM without explicit adding it again after FROM
2019-02-14 08:33:45 +01:00
L-Hudson 8292e0dc29
Merge pull request #8198 from thaJeztah/note_picking
Use consistent formatting for notes
2019-02-12 11:59:49 -05:00
Sergey Bon 5d944298d9 Fix typo: docker_compose.yml -> docker-compose.yml 2019-02-09 15:11:15 +02:00
Sebastiaan van Stijn 03d5b3396d
Use consistent formatting for notes
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-02-09 00:49:57 +01:00
Joffrey F 2efd2456d7 Update docs for volume and networks about the changed behavior of the external key
in newer versions of the format

Signed-off-by: Joffrey F <joffrey@docker.com>
2018-11-06 16:02:54 -08:00
Oscar Caballero 269c80d2d9 Spelling revision 2018-09-23 21:43:11 +02:00
Joffrey F 8348f4ffb2 Document new Compose file additions
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-04-11 10:45:28 -07:00
Joffrey F 0e2cc91765 Add cache_from to v2 reference (#6410) 2018-04-09 18:56:59 -07:00
Joffrey F 12757bf953 Compose 1.20.0 (#6266) 2018-03-20 11:23:36 -07:00
Björn 9ba5248f1e Fix #5219: Change unsafe ARG example in compose file docs. (#5984) 2018-03-17 11:22:19 -07:00
Jeffrey M. Levesque 541e60ec16 #6215: compose-file-v2.md, fix 'version: 3.2' typo 2018-03-13 10:50:51 -07:00
Joffrey F 1ba03f1a34 Add build target to v3 reference (#6107) 2018-02-27 16:11:01 -08:00
Misty Stanley-Jones d14a9f96fd
Doc that for 2.1+, overlay networks are attachable (#5967) 2018-02-08 15:58:45 -08:00
Joffrey F 761d421b5c Fix typos (#5944)
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-02-07 13:18:54 -08:00
Joffrey F c399e1e479 Docs for Compose 1.19.0 release (#5826)
* Docs for Compose 1.19.0 release

Signed-off-by: Joffrey F <joffrey@docker.com>
2018-02-07 13:18:54 -08:00
Wadim Kruse b36b6d2c86 Fix restart policy description (#5927) 2018-02-06 09:02:36 -08:00
Misty Stanley-Jones a4f5e30249
Various copyedits to reduce future tense, wordiness, and use of 'please' (#5788)
* Reword lots of instances of 'will'

* Reword lots of instances of won't

* Reword lots of instances of we'll

* Eradicate you'll

* Eradicate 'be able to' type of phrases

* Eradicate 'unable to' type of phrases

* Eradicate 'has / have to' type of phrases

* Eradicate 'note that' type of phrases

* Eradicate 'in order to' type of phrases

* Redirect to official Chef and Puppet docs

* Eradicate gratuitous 'please'

* Reduce use of e.g.

* Reduce use of i.e.

* Reduce use of N.B.

* Get rid of 'sexagesimal' and correct some errors
2018-01-25 17:37:23 -08:00
Joffrey F 6e4339fc4d Update Compose docs to reflect changes in 1.18 release
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-12-18 15:11:03 -08:00
Gwendolynne Barr 9e57cf9edd Repair link (#5536) 2017-12-15 16:11:00 -08:00
Misty Stanley-Jones a9314c7ec7 Document new features in Compose 1.17 (#5019) (#5021)
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-11-01 18:40:56 -07:00
Joffrey F 995db08193 Add documentation for scale parameter (#5065)
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-10-20 16:42:02 -07:00
Misty Stanley-Jones 2eb70ea3c2 Add info about network: host (#4959) 2017-10-20 16:17:45 -07:00
Misty Stanley-Jones d8adc37e74 Revert "Document new features in Compose 1.17 (#5019) (#5021)" (#5038)
This reverts commit 52fe0df34b.
2017-10-18 16:07:20 -07:00
Misty Stanley-Jones 52fe0df34b Document new features in Compose 1.17 (#5019) (#5021)
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-10-17 21:17:28 -07:00
John Mulhausen 6e2f94daf6 Revert "improve links from v2.1 (#4991)" (#5015)
This reverts commit 62b05a1040.
2017-10-17 15:13:56 -07:00
Godefroid Chapelle 62b05a1040 improve links from v2.1 (#4991)
- fix link_local_ips and pids_limit
- more specific links to volume and network labels, volume name
2017-10-17 13:27:10 -07:00
Misty Stanley-Jones 26ab6617b4 Backport note about links being legacy (#4956) 2017-10-13 16:00:26 -07:00
Victoria Bialas 02fc66fde8 More info on resource constraints in Compose v3 and v2 (#4651)
* added more info about resource constraints to Compose docs

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fixed link in Compose docs, added instructions in test for adding custom target link link IDs

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fixed links

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-09-18 16:02:05 -07:00
Joffrey F 0702f23aae Document Compose 1.16.0 additions (#4293)
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-08-31 15:52:18 -07:00
Yong Wen Chua 563c564d4c Document Docker Compose Version 2.3 (#3994)
And the new "target" parameter under "build"

Signed-off-by: Yong Wen Chua <me@yongwen.xyz>
2017-08-31 15:52:18 -07:00
Wenxuan Zhao 4d43ae7ea2 Fix `depends_on` links across documents. (#4424)
NOTE: compose file v1 doesn't support `depends_on`,
      thus it's still a broken link.

Signed-off-by: Wenxuan Zhao <viz@linux.com>
2017-08-29 15:52:02 -07:00
Joffrey F 45ac9fe357 Add clarification on env_file / environment interaction (#4177)
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-08-17 14:09:43 -07:00
Victoria Bialas a922be3d0f Update admonitions CSS for consistency and better writer workflow (#4019) 2017-07-31 21:49:56 -07:00
Victoria Bialas 52644895c0 added suggested new example to the include
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-07-27 11:09:03 -07:00
dark0dave a97df05f5b Update compose-file-v2.md 2017-07-27 11:09:03 -07:00
dark0dave be2dcf2909 Update compose-file-v2.md
Missing Documentation
2017-07-27 11:09:03 -07:00
Joffrey F 181a0c6346 Compose 1.15.0 additions (#3950)
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-07-26 16:08:44 -07:00
Victoria Bialas c2bd959d1f env file list precedence Compose file (additional clarification) (#3822)
* clarified ordering of env files

* added env_file order of precedence to v1, v2 Compose

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* formatting

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-07-05 13:43:42 -07:00
Misty Stanley-Jones b1aa298c16 Docs for Compose 1.14 (#3697)
* Specify Compose version for Compose file formats (#3297)

* Specify Compose version for Compose file formats

Explicitly specifying Compose versions file formats 2.1 and 2.2.

* corrected typo 2.1 --> 2.2

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* Document new Compose 1.14.0 features (#3695)

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

* Current compose is 1.14.0 (#3690)

Signed-off-by: Guillaume Rose <guillaume.rose@docker.com>

* Fix typo
2017-06-23 18:15:01 -07:00
Sequoia McDowell 744e5eeec8 Fixing documentation for v2 `links` (#3641)
wrapping array values in quotes is required.
2017-06-20 11:12:57 -07:00
Victoria Bialas 2cfb7ba743 added links to Compose release versions, improved matrix description (#3580)
* added links to Compose release versions, improved matrix description

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* review comments, used include for matrix in all file references

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* incorporated review comments

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-12 18:40:51 -07:00
Victoria Bialas 63c7febfdd added Python, Docker Cloud install/run to known issues and setup notes (#3525)
* added Anaconda Python 3.5.2 install/run to known issues

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* added notes re: Python 3.x not supported in setup and install

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fixed heading levels in Cloud known errors

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fixed links (moby --> docker), formatting

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fixed on-page link list alignments for toc max/min topics

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-07 18:36:50 -07:00
Victoria Bialas da9734a626 updated syntax for command in Compose files (#3498)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-05 16:37:54 -07:00