Fix typos and minor language corrections
Remove unnecessary hyphens
Rewrite a few confusing phrases -- "ease later changes" is not clear so I rephrased it
Remove the ellipsis on line 561 as the final parameter. It was probably added to indicate a variable number of parameters. However, I checked the link given to "Dockerfile reference for the CMD instruction" and there was no ellipsis there, so I see no reason for it to be here. I considered replacing it with three dots and spaces inbetween to make it more visible, but I think the ellipsis is not really necessary.
**Issue**: An inline code block (single back-ticks) was too large, causing the width to be exceeded and a horizontal scrollbar to be included.
**Solution**: The inline code (single case) was transformed to a distinct code block (using triple back-ticks), which does not produce the same issue.
The issue was found for:
- Browser: Firefox Daylight 101.2.0
- OS: Android 10
- Phone resolution: 1440x2880 pixels
> When previewing the file on github, the inline code is properly split over multiple lines. However, this is not the case for the [docker docs webpage](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#user).
- 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>
When copying files to a destination directory, the classic builder requires
the destination to have a trailing slash (to indicate the target is a _directory_.
not a filename). BuildKit is a bit more flexible in this, and will assume the
target is a directory, but users following the example with buildkit disabled
might see an error message, e.g.:
Sending build context to Docker daemon 3.072kB
Step 1/2 : FROM busybox
---> 69593048aa3a
Step 2/2 : COPY *.go .
When using COPY with more than one source file, the destination must be a directory and end with a /
It doesn't hurt to be explicit, so this patch updates some examples to prevent
this.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The "hello-world" repository (somewhat intentionally) does not contain any instructions for building it, but the instructions to do so already followed this line, so this adjusts the wording to be more clear that the source code lives in the hello-world repository without implying that there are instructions for building there as well.
Signed-off-by: Tianon Gravi <admwiggin@gmail.com>
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>
* add compatibility notes for docker multistage build
add note that multistage docker builds are supported from version 17.05 and upwards.
(this is according to the release notes https://docs.docker.com/engine/release-notes/17.05/)
* Minor update
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
This is a bit of a draft, but I came across this issue in the documentation. When I searched for `docker apt-get` I found this page and copy-pasted the first example, but then I remembered it's best practice to install all packages at once and after that clear the `lists` to minimize the image size. Putting the example with all best practices first might help newer docker users to produce smaller images.
The `ENV key value` form can be ambiguous, for example, the following defines
a single env-variable (`ONE`) with value `"TWO= THREE=world"`:
ENV ONE TWO= THREE=world
While we cannot deprecate/remove that syntax (as it would break existing
Dockerfiles), we should reduce exposure of the format in our examples.
Also updating some code-blocks that were missing language-hints
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
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>
* 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>
- 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>
Chris Crone
Peter Hauke
Sebastiaan van Stijn
Craig Osterhout
David Karlsson
CrazyMax
Milan van Wouden
Finn Ellis
ceotoolsuite
Nathan Long
Simon Lieschke
Usha Mandya
Usha Mandya
Tianon Gravi
Alessandro Lenzen
Nils Breunese
Liran Tal
Kickimanjaro
Itamar Turner-Trauring
Mossroy
Jesper Rønn-Jensen
Henare Degan
Duncan Ogilvie
Sebastiaan van Stijn
ajay143444
Shivang Goswami
Jeff Anderson
lena-larionova