Commit Graph

237 Commits

Author SHA1 Message Date
Allie Sadler 855cda4011
Spec split (#16740)
* split spec

* spec split

* trial branch

* fix

* branch update

* landing page

* add description

* add description

* update file path

* tweak

* fix build

* split spec

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* spec split

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* trial branch

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* fix

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* branch update

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* landing page

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* add description

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* add description

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* update file path

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* tweak

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* fix build

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* missing new line

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* first batch of fix links

* second batch of link fix

* update toc

---------

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
2023-03-22 12:00:04 +00:00
Jan Pieper 10a2232559 docs: fix grammer in ipam description 2023-02-17 11:31:29 +01:00
Allie Sadler 8e16fb9373
keywords (#16691) 2023-02-08 14:42:21 +00:00
Allie Sadler d165097c0d
ENGDOCS-1166a (#16641) 2023-01-31 15:27:52 +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
David Carrell 19854f8550
Update index.md 2022-12-07 13:26:05 -06:00
Aaron Korte ddc1e906db
Reorder entries so M shows up before N. (#15789)
Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2022-09-30 15:25:52 +02:00
bragov4ik 7b1551532e
Typo in long syntax section in compose spec
Description of code snippet in long syntax example of [secrets](https://docs.docker.com/compose/compose-file/#secrets) states that a name of a secret file is set to `server.crt` whereas in the snippet it is configured to `server.cert`.
2022-09-04 21:37:20 +03:00
Dockertopia 56433afce6
Apply suggestions from code review
Minor edits for clarification
2022-09-01 17:02:21 +01:00
Milas Bowman 3518db454f compose: merge latest spec changes
* tmpfs.mode: https://github.com/compose-spec/compose-spec/pull/252
* build.tags: https://github.com/compose-spec/compose-spec/pull/255
* env var secrets: https://github.com/compose-spec/compose-spec/pull/257
* build.platforms: https://github.com/compose-spec/compose-spec/pull/267

Signed-off-by: Milas Bowman <milas.bowman@docker.com>
2022-09-01 09:55:24 -04:00
Charlie Arehart e077973634
correct grammatical mistake
I am assuming the missing "is" is what was intended for the sentence. Authorized folks can confirm or deny.
2022-08-09 11:42:42 -05:00
CrazyMax 09c9f51bcf
remove most of absolute urls
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-08-03 11:50:33 +02:00
BinaryWizard904 7f199a6d10
Fix other dead link in compose doc (#15147)
Turns out the dead-link to a permissions calculator fixed in PR 14985 only fixed one of two links.
This pull request fixes the other one.
2022-07-18 17:54:10 +01:00
CrazyMax 5088f2d82b
fix redirects
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-07-13 18:02:43 +02:00
BinaryWizard904 07f2ad2a42
Fix Dead Link on Compose specification
http://permissions-calculator.org is dead.  I replaced the link to it with one
to a working copy of the page hosted by the Internet Archive.
2022-06-22 11:36:14 -05:00
Gavin Foley bbd152b7ce
Add missing word 2022-06-18 13:55:21 -04:00
AurelienWebnation a6ede85e81
fix: typo 2022-06-08 18:40:59 +02:00
Dora Ribeiro d49af6a449
ENGDOCS 711 Revisited Compose Install Page (#14838)
Revisiting Compose installation
2022-06-02 18:10:37 +01:00
Heitor Lisboa aced504ad2
fix markdown error
Fixed italic marker
2022-05-22 13:41:29 -03:00
Allie Sadler f5b05c2e94 fix broken link 2022-05-12 10:11:55 +01:00
Usha Mandya 5636e8e678 Fix broken xrefs, curate compose spec overview
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2022-03-29 14:37:44 +01:00
Usha Mandya fc28f7560a Add build and deploy docs
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2022-03-29 12:55:29 +01:00
Usha Mandya 1d5af4b2b9 Test: Add Compose spec details to the repo
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2022-03-21 12:07:21 +00:00
Paul Townsend fea0d8fea8 Minor grammar fix ("an unified" -> "a unified") 2021-06-04 12:35:51 +01:00
unknown 9463f35e56 removed version 1 from composefileref 2021-05-07 11:49:37 -05: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
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
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 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
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
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
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
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 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