Commit Graph

1151 Commits

Author SHA1 Message Date
Sebastiaan van Stijn 8563a00ad8
compose: move reference/overview page
This makes the compose command-line reference available at;

https://docs.docker.com/compose/reference/

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-19 10:54:04 +02:00
Sebastiaan van Stijn f4ed09424b
move compose examples to the samples directory
Unifying all "examples" in this directory; some of these should still be
reviewed and/or removed in favor of examples from "awesome compose"

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-19 10:38:56 +02:00
Sebastiaan van Stijn e4455a5f8f
Add / update some redirects for old URLs, and move old engine examples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-19 10:38:52 +02:00
Usha Mandya 3bcf4ee068
Merge pull request #12685 from aiordache/compose_images
Add `compose images` command
2021-04-16 10:53:31 +01:00
Anca Iordache 5161d0fd07 Document `compose images` command
Signed-off-by: Anca Iordache <anca.iordache@docker.com>
2021-04-15 17:59:04 +02:00
Usha Mandya 354cf62ee2 Add initial updates for Apple silicon release
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-04-12 22:41:19 +01:00
Sebastiaan van Stijn 1898b1b09c
add buildx install/uninstall
these commands are hidden in the cli, but functional, and mentioned
in the "working with buildx" introduction.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-07 16:12:08 +02:00
Sebastiaan van Stijn 363327d576
Update buildx reference docs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-07 16:11:07 +02:00
Usha Mandya cc04246252 Consolidate Kube deploy docs
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-03-24 15:10:35 +00:00
Usha Mandya 5d495c3a7a
Merge pull request #12502 from usha-mandya/image-dashboard-patch
Add image management docs
2021-03-22 18:30:14 +00:00
Usha Mandya f38f8a9d77
Merge pull request #12390 from zappy-shu/HUB-5154-images-api
Add initial image dashboard API docs
2021-03-22 18:29:26 +00:00
Usha Mandya c2ff6bf292
Combine Windows install pages (#12531)
* Combine Windows install pages

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Apply suggestions from code review

Co-authored-by: Stefan Scherer <stefan.scherer@docker.com>

* Apply suggestions from code review

Co-authored-by: Stefan Scherer <stefan.scherer@docker.com>

* Some more minor updates to improve readability

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

Co-authored-by: Stefan Scherer <stefan.scherer@docker.com>
2021-03-19 22:49:11 +00:00
Usha Mandya e4a81ee3f7 Add image management docs
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-03-19 17:30:28 +00:00
Usha Mandya 855fdb40b0 _data/toc.yaml 2021-03-18 18:27:18 +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
Sebastiaan van Stijn 418f68ca86
engine: sync reference docs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-03-11 15:41:56 +01:00
Usha Mandya 41b2904738
Merge pull request #12466 from ndeloof/compose-cli
compose cli reference documentation
2021-03-10 11:41:38 +00:00
Sebastiaan van Stijn 203a4ee74b
Rewrite "save and restore data" section
This started as a "fix some links", but reading the section, I found various
issues that could use some improvement. After that, I noticed that both the
Windows and Mac pages had the same content, so I moved this to a common page
instead.

Note that there's still additional information that should likely be included
(and perhaps a rewrite into "per topic" headings (containers, images, ...).

Things that are missing;

- backup/restore swarmkit configs
- backup/restore swarmkit secrets
- backup/restore CLI configuration, trust data etc.

What I did in this pull request:

- recommend pushing images to Docker Hub as the default approach to back up
  images (but kept `docker image save` as an alternative)
- recommend `docker container commit` to save containers to an image, as doing
  so preserves both the container's configuration _and_ filesystem changes.
  `docker container export` only preserves the filesystem, but all other
  configuration is lost, which makes it hard to restore a container from it.
  Using `docker container commit` (committing the container to an image) also
  allows to follow the same procedure to backup containers as for images
  (both allowing them to be pushed to a registry, or to a file).
- added some information about "wether or not" containers should be backed
  up, as it may not be needed to back up containers if all data is stored
  in volumes (best practice).
- added some warnings regarding "sensitive data" (environment variables),
  and links to making repositories private before pushing.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-03-09 12:23:32 +01:00
Nicolas De Loof 4a68e6cca3
compose cli reference documentation
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-03-09 12:16:34 +01:00
Guillaume Tardif fd6a291c0b
Compose command doc (#12433)
* Compose in Docker CLI overview

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Add compatibility list page for compose command

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Apply suggestions from Usha

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

* Apply suggestions from Usha

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

* Latest update on compatibility list

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Add install instructions

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Suggestions by Marina

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Subsection for compose CLI Tech Preview

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-03-09 10:59:03 +00:00
Guillaume Tardif 5d4a84d638
Compose minor improvements (#12426)
* remove duplicate compose release notes in TOC

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Add link to awesome compose samples

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Minor style update

* Fix a typo

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-03-02 17:01:51 +00:00
Nick Adcock 82ed0e463d Add initial image dashboard API docs
Signed-off-by: Nick Adcock <nick.adcock@docker.com>
2021-02-25 15:29:56 +00:00
Sebastiaan van Stijn 8e0831729c
toc: move "post-install" out of "per-distro" submenu
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-02-25 11:30:22 +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
Akihiro Suda 6fec6ef0c3
engine/security: add more description about ssh://
Previously, the `ssh://` helper was only mentioned in `engine/security/index.md`.

The `ssh://` helper is now documented in "Protect the Docker daemon socket"
(`engine/security/protect-access.md`, nee `engine/security/https.md`).

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2021-02-10 19:06:09 +09:00
Usha Mandya 60624cfb4a Fix indentation, broken links
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-02-02 16:44:47 +00:00
Usha Mandya dc7352020e Get started docs improvements
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-02-02 12:51:46 +00:00
Usha Mandya c23d1daf63
Add Python get started docs (#12184)
* Add Python get started docs

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Address Anca's review comments

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Update pip to pip3

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Update pip freeze to pip3 freeze

Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-01-28 17:46:36 +00:00
Usha Mandya 8beb6ef084
Merge pull request #11844 from acran/master
Add documentation for Compose service profiles
2021-01-27 09:59:26 +00:00
Usha Mandya a63f01c9a9
Merge pull request #12179 from usha-mandya/audit-log-updates
Add docs for Audit log
2021-01-25 19:03:45 +00:00
Usha Mandya 1a7b55ec8e Add docs for Audit log
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-01-25 17:01:35 +00:00
Roman Anasal fab7cf6c9d Add Compose service profiles to navigation 2021-01-25 14:42:23 +01:00
Usha Mandya 4b59234515
Add combined faqs for Mac and Windows (#12153)
* Add combined faqs for Mac and Windows

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Update links from other pages to faqs

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Address review comments part-1

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Address feedback  on connecting to remote engine API

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Address Stephen's review comments

Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-01-22 16:17:53 +00:00
Usha Mandya 89c11854e9 Fix a typo in the toc
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-01-19 14:12:10 +00:00
Usha Mandya ba395bed07 Add reference architecture docs
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-01-18 12:07:55 +00:00
Sebastiaan van Stijn ad03c62012
Merge pull request #11936 from yaleman/yaleman-toc-1
Fix spelling error in TOC
2021-01-05 14:40:40 +01:00
Sebastiaan van Stijn e4ecf664d5
Merge pull request #11865 from gtardif/compose-cli-docs
Compose cli reference docs
2021-01-05 11:25:06 +01:00
Guillaume Tardif cd5bc70940 Include ACI/ECS reference docs from compose-cli and make them easier to find for docker users
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2021-01-04 16:16:12 +01:00
Brandon Mitchell d0e4e71e9d Fixing compose v3 navigation menu
Signed-off-by: Brandon Mitchell <git@bmitch.net>
2020-12-21 14:06:12 -05:00
James Hodgkinson 0068131f5e
Fix spelling error in TOC 2020-12-19 11:20:33 +10:00
Usha Mandya 2c8b4601fe
Merge pull request #11838 from nebuk89/master
Adding general docker getting started to docs
2020-12-18 13:12:19 +00:00
Usha Mandya ff13d70b9f Add tech preview docs for Apple M1
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2020-12-17 14:22:24 +00:00
James Ratliff 856a23616e
Adds Pricing & Pull Rate Limiting FAQs page (#11840)
* Adds Pricing & Pull Rate Limiting FAQs page

* Update docker-hub/billing/pricing-pull-rate-limit-faqs.md

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

* Update docker-hub/billing/pricing-pull-rate-limit-faqs.md

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

* Update docker-hub/billing/pricing-pull-rate-limit-faqs.md

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

* Update docker-hub/billing/pricing-pull-rate-limit-faqs.md

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

* Update docker-hub/billing/pricing-pull-rate-limit-faqs.md

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

* Update docker-hub/billing/pricing-pull-rate-limit-faqs.md

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

* Update docker-hub/billing/pricing-pull-rate-limit-faqs.md

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

* Update docker-hub/billing/pricing-pull-rate-limit-faqs.md

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>

* Moves content to existing FAQ file, removes redirect for faq.md

* Minor formatting updates

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2020-12-10 15:18:55 +00:00
Usha Mandya 78421ba741
Update docs for Desktop 3.0.0 release (#11859)
* Update docs for Desktop 3.0.0 release

* Update release notes

Signed-off-by: Usha Mandya <usha.mandya@docker.com>

* Update release notes and Settings screenshots

* Add download URLs and a new known issue

Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2020-12-10 15:01:02 +00:00
Sebastiaan van Stijn d6fee67243
Merge pull request #11861 from tiborvass/20.10-release-notes
Add engine 20.10.0 release notes
2020-12-09 02:27:09 +01:00
Tibor Vass 8f16fc161b Move main release notes to 19.03.md
Signed-off-by: Tibor Vass <tibor@docker.com>
2020-12-09 00:06:32 +00:00
Sebastiaan van Stijn 3ed7250644
Update engine reference for 20.10 release
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-12-09 00:50:04 +01:00
Sebastiaan van Stijn ec957f6802
Update CLI reference docs with latest changes from 19.03 branch
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-12-08 12:06:52 +01:00
Usha Mandya 669b610f05 Add ci/cd best practices guide
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2020-12-02 15:31:11 +00:00
Ben De St Paer-Gotch 838930ad96 Adding general docker getting started to docs 2020-12-02 13:08:51 +00:00