Commit Graph

101 Commits

Author SHA1 Message Date
Sebastiaan van Stijn a1c30d0af9
remove ubuntu 18.04 from examples
Ubuntu 18.04 reached end of standard support, so remove it from examples
in our docs.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-06-21 22:26:03 +02:00
Allie Sadler d165097c0d
ENGDOCS-1166a (#16641) 2023-01-31 15:27:52 +00:00
Allie Sadler f979ff4405
ENGDOCS-1064 (#16443)
* ENGDOCS-1064

* fix broken links

* fix broken links

* Apply suggestions from code review

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-01-09 13:20:06 +00:00
Sebastiaan van Stijn a7b9985e00
engine: update reference docs (yaml), and fix anchor links
The updated version uses new anchors for flags, so updates are needed
elsewhere to update those anchors.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-09 10:29:43 +01:00
CrazyMax d775c8a6bf
build: multi-stage builds
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-15 13:37:37 +02:00
Usha Mandya 9403431ff7
Add Compose v2 reference (#14716)
* Add compose v2 reference
* Fix broken links
* Remove v1 compose reference files
* Remove Compose CLI completion

Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2022-06-21 13:12:05 +02:00
Dora Ribeiro d49af6a449
ENGDOCS 711 Revisited Compose Install Page (#14838)
Revisiting Compose installation
2022-06-02 18:10:37 +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
Ross Patterson e0b3941eab
fix(yaml): Avoid bool type error
Docs contained an invalid example:

```
ERROR: The Compose file './docker-compose.yml' is invalid because:                                                                                                                   
services.*.restart contains an invalid type, it should be a string 
```

Use quotes to avoid YAML's implicit type conversion.  Someone may also want to do an audit of [other type conversions that might cause problems](https://www.rpatterson.net/blog/docker-gotchas/#yaml-needs-some-zen).
2021-08-18 12:46:23 -07:00
Sebastiaan van Stijn e22984f7d4
use Dockerfile "syntax" directive in examples
BuildKit allows using alternative Dockerfile syntaxes to introduce new features
without having to update Docker itself. The general recommendation is to always
specify a "syntax" directive in a Dockerfile, so that (if needed) older versions
of Docker can download the correct syntax to build the Dockerfile.

This updates our examples to include a syntax directive, to make users more familiar
with these directives, and to illustrate best-pracitces in our documentation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-20 10:19:12 +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
Christian 2ff837ea7c
fix: update name of config option `network_mode` 2021-01-03 09:29:25 +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
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
David Florness f89bbe13ed
Fix grammar (#11072) 2020-07-02 09:33:54 +01:00
Dale Seo 568a163b85
Correct image for db service 2020-05-26 22:28:04 -04:00
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 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 f15a3a1c4b
compose-file: use JSON notation for entrypoint example
This format is also supported by YAML, and similar to
how it's used in the Dockerfile.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-17 14:15:20 +01:00
Sebastiaan van Stijn 4cf38f289f
compose-file: reformat and rewrite some tips/notes
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-17 13:59:44 +01:00
Sebastiaan van Stijn dc2ae46f92
compose-file v2: re-order topics to be the same as v3
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-17 13:31:43 +01:00
Sebastiaan van Stijn fad62a6e9d
compose-file: add missing code-hints, sync formatting between versions
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-17 13:31:36 +01:00
Sebastiaan van Stijn 73c9649967
Move "Glossary" from top nav to "reference" section
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-14 09:10:38 +01:00
lena-larionova 54ca6a523b
Fixing glossary links (#9812)
Signed-off-by: Lena Larionova <lena.larionova@docker.com>
2019-11-06 11:00:13 -08:00
Usha Mandya 2f85f33526
update compose v2 file ref (#9595) 2019-10-09 09:37:08 +01:00
Sandro fafc6dd1de Link directly to resources section (#9200) 2019-08-16 11:44:19 +01:00
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