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>
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).
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>
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>
* 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>
* 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
* 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
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