Commit Graph

68 Commits

Author SHA1 Message Date
David Karlsson 379e33b794 compose: remove incorrect statement about minor versions for v3.x
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-06-09 13:41:42 +02:00
Allie Sadler 7db3dd483e
Engdocs 1374 (#17390)
* ENGDOCS-1374

* fix

* fix
2023-05-23 12:19:18 +01:00
Milas Bowman a62805e3eb
Compose v2 guide [ENGDOCS-1319] (#17209)
* initial content

* edits

* fix links

* compose: bunch of changes/additions around migration

* Apply suggestions from code review

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>

* review feedback & link fixes

* fix another link

* update TOC page title to match

* move redirect to migrate page

* update v1 eol blurb

* fix eol warning style

---------

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2023-05-10 08:42:35 +01:00
Allie Sadler d55371d48b
ENGDOCS-1303 (#17131) 2023-04-18 12:12:31 +01:00
CrazyMax 561118ec5b
rename docs repository
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-29 11:07:53 +02:00
Stefan Scherer bcc2a90f52
Use host port 8000 to avoid conflicts on Monterey
Signed-off-by: Stefan Scherer <stefan.scherer@docker.com>
2022-02-09 13:05:34 +01:00
Sebastiaan van Stijn 173d3c65f8
fix broken (anchor) links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-09-13 15:07:49 +02:00
Usha Mandya ddf8543d28 Fix comment from Chris and update a note format
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-03-16 13:41:11 +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
Sebastiaan van Stijn 3a794b3197
(temporarily) replace compose-file deep links to v3 docs
The documentation curently doesn't contain reference docs for the
unified (version-less) compose-file syntax, so for now replacing
all links to point to the v3 compose-file reference, which is still
present.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-01-07 14:21:37 +01:00
aiordache 00119346fe Reference compose spec in compose file formats
Signed-off-by: aiordache <anca.iordache@docker.com>
2020-11-17 10:42:36 +01:00
Sebastiaan van Stijn c119ed174e
Use https:// for links and examples
Found these using `http://[^lp10\*`<][^o]` (to exclude "localhost" and IP-addresses)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-13 12:09:11 +02:00
Sebastiaan van Stijn 2eff941697
compose: move deprecated env-vars section, and fix duplicate redirects
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-07 12:49:30 +02:00
Sebastiaan van Stijn 36e483169d
compose-file: document additional changes in the 3.8 schema (#10980)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-06-12 10:51:35 +01: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 3caa2cab82
compose-file: add some options that were missing in changes
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-21 20:57:16 +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
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 aaca9b83b5 Revert "Revert "Merge branch 'master' of github.com:docker/docs-private into test-branch-2""
This reverts commit 4c95d161ca.
2018-08-29 19:01:03 -07:00
Maria Bermudez 4c95d161ca Revert "Merge branch 'master' of github.com:docker/docs-private into test-branch-2"
This reverts commit af5f2fcc38, reversing
changes made to 338b690d26.
2018-08-29 18:37:44 -07:00
Maria Bermudez 840c167055 Revert "Revert "Merge branch 'master' of github.com:docker/docs-private into test-branch-2""
This reverts commit 14080c18bd.
2018-08-29 18:36:03 -07:00
Maria Bermudez 14080c18bd Revert "Merge branch 'master' of github.com:docker/docs-private into test-branch-2"
This reverts commit af5f2fcc38, reversing
changes made to 338b690d26.
2018-08-29 14:47:31 -07:00
Joffrey F caad3ebe13 1.22.0 release notes and documentation
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-07-05 13:32:51 -07:00
Joffrey F d4e7eee27e Fix merge artifacts in vnext branch
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-04-11 10:45:28 -07: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 aca2e9ce5f Document compatibility mode
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-04-11 10:45:28 -07:00
Joffrey F 1c58771f85 Use updated notes format
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-04-11 10:45:28 -07:00
Joffrey F 66a461ecf5 Document compatibility mode
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-04-11 10:45:28 -07:00
Joffrey F 12757bf953 Compose 1.20.0 (#6266) 2018-03-20 11:23:36 -07:00
Joffrey F 2d12fdf671 Add docs for Compose file v3.5 and v3.6 (#5912)
Signed-off-by: Joffrey F <joffrey@docker.com>
2018-02-08 13:54:12 -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
ethan-haynes 074268b8ca added doc changes for upcoming tmpfs-mode 3.6 compose (#5777)
Signed-off-by: Ethan Haynes <ethanhaynes@alumni.harvard.edu>
2018-02-07 13:18:54 -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
Emiliano 'AlberT' Gabrielli 0b37cb6a4e Fix extends.md URL (#5717) 2018-01-11 09:15:08 -08:00
Joffrey F 44bacb4ed2 Update compose-versioning file with newer additions
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-12-18 15:11:03 -08:00
Misty Stanley-Jones 0793f49593 Document new features in Compose 1.17 (#5019) (#5021)
Signed-off-by: Joffrey F <joffrey@docker.com>
2017-12-18 15:11:03 -08:00
Lachlan Cooper a2a6db7716 Fix parameter links in compose-versioning.md 2017-12-13 15:59:45 -08:00
Dave Henderson a38c5a6f9f Document order option in update_config (#5089) 2017-11-01 18:40:56 -07: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
Misty Stanley-Jones 52de4ef650 Revert "Document order option in update_config (#5089)" (#5105)
This reverts commit 6c5c888882.
2017-10-25 10:04:24 -07:00
Dave Henderson 6c5c888882 Document order option in update_config (#5089) 2017-10-24 16:30:03 -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
Joffrey F 0b22c35a28 Remove delayed features from 1.16.0, fixed changelog (#4417) 2017-08-31 15:52:18 -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
Victoria Bialas a922be3d0f Update admonitions CSS for consistency and better writer workflow (#4019) 2017-07-31 21:49:56 -07:00