Commit Graph

177 Commits

Author SHA1 Message Date
Adisa Malik 309ebe05e8
Update inaccurate section headers for backing up/restoring volumes (#13860)
* Change section headers for backing up/restoring volumes to use "volume" instead of "container"

The section headers "Backup a container" and "Restore container from backup" are used as headers for sections that are actually about backing up and restoring volumes.

* Minor style update

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-11-19 14:37:46 +00:00
wood-push-melon 6c2a64086e
Correct the typo 2021-10-10 20:15:54 +08:00
Nicolaj Græsholt 8b618a6795
Add anonymous volumes autoremove info (#13471)
* Add anonymous volumes autoremove info

Anonymous volumes aren't removed if another container adopts them with `--volumes-from`, see: https://github.com/docker/docker.github.io/issues/13435

* Format Note

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-10-08 12:07:29 +01:00
Typing Turtle c1a35e1ba0
Minor `read-only` clarification (#13521)
* Minor `read-only` clarification

## Why

It was not obvious to me that `ro` is the shorthand form of `readonly`.

## Description

This adds a bit of text to explicitly state that `ro` is the shorthand form of `readonly` when using volumes

* Update storage/volumes.md

Co-authored-by: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
Co-authored-by: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>
2021-10-04 10:50:21 +01:00
Sebastiaan van Stijn 173d3c65f8
fix broken (anchor) links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-09-13 15:07:49 +02:00
cam 4bf71bbdc5
Fix broken link to Windows path troubleshooting (#13495)
* Fix broken link to Windows path troubleshooting

* Update the cross-reference

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-09-10 17:40:11 +01:00
Sebastiaan van Stijn fbf817d974
Merge pull request #13412 from thaJeztah/carry_13381_s390x_changes
[carry 13381] Updated docs for s390x for latest version
2021-08-27 10:10:56 +02:00
anujajakhade b781519e18 Updated docs for s390x for latest version
Signed-off-by: Anuja Jakhade <anujajakhade@gmail.com>
2021-08-20 04:36:10 +00:00
Frédéric Dalleau c1416c35ce
Document path conversion on Windows (#13331)
* Document path conversion on Windows

* Minor formatting and style updates

* desktop/windows: minor fixes in troubleshoot

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-08-17 12:03:20 +01:00
Sebastiaan van Stijn 1583678203
Add missing code-hints, and minor markdown edits
- 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>
2021-08-16 12:59:23 +02:00
Sebastiaan van Stijn 4afcaf3b2d
storage: use "console" for shell examples
This allows for easier copying of the commands, without selecting the
prompt.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-06 17:19:20 +02:00
Sebastiaan van Stijn f5e49b158b
rewrite storage-driver section
- Reduce use of "Community Edition", and some sections that were written
  for Docker Enterprise.
- Add notes about deprecation of AuFS in the overview.
- Update the storage driver index page to use BuildKit, and rephrase some
  bits that made assumptions about each Dockerfile instruction producing
  a new layer.
- Updated some examples to be usable on Docker Desktop, which does not
  provide direct access to the daemon's storage directoreis.
- Add some notes linking to relevant sections about formatting output.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-06 15:45:39 +02:00
Nirman Narang 055e6fd68a
DOCS: Added support for arch s390x for Ubuntu, RHEL and SLES
Added .md files for SLES and RHEL engine installation. Added indexing to _data/toc.yaml and engine/install/index.md. Modified engine/install/index.md, includes/install-script.md, engine/security/rootless.md, storage/storagedriver/device-mapper-driver.md, and storage/storagedriver/select-storage-driver.md to add info for added RHEL and SLES support. Modified engine/install/ubuntu.md to add s390x repos and other info. Added tab target for RHEL and SLES to engine/security/rootless.md along with other info.

Signed-off-by: Nirman Narang <narang@us.ibm.com>
2021-08-05 19:48:09 +02:00
Sebastiaan van Stijn e22984f7d4
use Dockerfile "syntax" directive in examples
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>
2021-04-20 10:19:12 +02:00
Sebastiaan van Stijn d95a4266ff
replace "output truncated" with special <...> (supported by "rouge")
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-03-02 15:02:21 +01:00
Lee Dale 96a4e1a430
Remove broken version based link to source. (#12328)
* Remove broken version based link to source.

Link to source container version based link that was broken. Propose to use non version based link.

Co-authored-by: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-02-19 15:03:02 +01:00
bizmate 80974031b6 Adding usage of CIFS mounts so it is clear how to connect to a Samba share also by using hostnames. 2021-02-10 09:00:29 +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
Sebastiaan van Stijn 33ad3d9bbf
Merge pull request #11042 from AkihiroSuda/prep-20-03
v20.10 docs for cgroup v2 and rootless
2020-12-09 01:05:54 +01:00
Akihiro Suda 1976c2178c
v20.10 docs for cgroup v2 and rootless
* Docker now supports cgroup v2 (both rootful and rootless)
* Rootless mode graduated from experimental
* New storage driver: fuse-overlayfs

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2020-11-12 12:47:16 +09:00
aliray 9a416422b5
command error
"volume-opt=o=10.0.0.10,rw,nfsvers=4,async" should be  "volume-opt=o=addr=10.0.0.10,rw,nfsvers=4,async"
2020-11-06 18:51:23 +08:00
Daido Shota 2cb92e074f
Fix broken links in storage/volumes.md 2020-10-31 22:39:52 +09:00
Sebastiaan van Stijn 2ce808edc0
Remove references to obsolete engine versions
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-26 15:45:07 +01:00
Sebastiaan van Stijn 82b0e8cb84
Merge pull request #11577 from mrl5/GH-11576
docker/docker.github.io#11576 fixed keywords for storage/storagedriver
2020-10-20 19:08:42 +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
Usha Mandya 0e8c1b63ff
Minor style updates 2020-10-20 11:18:18 +01:00
mrl5 9242ec4525
docker/docker.github.io#11576 fixed keywords for storage/storagedriver 2020-10-19 21:17:30 +02:00
David Scott 1cfabd89e4 storage: mention volumes in compose and link to compose docs
Signed-off-by: David Scott <dave.scott@docker.com>
2020-10-19 11:43:55 +01:00
David Scott 4f181a683f volumes: mention Desktop-specific benefits
Signed-off-by: David Scott <dave.scott@docker.com>
2020-10-19 11:20:20 +01:00
David Scott 83f6cc1b3f Add Desktop examples to "Good use cases for volumes"
Signed-off-by: David Scott <dave.scott@docker.com>
2020-10-19 11:13:57 +01: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 0bbe9c32fb
Fix various broken links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-07 12:49:22 +02:00
jeffw387 f68b5bef8c
Update zfs-driver.md
Typo/misspelling
2020-09-22 20:48:12 -07:00
Jeremy Lin 24e175f880
bind-mounts.md: source/host path must be absolute 2020-09-19 02:19:25 -07:00
Tega Agbanagba 673872887a
Update index.md 2020-09-14 21:13:36 +01:00
Tega Agbanagba 5bf5f94c32
Container base layer in jpg is 15.04
Update the release version of base layer of container image to match what's in the jpg image files.
2020-09-14 21:05:09 +01:00
Kenyon Ralph fc40ccf269
btrfs-driver.md: remove unneeded use of sudo and cat 2020-08-12 22:48:37 -07:00
Leandro Gomez 0d2d153f7e We should refer to the read-only layer. There's no thing as the write only layer 2020-06-29 11:06:46 -03:00
Usha Mandya df3bd29a3e Remove links to success articles 2020-06-05 17:14:49 +01:00
Sebastiaan van Stijn 637bf1e066
storage: use relative markdown links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-23 13:03:46 +02:00
Sebastiaan van Stijn d813acb6e1
Engine: reorganize install topic
- Move getting started overview to /get-started/overview/
- Move engine installation files under /engine/
- Redirect the top-level /install/ to /get-docker/
- Updated titles in left-hand navigation
- Added back some pages to the navigation that were
  currently not included.
- Reduce some steps in the installation pages
- Move devicemapper prerequisites to the devicemapper
  storage driver page.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-06 10:50:28 +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
jureaky cdee2dd67c
Fix wrong device path in NFSv4 volume example (#10429)
In section Create a service which creates an NFS volume,
NFSv3 command states right device path(:/var/docker-nfs),
but NFSv4 command is not configured to refer that path.
So updated the path.
2020-03-31 17:13:08 +01:00
Sebastiaan van Stijn 14bbe621e5
Update markdown language hints to work with "rouge"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-17 14:49:51 +01:00
谭九鼎 8bf6e38700
Chore: Fix indentation 2020-03-07 21:13:11 +08:00
Dawn-Docker 3c54d2ff9c
Update toc (#9819) 2019-11-08 08:13:40 -08:00
Sergey Kolesnikov 806ed5f4e8 add file name to step description (#9688)
* add file name to step description

add file name to step description

* Minor grammar fix
2019-10-21 08:58:08 -07:00
Sergey Kolesnikov 246499390d
Update tmpfs.md - fix incorrect tmpfs-type option
Incorrect "tmpfs-type" option changed to "tmpfs-size"
2019-10-19 21:44:43 +03:00
Adam Brodziak d5489b4462 Correct in-page link (#9542) 2019-10-02 16:18:30 -07:00
Nikita Potapenko 578cd24e37
Update devicemapper path 2019-09-16 15:18:26 +03:00