Commit Graph

54028 Commits

Author SHA1 Message Date
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
Usha Mandya 41b3a10922
Merge pull request #10464 from djs55/DESKTOP-2502-filesharing-part1
Improve Desktop filesharing docs (stable 2.2.0.0)
2020-03-17 10:49:31 +00:00
David Scott f2545c46fa Win: fix symlink link and insert a comma
Ironically the link to the symlink section was broken.

This patch fixes the problems spotted by @usha-mandya

Signed-off-by: David Scott <dave.scott@docker.com>
2020-03-17 10:13:43 +00:00
David Scott 8c9ca8856d Win: remove apology about inotify
It works now!

Signed-off-by: David Scott <dave.scott@docker.com>
2020-03-16 20:23:30 +00:00
David Scott 2a88d9a20b Win: update file sharing section for FUSE
- Explain what this feature is for: mainly source code and not databases
- Remove Samba-specific locking
- Explain what's going on with case insensitivity
- Remove mention of Docker Machine

Signed-off-by: David Scott <dave.scott@docker.com>
2020-03-16 20:23:30 +00:00
David Scott acc4c73e88 Win: describe Windows symlinks
Signed-off-by: David Scott <dave.scott@docker.com>
2020-03-16 20:23:24 +00:00
David Scott e53ad3f2ae Mac: remove limitation about nested folder
Signed-off-by: David Scott <dave.scott@docker.com>
2020-03-16 18:40:20 +00:00
David Scott d511f4ac33 Mac: update file sharing folder list and error message
Signed-off-by: David Scott <dave.scott@docker.com>
2020-03-16 18:40:00 +00:00
Usha Mandya aed15be190
Merge pull request #10461 from thaJeztah/update_reference_layout
Update layout of reference pages
2020-03-16 15:24:06 +00:00
Sebastiaan van Stijn e6a8b7e5e4
Reference: add anchor-link to examples section
Some commands provide a long list of options, which may
"hide" the examples section. To help discoverability, add
an anchor-link to the examples section (if present).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-16 13:13:51 +01:00
Sebastiaan van Stijn 252db13907
Reference: move "extended description" above "options"
The extended description usually provides a good introduction to
the command, which likely is useful to read before heading to
more detailed information (such as "which options does this command
have")

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-16 13:09:27 +01:00
Sebastiaan van Stijn a76cbe68a7
Reference: move "parent", "child", and "related" commands to bottom
For some commands, the list of "related" commands is lenghty, therefore
hiding the extended description and examples below the fold, which is
not ideal.

This patch moves the "parent command", "child commands", and "related
commands" sections to the bottom of the page.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-16 13:06:48 +01:00
Usha Mandya 60cf5650bf
Merge pull request #10456 from thaJeztah/update_engine_reference
Update engine cli reference to fix some missing descriptions
2020-03-16 11:54:05 +00:00
Sebastiaan van Stijn c588fbe5ca
Update engine cli reference to fix some missing descriptions
Regenerated the yaml files after fixing a bug in the generator
script that caused some extended descriptions and examples
to not be included.

Also fixes the generated YAML to use the "long form" format,
instead of the compact format (where newlines were encoded
as `\n`). This makes the YAML more "human readable", and makes
reviewing updates easier.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-16 12:39:12 +01:00
Usha Mandya ba34dc3024
Merge pull request #10446 from thaJeztah/move_glossary
toc: move glossary, and reorganize "reference" section
2020-03-16 11:27:02 +00:00
Usha Mandya 0307da4758
Merge pull request #10459 from usha-mandya/desktop-2204-patch
Update Desktop release notes
2020-03-16 10:28:11 +00:00
Usha Mandya 6445d7c44b
Merge pull request #10137 from Weyx/patch-1
Update minimal MacOS Version requirement
2020-03-16 10:07:45 +00:00
Usha Mandya a2edce579d
Merge pull request #10458 from thaJeztah/update_gh_pages
Dockerfile: update to github-pages 198, and some other fixes/improvements
2020-03-16 09:59:39 +00:00
Usha Mandya 2eeee59f4d Update Desktop release notes 2020-03-16 09:47:50 +00:00
Sebastiaan van Stijn 2f2ce53a51
Dockerfile: update to gh-pages 198
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-15 22:44:44 +01:00
Sebastiaan van Stijn b7d91ae175
Dockerfile: use alpine for fetching external resources
This step does not depend on Jekyll, so using a minimal
base-image.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-15 22:43:11 +01:00
Sebastiaan van Stijn 07d410de21
Dockerfile: fix links in same step as generating the files
For intermediate stages, it's generally ok to perform steps
separately, however in this case, fixing the links would
happen every time the HTML was generated, so we might as
well do it in the same step, to reduce the size of the local
build cache, as it was adding 54MB for each rebuild:

    IMAGE               CREATED             CREATED BY                                      SIZE                COMMENT
    7d97d86ae290        3 minutes ago       RUN /bin/sh -c find ${TARGET} -type f -name …   53.7MB              buildkit.dockerfile.v0
    <missing>           3 minutes ago       RUN /bin/sh -c jekyll build -d ${TARGET} # b…   375MB               buildkit.dockerfile.v0

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-15 18:25:30 +01:00
Sebastiaan van Stijn a5ab6fa4f8
fetch-upstream-resources: fix .svn cleanup step
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-15 18:22:56 +01:00
Sebastiaan van Stijn 8eb6ee6cb8
Add more files to .dockerignore
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-15 18:22:16 +01:00
Roch Moreau 825e94a957
Update toolbox_install_mac.md
Edited documentation to match new minimal MacOS version requirement : 10.13.0 High Sierra
2020-03-14 17:20:35 +01:00
Sebastiaan van Stijn 6097d48eaa
Don't nest Dockerfile and Compose-file reference
The list of items in the left-hand menu is not too long,
so to improve discoverability, moving these two sections
one level "up".

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-14 09:38:52 +01:00
Sebastiaan van Stijn a5830d0c16
Move "File formats" under "CLI and API reference"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-14 09:38:46 +01:00
Sebastiaan van Stijn c870e75a93
Rename "Command-line reference" and "API reference"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-14 09:37:24 +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
Sebastiaan van Stijn 501b13e68c
docs.js: be slightly more consistent with double/single quotes
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-14 09:10:35 +01:00
Sebastiaan van Stijn 0871044294
docs.js: remove dead code and debug comments
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-14 09:10:32 +01:00
Sebastiaan van Stijn 65938675db
docs.js: fix some linting issues
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-14 09:10:30 +01:00
Sebastiaan van Stijn 923f7012d4
docs.js: reformat code
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-14 09:10:27 +01:00
Stefan Scherer 64495ca279
Merge pull request #10442 from StefanScherer/upload-only-in-upstream-repo
ci: Upload docs only in upstream repo
2020-03-13 19:04:30 +01:00
Stefan Scherer 754bcd08e0
Skip more files in final site
Signed-off-by: Stefan Scherer <stefan.scherer@docker.com>
2020-03-13 17:55:19 +01:00
Stefan Scherer e26be9456c
Upload docs only in upstream repo
Signed-off-by: Stefan Scherer <stefan.scherer@docker.com>
2020-03-13 14:44:05 +01:00
Sebastiaan van Stijn 35a7d71f2f
Merge pull request #10437 from pkennedyr/patch-7
Removed "Create Organization" screenshot
2020-03-13 11:48:24 +01:00
Sebastiaan van Stijn 496ca12202
Merge pull request #10445 from usha-mandya/hub-screenshots-patch
Delete Hub org screenshots
2020-03-13 11:48:01 +01:00
Usha Mandya 1015acbd40 delete Hub org screenshots 2020-03-13 10:14:33 +00:00
Usha Mandya 4e2d1ea427
update Desktop release date (#10441) 2020-03-13 10:09:09 +00:00
Stefan Scherer d1edcc8b8c
Merge pull request #10400 from docker/gh-mster-s3
ci: copy static files to s3 on master build
2020-03-13 07:50:26 +01:00
Ryan Kennedy feff7a41e0
Removed "Create Organization" screenshot
Removed "Create Organization" screenshot for consistency with the new org creation UI updates.
2020-03-12 14:23:29 -07:00
Usha Mandya c28bd02332
Release notes for Desktop Stable 2.2.0.4 (#10408)
* Release notes for Desktop Stable 2.2.0.4

* update release date and download URLs

* add note on disk image resize

* clarify disk size
2020-03-12 17:58:12 +00:00
Usha Mandya ce174ea742
DDE 2.1.0.9 release notes (#10436) 2020-03-12 17:38:49 +00:00
Usha Mandya e7df964023
Merge pull request #10433 from hochan222/patch-1
docker-compose documentation version
2020-03-12 15:30:46 +00:00
Stefan Scherer 6f31cb331c
Simplify build, invalidate cache after upload
Signed-off-by: Stefan Scherer <stefan.scherer@docker.com>
2020-03-12 16:06:55 +01:00
Jérémie Drouet 3b635b1996
ci: copy static files to s3 on master build
Signed-off-by: Jérémie Drouet <jeremie.drouet@gmail.com>
2020-03-12 15:52:22 +01:00