Commit Graph

283 Commits

Author SHA1 Message Date
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
Usha Mandya 55b4fb8f37 Remove Compose file v1 ref docs
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-03-15 19:15:17 +00:00
Randy Fay 5b2b270b3b
Show the 3-part port syntax more clearly
The 3-part (IP:HOSTPORT:CONTAINERPORT) syntax in `ports` has been there a long time, but isn't adequately described here.
2021-02-13 06:08:43 -07:00
Sebastiaan van Stijn 3e9b407952
Fix broken link in compose-file docs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-02-12 19:46:37 +01:00
Anca Iordache 008dfe496d
Document GPU support in Docker Compose (#12315)
* 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>
2021-02-12 17:18:00 +00:00
Usha Mandya 6c15e5466f Add note on Compose file v1 deprecation
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-02-12 11:05:37 +00:00
Roman Anasal ca88315234 Add documentation for Compose service profiles
Adds docs for the new service profiles feature introduced
in docker/compose#7930

Co-authored-by: Chris Crone <christopher.crone@docker.com>
2021-01-25 14:42:20 +01:00
Usha Mandya 72f7f2481c
Merge pull request #12029 from git-developer/patch-1
fix: update name of config option `network_mode`
2021-01-08 14:32:51 +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
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
aiordache d0f70fdbb9 Move v3 info to dedicated file
Signed-off-by: aiordache <anca.iordache@docker.com>
2020-11-17 10:39:45 +01:00
Sebastiaan van Stijn 03d60f916a
Replace "hide_from_sitemap" with "sitemap: false"
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>
2020-10-21 15:09:11 +02:00
Sebastiaan van Stijn 92e2068c38
[Desktop] remove content refering to removed "osxfs" topic
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>
2020-10-20 14:08:46 +02: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 393d3f6566
Add rel="noopener" to external links
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>
2020-10-12 13:09:30 +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
Jak Spalding e94985b22a
Correcting update_config.monitor documented default value (#11034)
* 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
2020-10-01 09:44:00 +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
Usha Mandya 1c8cdff1e4 Fix extra space in Compose file ref 2020-09-03 15:19:55 +01:00
Usha Mandya 991da00bf7
Merge pull request #11021 from IMMORTALxJO/patch-1
Fixed typo in tmpfs example index.md
2020-07-07 16:26:10 +01:00
David Florness f89bbe13ed
Fix grammar (#11072) 2020-07-02 09:33:54 +01:00
Sebastiaan van Stijn e3b9c741d0
Merge pull request #10774 from BeniRupp/patch-1
Add description for unless-stopped restart policy
2020-06-25 11:11:49 +02:00
Aleksandr Prusov 1b25464e65
Fixed typo in tmpfs example index.md
tmpfs example has incorrect yaml syntax
2020-06-22 10:37:54 +03: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 3abbecd92d
Merge pull request #10897 from DaleSeo/patch-1
Correct image for db service
2020-06-02 13:26:38 +02:00
ticalcster 5c5bbfb624
fixed max_replicas_per_node example (#10711)
The example for max_replicas_per_node was not inside the placement dict.
2020-05-29 17:12:29 +01:00
Dale Seo 568a163b85
Correct image for db service 2020-05-26 22:28:04 -04:00
Beni Rupp 4d5c70525e
Add description for unless-stopped restart policy 2020-05-08 08:23:06 +02: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
Sven Dowideit d5e7a26efe
Mention Docker 19.03 and its compose file version - and add max_replicas_per_node
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2020-04-17 08:49:33 +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
Hector S 4a3f0a68c4
Fixing bad url related to #10517 2020-03-25 22:37:34 +01:00
Sebastiaan van Stijn 8a0f1f0c67
compose-file: disable indexing for compose file V1 format
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-17 14:15:28 +01:00
Sebastiaan van Stijn 02a36c2735
compose-file: fix constraint examples, and consistent format
Constraints don't accept spaces around `==` / `!=`

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-17 14:15:22 +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
TribalNightOwl b344d1beb3
Fix missing comma (#10226)
* Fix missing comma

* Improved way to describe boolean values in env

Great idea @dHannasch!
2020-02-11 14:21:50 +00:00
KoryKessel-Docker 2ce3996912 Push of Compose xref edits to public. 2019-11-14 14:40:19 +00: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
lena-larionova 07b6c614e4
Removed references to examples that no longer exist (#9781)
Signed-off-by: Lena Larionova <lena.larionova@docker.com>
2019-10-31 13:45:49 -07:00
Usha Mandya 2f85f33526
update compose v2 file ref (#9595) 2019-10-09 09:37:08 +01:00
Sebastiaan van Stijn cf8215ec58
Update compose-file reference for sysctls
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-09-23 16:28:40 +02:00
WeJie cf1f53a637 Remove duplicated doc - "depends_on" (#9401) 2019-09-09 15:59:15 -07:00