Commit Graph

100 Commits

Author SHA1 Message Date
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
Victoria Bialas b62449b3c8 clarified logging options in Compose, fixed glaring note formats (#3272)
* clarified logging options in Compose, fixed glaring note formats

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

* added link directly to JSON driver in supported drivers docs

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

* took off code tags to make link stand out

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

* fixed alignment of note text in markdown

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

* x-ref to how to set environment variables in containers

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

* copyedit in note

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-05-16 12:02:54 -07:00
Joffrey F 33b1c443a9 Add docs for IPAM options
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-05-06 11:03:01 -07:00
Joffrey F 9f26b57158 Fix broken links to compose versioning docs and remove some obsolete notes
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-05-06 11:03:01 -07:00
Joffrey F da867b5620 Add docs for new `init` option in service config
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-05-06 11:03:01 -07:00
Suraj Narwade be37ddd557 Adding documentation for restart policy (#2912)
Resolves #1353
2017-04-19 17:05:02 -05:00
xufei100 a8a33c1d07 Update compose-file-v2.md (#2702)
fix wrong link
2017-04-10 12:40:09 -07:00
Victoria Bialas 49c5bd7b6e updates for Compose group_add example (#2684)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-04-07 12:45:19 -07:00
Misty Stanley-Jones 4fd4685ec5 Fix 404 (#2622) 2017-04-04 15:03:02 -07: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
Mateusz Kurek 92523b274e Fix external links from compose file docs (#2401)
Compose file v1 and v2 docs had relative links to some non-existing pages (especially about extending services). It was probably introduced when `compose-file.md` was detached into directory with single file per compose file version.
2017-03-21 11:55:35 -07:00
Misty Stanley-Jones fb7c73908b Update the styleguide (#2332)
* Update the styleguide

Also normalize admonition titles with the colon outside the bold.
2017-03-15 09:46:30 -07:00
Victoria Bialas 4b9493d276 fleshed out Machine scp command description, fixed Compose file notes (#2265)
copyedit to fix typo

wrapped text properly

replaced original example with Nathan's

added a better sub-title

specifically mentioned not using relative paths

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-10 16:30:26 -08:00
Victoria Bialas a020b82489 fixed link to Compose v2 restart
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-08 18:26:52 -08:00
Joe Meissler b93760bea5 merge other changes, fix typo 2017-03-01 15:01:26 -08:00
Joe Meissler 5c87ba4009 Add documentation for mem_swappiness 2017-03-01 14:48:19 -08:00
Joffrey F 3e4005c360 Updated miscellaneous list of options for each format
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-02-21 13:11:37 -08:00
Victoria Bialas f36ad2fa3a fixed link in Compose file, expanded on-page TOC's to show more subtopics
fixed a link to variable substition in Compose v.3

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-02-17 14:07:32 -08:00
Ivan Fraixedes e7f6f5ab36 Fix yml file in compose alias example 2017-02-13 16:21:37 +01:00
Victoria Bialas 1db710d8f3 compose copyedit
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-02-10 14:18:32 -08:00
Victoria Bialas 55b004036a added drafts of versioned compose reference files
pruning Compose file v2 reference

updated Compose v1, v2, v3 files, still WIP

added includes for compatibility matrix, fixed TOC menu

new topic organziation Compose reference, split two 3 files plus versioning

Daniel's comments, fixed links, added more to versioning details

fixed volumes_from example per Daniel's comments for v1

simplified links to version references

copyedits and improved/surfaced links to versioning/upgrade docs

removed for version specific content re: volume_drivers from various files

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-02-09 17:39:08 -08:00