* Update ipv6 instructions for 3.x Compose files
IPv6 instructions on https://github.com/docker/compose/issues/4958, are compatible with Docker Compose 3.x
* Update code block to use yaml syntax
With @usha-mandya
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
* Update text about using IPv6
By @usha-mandya
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
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).
- Add missing code-hints (console, yaml)
- Consistently add an empty line after code-blocks
- Combine some examples where the output and the command were
put in separate blocks. With the "console" code-hint, this
is no longer nescessary.
- fix indentation in cloud/ecs-integration.md, which caused the
numbered-list to be interrupted.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Add --service-ports note to ports section
## Description
Add note in `ports` section of file reference docs pointing to the `run` command's `--service-ports` flag
## Motivation
Spent quite a few hours spinning my wheels before I came across `run`'s `--service-ports` flag.
I'm struggling to find the issue where I found this, but the comment pointing to `--service-ports` had a lot of reacts, so this might be a relatively common
## Things I'd still like to do
- [ ] link to the [`--service-ports` docs](https://github.com/docker/docker.github.io/blob/master/compose/reference/run.md) -- not sure how to do this
- [ ] clean up location of this note -- not sure if I've put the note in a good place -- we can shunt it to the bottom
- [ ] Duplicate for older versions
Thanks
* Minor style update
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
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>
The current wording of "name of the config as it exists in Docker" suggests that the real generated name is used, instead the "key" of `configs` object in the docker-compose file is used.
```yml
version: "3.5"
services:
app:
image: alpine
configs:
# documentation currently suggests this (the "name as in Docker")
# this causes an error- undefined config "name-as-in-docker"
- source: name-as-in-docker
target: /config-with-name-as-in-docker.json
# the correct source to use is the name (key) from this docker-compose file
- source: name-as-in-file
target: /config-with-name-as-in-file.json
configs:
name-as-in-file:
name: name-as-in-docker
file: ./cfg.json
```
* Document GPU support in Docker Compose
Signed-off-by: aiordache <anca.iordache@docker.com>
* Update the note format
Added target=blank to enable external links to open in a new tab.
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
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>
The `hide_from_sitemap` metadata variable was a custom thing we implemented
to add a "noindex" meta-header to pages and to exclude a page from the
search auto-complete.
However, pages with that option set would still be included in sitemap.xml,
resulting in search engines to visit those pages (only to discover they
should not index them).
This patch replaces the custom `hide_from_sitemap` value for `sitemap: false`,
which is a metadata variable that's defined by the "jekyll-sitemap" plugin
we use to generate the sitemap.xml;
https://github.com/jekyll/jekyll-sitemap/blob/v1.4.0/README.md#exclusions
Setting this variable will now:
- add a "noindex" metadata header to the page
- exclude the page from the sitemap.xml.
- exclude the page from /js/metadata.json (used for search autocomplete)
Also fixed an issue in the metadata.json where the `notoc` metadata was
used to exclude pages, however that variable is meant to disable the
in-page TOC (right-hand side navigation with anchor links).
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This topic was removed in 9bebb666d9
We may want to add back the part describing sharing sshagent somewhere,
which is not really a feature related to osxfs. Also, some generic
description about file sharing (permissions, syncing) should probably
be added back.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
See https://web.dev/external-anchors-use-rel-noopener/
Using noopener, as that addresses the security issue. "noreferer" blocks
the REFERER header, which may still be useful for some target URLs.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Correcting update_config.monitor documentation
The default monitor period is 5s and cannot be set to 0. The lowest possible value is 1ns.
* Correcting default values
Dora Ribeiro
Heitor Lisboa
Allie Sadler
Andrea Leopardi
Ulysses Souza
Usha Mandya
Usha Mandya
PeterBParker
QuantumGhost
Stefan Scherer
Kayla Reopelle (she/her)
Sebastiaan van Stijn
Ross Patterson
shokkunrf
Paul Townsend
unknown
Porter Darby
Zane Dufour
Edgars Baduns
Randy Fay
Anca Iordache
Roman Anasal
Christian
aiordache
Jak Spalding
David Florness
Sebastiaan van Stijn
Aleksandr Prusov