Commit Graph

54041 Commits

Author SHA1 Message Date
Sebastiaan van Stijn
43bba8317c Develop with Docker: remove nesting, and some restructuring
- Remove the "Develop your apps on Docker" section, as there
  was only a single section.
- Shorten titles in the navigation: the page itself still
  has the full title. Some titles also didn't match the
  title on the page.
- Changed "Docker build enhancements for 18.09" to
  "Build images with BuildKit" to help discovery of the
  BuildKit back-end.
- Some minor (Markdown) touch-ups of the BuildKit topic.
- Moved "Create a base image" lower in the navigation,
  because it's an advanced topic that most users won't
  be using (generally, using the official base images
  from Docker Hub would be recommended).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-19 11:55:22 +01:00
Usha Mandya
d34430b425 Merge pull request #10472 from thaJeztah/reference_code_hints
update code-hints in engine reference
2020-03-18 09:57:38 +00:00
Sebastiaan van Stijn
421e4ca41d update code-hints in engine reference
Regenerated the yaml files with the latest version from the
19.03 branch on docker/cli

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-17 17:06:42 +01:00
Usha Mandya
30ea7f2562 Merge pull request #10467 from thaJeztah/update_compose_file_reference
Rewrite and cleaning-up compose file reference
2020-03-17 15:22:13 +00:00
Usha Mandya
6870e3a90d Merge pull request #10468 from thaJeztah/update_code_hints
Update code hints to better work with "rouge"
2020-03-17 15:21:22 +00:00
Usha Mandya
2fc5b784f1 Merge pull request #10469 from thaJeztah/update_edit_source_comments
reference: update "generated docs" comment
2020-03-17 14:41:14 +00:00
Sebastiaan van Stijn
e4c227b0c9 reference: update "generated docs" comment
The "Sorry, but" was bothering me; no need to apologise :D

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-17 15:26:06 +01:00
Sebastiaan van Stijn
19c6cb8f1c Markdown: fix some code-hints
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-17 14:50:31 +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
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
Usha Mandya
8b24f7eeef Merge pull request #10466 from usha-mandya/10463-patch
Fix Dashboard links
2020-03-17 13:13:28 +00: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
e8893cafde Fix Dashboard links 2020-03-17 11:28:54 +00: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