Commit Graph

41 Commits

Author SHA1 Message Date
Allie Sadler 28e0cde463
ENGDOCS-1376 (#17406) 2023-05-25 12:36:24 +01:00
bagratte 0691b9517c Proofread Compose Extends Manual 2023-05-05 10:48:16 +04:00
Allie Sadler 855cda4011
Spec split (#16740)
* split spec

* spec split

* trial branch

* fix

* branch update

* landing page

* add description

* add description

* update file path

* tweak

* fix build

* split spec

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* spec split

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* trial branch

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* fix

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* branch update

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* landing page

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* add description

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* add description

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* update file path

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* tweak

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* fix build

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* missing new line

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* first batch of fix links

* second batch of link fix

* update toc

---------

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
2023-03-22 12:00:04 +00:00
Allie Sadler d165097c0d
ENGDOCS-1166a (#16641) 2023-01-31 15:27:52 +00:00
Allie Sadler 002759f5be
ENGDOCS-1062 (#16468)
* ENGDOCS-1062

* Update compose/extends.md
2023-01-09 13:35:14 +00:00
Dora Ribeiro 72a3a45c0e
Replacing v1 syntax (#15185)
* Replacing v1 syntax
2022-07-26 18:08:28 +01:00
Dora Ribeiro d49af6a449
ENGDOCS 711 Revisited Compose Install Page (#14838)
Revisiting Compose installation
2022-06-02 18:10:37 +01:00
Benson Muite 1e942679ff
Indicate extends can be used again (#13695)
* Indicate extends can be used again

https://github.com/docker/compose/pull/7588

* Minor style update

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-11-26 15:11:47 +00:00
Sebastiaan van Stijn 8563a00ad8
compose: move reference/overview page
This makes the compose command-line reference available at;

https://docs.docker.com/compose/reference/

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-19 10:54:04 +02:00
Usha Mandya dacfbd27e3 Remove another warning on V1 file reference
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-03-16 11:29:19 +00:00
Usha Mandya 5c64b4230a Remove references to v1 from other topics
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-03-15 19:35:03 +00:00
Simon 5e78271505
TASK: Add codeblocks to code examples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-03-04 12:06:54 +01:00
Usha Mandya f57bd0b321
Merge pull request #10717 from thaJeztah/compose_samples
compose: add WordPress example to TOC
2020-09-08 16:29:31 +01:00
Geetha Rangaswamaiah 77b7b73652 Fix compose docs grammatical errors 2020-08-06 12:49:26 +05:30
Sebastiaan van Stijn 9f4db87055
compose: add WordPress example to TOC
Also removes links to individual examples, instead linking
to the "compose samples" page.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-28 14:35:50 +02:00
Sebastiaan van Stijn 0f3caaca6a
compose: use relative markdown links
Unfortunately, the only reliable way to create internal links
is to use relative links to other Markdown files. This does
match the way links on GitHub work, but makes it harder to
create these links.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-23 13:03:10 +02:00
Sebastiaan van Stijn 331554f4b3
Fix various links that were generating URLs with `.md` (#10548)
* Fix incorrect links in compose section

there's a bug causing wrapped links to not work, and replacing
some links to point to the .md file, so that IDE's can check
if the anchors are valid. Also replaced some links to point
to their new location.

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

* engine/swarm: update links

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

* Fix various broken links

There's a bug in the "jekyll-relative-links" plugin that causes wrapped links to not work.
Also replacing some links to point to the .md file, so that IDE's can check if the anchors
are valid. Finally, replaced some links to point to their new locations, so that users don't
get redirected..

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-01 12:05:50 +01:00
Psy-Q 25218530a6 Stop referring to deprecated 'links' feature, replace with 'depends_on' where appropriate (#9480) 2019-09-26 16:37:02 +01:00
K-Sato db4749c56a Fixed a sentence (#8728)
* Fixed a sentence

* Minor edit
2019-05-07 18:01:13 -07:00
Daniel Compton 8994637b41
Note extending individual services only works up to version 2.1
Adds a note that the `extends` field only works up to version 2.1 
at the header of the page.
2019-01-31 13:24:42 +13:00
Tammy Fox 2d0d59d868
oops, fix link again 2018-07-23 13:48:06 -04:00
Tammy Fox 1df778493c
make link relative 2018-07-23 13:46:18 -04:00
Tom Strassner d490343548
Update URI for Docker Compose version 1 2018-07-12 15:04:55 -04:00
Christian Klaussner f769463646 Explain how `volumes` and `devices` are merged (#5852) 2018-01-29 15:45:25 -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
Jacek Szubert c070ffe880 Remove documentation about the `--ignore-override` option (#3865)
* Remove documentation about the `--ignore-override` option

* changed link to full path, copyedit

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-07-12 13:14:50 -07:00
Victoria Bialas 88bb7acbd5 expanded on explanation in note re: extends supported versions (#3696)
* expanded on explanation in note re: extends supported versions

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

* copyedits

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

* x-ref to open issue to bring back extends

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

* added more x-refs to note on extends

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
2017-06-29 11:57:03 -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
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 03464b70cb changed `version 3` to `version 3.x` per Joffrey 2017-02-16 14:37:03 -08:00
Cedric Brancourt 0f4a08f916 fix(compose:extends): not supported from version 3 2017-02-16 19:39:23 +01:00
Sergei b6a8bfc1ac Excess '>' symbol deleted 2016-12-29 00:31:29 +07:00
Joe Lemmer 07fdd239c7 Update extends.md
Just corrected a missing 'and'
2016-11-22 20:12:14 +00:00
Gaetan 2ea564166d fix type of keywords entry in frontmatter (in /compose/ dir) (#481)
keywords should be a string, not an array containing one string

Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2016-11-07 13:18:56 -08:00
John Mulhausen 558314bf56 Converges titles to imperative-form, front-matter based, and sentence-case (#438)
Multiple title fixes, consistency fixes, convergence into metadata-based titles.
2016-11-04 15:38:40 -07:00
Misty Stanley-Jones 1a193d749b Revert "Merge pull request #437 from gdevillele/fix_keywords_format"
This reverts commit 13ddc1350e, reversing
changes made to 7a11f05943.
2016-11-04 13:33:29 -07:00
Gaetan 8bb4d6226a fix more frontmatter keywords values (#439)
* fix format of frontmatter keyword entry in some .md files

Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2016-11-04 10:48:38 -07:00
John Mulhausen 066b78bf86 Content rendering fixes 2016-09-30 01:51:56 -07:00
Misty Stanley-Jones d53c6798c9 Convert TOML to YAML, tweaks to work with Jekyll 2016-09-29 17:16:03 -07:00
Misty Stanley-Jones 701f170a21 Move docker-hub docs to docker-hub subdirectory 2016-09-29 10:38:52 -07:00
Misty Stanley-Jones 7629f462d5 Moved compose docs to compose subdirectory 2016-09-28 14:52:24 -07:00