Commit Graph

71 Commits

Author SHA1 Message Date
Victoria Bialas a922be3d0f Update admonitions CSS for consistency and better writer workflow (#4019) 2017-07-31 21:49:56 -07:00
Victoria Bialas eb25815fb9 Better examples to show Compose file structure, expand/collapse accordion (#3967)
* better examples to show Compose file structure

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

* cleaned up leading spaces in Compose file example

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

* cleaned up leading spaces, added a test file

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

* expand/collapse accordion full implementation, explanation in test.md

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

* delete temporary test file from PR

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

* fix accordion to work on mobile (cursor style)

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

* verified fix for mobile worked, added same to test.md, updated notes and content

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

* Clarifed details on test page, fixed references for FontAwesome icons

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-07-28 12:32:53 -07:00
Victoria Bialas 3558712894 added endpoint_mode topic for Compose file v3.3 (#3982)
* added endpoint_mode topic for Compose file v3.3

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

* incorporated review comments re: features and versioning

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-07-26 10:33:46 -07:00
Victoria Bialas 1c6ff26042 added Compose topics on caching options for performance (#3932)
* added Compose topics on caching options for performance

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

* updated title for Compose topic

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

* line wrap per review

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-07-21 15:52:41 -04:00
Adrian Moisey 39dd81ec91 Fix example of "configs" (#3807)
This should be "configs" not "secrets" as it's an example of the new "configs" option.
2017-07-05 16:45:55 -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
Victoria Bialas d2b71ad555 clarified Mac vs. Linux steps on bash completion (#3800)
* clarified Mac vs. Linux steps on bash completion

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

* copyedit on Compose file reference page

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-07-03 16:26:54 -07:00
Misty Stanley-Jones 08f830811d Add configs to compose file reference 2017-06-28 08:31:29 -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
Victoria Bialas aee7e98fcb fixed links to topics w/underscores (#3583)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-12 19:35:08 -07:00
Joffrey F b60dd6facb Remove unsupported link_local_ips param from v3 doc (#3506)
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-06-12 18:59:53 -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 fa52e73dc5 Added notes and troubleshooting topic on volume mounts from host (#3556)
* added notes and troubleshooting topic on volume mounts from host

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

* updates to troubleshooting, FAQs and shared drives topics and notes

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-12 15:10:15 -07:00
Misty Stanley-Jones a173c4630d Document OOME information (#3536) 2017-06-09 09:41:00 -07:00
Victoria Bialas 12f96be8d8 added note on external volumes with docker stack deploy (#3541)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-08 17:35:02 -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 bb8146180f Compose improvements, env_file vars, rails sample (#3517)
* added example for env_file variables

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

* copyedits and rework of Compose rails example

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-07 14:05:34 -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
zasca 87d08620aa Added unless-stopped restart policy (#3278) 2017-05-22 10:39:29 -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
Ben Reichert 07a105d724 Add max-size, max-file logging options documentation (#3243) 2017-05-13 22:14:01 -07:00
John Yani d0e12df054 Service create vs run (#3217)
This compose section should reference docker service create, not docker run options
https://github.com/moby/moby/issues/32844
2017-05-10 11:52:30 -07:00
Victoria Bialas 105333e079 clarified use of volumes with stack files, services, swarms (#3201)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-05-08 18:50:45 -07:00
Vlad 1b7091501a Fix indentation (#3180) 2017-05-05 21:48:18 +00:00
Andy Neff 3de6ebc21e Update docker-compose index.md (#3090)
There were a number of things wrong with the `restart` definition

1. The volumes note came after the restart section rather than before
2. The restart command used array notation rather than map. This is confusing to those unfamiliar with yaml and inconsistent with the rest of the documentation
3. Using `docker-compose` myself, saying `restart: no` does not work, but `restart: "no"` does. 

```
ERROR: The Compose file './docker-compose.override.yml' is invalid because:
services.letsencrypt.restart contains an invalid type, it should be a string
```
2017-04-28 22:07:50 +00:00
hacfi 3e137458e8 Fix yml indention (#3089) 2017-04-28 22:06:04 +00:00
John Yani b07f615784 Wrong order of docker compose restart section (#3093) 2017-04-28 14:46:11 -07:00
Xianlu Bird 903df7ebfc Fix published&target description in ports section (#3016) 2017-04-26 20:52:14 +00:00
Daniel Maslowski 50e9e49552 Note on mixing network_mode with links in Docker compose file (#3049) 2017-04-26 20:50:47 +00:00
Lenny Linux 9a1f99cd11 add warning class and a linebreake to the warning blogquote (#2937)
* Update fedora.md

add warning class to blogquote

* Update linux-postinstall.md

add warning class to blogquote

* Update ubuntu.md

add warning class to blogquote

* Update https.md

add warning class to blogquote

* Update swarm_manager_locking.md

add warning class to blogquote

* Update dockerlinks.md

add warning class to blogquote

* Update deploying.md

add warning class to blogquote

* Update deploying.md

add warning class to blogquote

* Update insecure.md

add warning class to blogquote

* Update discovery.md

add warning class to blogquote

* Update dockerd.yaml

add warning class to blogquote

* Update docker_secret_rm.yaml

add warning class to blogquote

* Update docker_service_rm.yaml

add warning class to blogquote

* Update docker_secret_rm.yaml

add warning class to blogquote

* Update scale-your-cluster.md

add warning class to blogquote

* Update resource_constraints.md

add warning class to blogquote

* Update binaries.md

add warning class to blogquote

* Update content_trust.md

add warning class to blogquote

* Update secrets.md

add warning class to blogquote

* Update index.md

add warning class to blogquote

* Update install-sandbox-2.md

add warning class to blogquote

* Update docker-toolbox.md

add warning class to blogquote

* Update index.md

add warning class to blogquote

* Update centos.md

add warning class to blogquote

* Update debian.md

add warning class to blogquote

* Update faqs.md

add linebreak after Looking for popular FAQs on Docker for Windows?

* Update install.md

add linebreake after **Already have Docker for Windows?**

* Revert "Update dockerd.yaml"

This reverts commit 3a98eb86f700ade8941483546c33f69a9dab8ac3.

* Revert "Update docker_secret_rm.yaml"

This reverts commit 5dc1e75f37033932486c11287052b7d64bf83e55.

* Revert "Update docker_service_rm.yaml"

This reverts commit a983380a5625b471f1a03f8ed2301ead72f98f1b.

* Revert "Update docker_secret_rm.yaml"

This reverts commit 4c454b883c300e26fbb056b954bb49ec2933b172.
2017-04-25 11:33:27 -07:00
Victoria Bialas 5c2b6663c4 Windows server 2016 Compose install, Compose file format updates (#3035)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-04-25 10:44:34 -07:00
Victoria Bialas df4892c964 update re:container_name not supported in v3 Compose (#3003)
* update re:container_name not supported in v3 Compose

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

* added container_name to list of removed v3 options

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

* corrected  definitions per reviews

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

* listed unsupported suboptions for deploy key

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-04-24 11:47:18 -07:00
Suraj Narwade be37ddd557 Adding documentation for restart policy (#2912)
Resolves #1353
2017-04-19 17:05:02 -05:00
Rubab-Syed bdcd3be43c Add note that compose v3 doesnt support additional ipam configs (#2858)
* Add note that compose v3 doesnt support additional ipam configs (#1528)

* Fix minor tick (#1528)

* Edits
2017-04-19 07:00:23 -05:00
John Mulhausen 8820cfa6ff New 6-page "Get Started" (#2296)
* Create index.md

* Create part2.md

* Create part3.md

* Create part4.md

* Create part5.md

* Rewrite step 2

* Update part2.md

* Update part2.md

* Update part2.md

* Update part2.md

* Update part2.md

* Update part2.md

* Update index.md

* Rewrite of part 3

* Tabs-based swarm instructions, pass 1

* Rewrite of parts 3 and 4, tabs implementation

* Navigation, rewrites, part 4 completion

* Part 5 w/Redis

* Part 5, compelte Redis, rename part 6

* TOC/redirect implementation

* Update part6.md

* Changing links to point to new tutorial

* Rewrites and asciinemas

* Fix overview

* Label diagrams

* Fix button

* Fix link to where Stacks are covered

* Fix typo

* s/file/directory

* Reformat paragraph

* Shorten tabs

* Typos

* Release DTR 2.2.4, 2.1.6

* Go back to small /edge (#2736)

* Go back to small /edge

* Update site front page

Add info about Editions
Reorganize components
Update headings

* Move logic of fetching content to a script

* Add v1.28 API

* Add info about versioned API

* Fix a few 404s (#2785)

* Fix typo

* Propose use of another word (#2791)

I think that interested is better than invested, in this case.

* Update secrets.md (#2780)

remove correct secret

* Change mount syntax on windows from //c/ to c:\ (#2761)

LGTM

* Update hackathon.md (#2773)

* nodes.md grammar correction (#2802)

* Grammar and formatting check (#2797)

* Wrong article

If the first word starts with a vowel sound you use an. If the first word has a consonant sound use a.

* Making the text bold

Removing backticks because probably the text needs to be bold and not marked as code.

* Update overview.md (#2805)

It should say 'predecessors', not 'successors'. Otherwise the sentence and the subsequent example don't make sense.

* shrink some big images (#2798)

Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com>

* #2627 (#2804)

- Fix right sidebar overflow on rescale

* Update hackathon.md

* change pre-build to pre_build to remove confusion (#2813)

* change pre-build to pre_build to remove confusion

* clarify that pre_build hook refers to a file

* Update TOC to sentence case (#2790)

* add more info about DTR on the overview page (#2794)

fix #1904

* Update glossary.yaml (#2807)

Fix #2575.

* fix imports since docker api pkg migration, fix example repository name to be canonical (#2806)

* tweak: code format for filename (#2829)

* tweak: code format for filename

slight reword, so as to avoid confusion w/filename

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

* small changes just to kick build again

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

* Update hackathon.md

* fix broken links (#2808)

* fix broken link (#2809)

* [CONTRIBUTING] update broken link (#2826)

* [Debian] add gnupg2 requirement for stretch (#2823)

* TOC/redirect implementation

* Changing links to point to new tutorial

* Rewrites and asciinemas

* Fix bad merge

* Metadata, formatting

* Front page formatting, link instrumentation
2017-04-18 03:32:37 -05: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
Jim Galasyn 1654a09c72 Fix broken samples link (#2682)
Replaced missing samples link with links to Getting Started and GitHub example files
2017-04-07 10:22:44 -07:00
mrfly 8316c1d0be There is a colon omitted in this section. (#2631) 2017-04-06 15:33:20 -07:00
Misty Stanley-Jones 2f4355c22a Fix compose links (#2624) 2017-04-04 15:03:50 -07:00
Misty Stanley-Jones 3833596740 Adjust heading level (#2620) 2017-04-04 14:26:45 -07:00
Misty Stanley-Jones c6aca8acee Improve bootstrap tabs (#2546)
Use data-target instead of href
Move tab-syncing code into site-wide JS so everyone can use it
Add example for syncing tab groups on the same page
2017-03-30 12:57:37 -07:00
Misty Stanley-Jones 669b51a889 Fix broken links (#2521) 2017-03-28 16:42:44 -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
Daniel Nephin add1325878 Add ports and volumes long form syntax to compose-file reference (#2283)
* Add long form for ports.

Signed-off-by: Daniel Nephin <dnephin@gmail.com>

* Remove volume_driver from v3 reference.

Signed-off-by: Daniel Nephin <dnephin@gmail.com>

* Add docs for expanded mount syntax.

Signed-off-by: Daniel Nephin <dnephin@gmail.com>
2017-03-27 20:49:00 -07:00
Victoria Bialas 2f14b6ea51 added compose file example in accordion (#2477)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-24 19:48:19 -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
Victoria Bialas 5591401a2d clarified Compose file topic structure, and file examples (#2322)
copyedits, rewrite

fixed some links

simplified/shortened this topic

tweaked description of key, option, value

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-15 10:13:11 -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 9e244bbb9c added links to example of using overlay network in swarm mode (#2331)
added more links re: overlay networks

provided more links to networking topics, restructured the section

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-03-14 18:46:44 -07:00
Daniel Nephin 37333c8fe8 Fix depends_on in Compose file v3 reference (#2278)
* docker swarm does not respect depends_on

Swarmkit does not seem to have the concept of starting services in a particular order.

Tested with docker 1.13.1. Also, `docker-compose bundle` warns us about depends_on being unsupported.

* Remove condition form of depends_on from the V3 compose file docs.

Signed-off-by: Daniel Nephin <dnephin@gmail.com>
2017-03-14 17:38:59 -07:00