Commit Graph

121 Commits

Author SHA1 Message Date
Chris Crone 0b663956f1
develop: Update multi-stage example to use go mod (#17829)
Signed-off-by: Chris Crone <christopher.crone@docker.com>
2023-07-26 16:14:47 -07:00
Peter Hauke 58b681b068
Fix typos and rewrite a few confusing phrases (#17807)
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.
2023-07-24 10:07:32 +01:00
Sebastiaan van Stijn a1c30d0af9
remove ubuntu 18.04 from examples
Ubuntu 18.04 reached end of standard support, so remove it from examples
in our docs.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-06-21 22:26:03 +02:00
Craig Osterhout 1d1cf4251e
Refresh image best practices (#16603)
* Refresh style for image best practices
2023-01-31 13:32:19 -08:00
David Karlsson bad2be0b64
build: tidy 'develop' section in guides (#16196)
Signed-off-by: David Karlsson <david.karlsson@docker.com>
2022-11-23 16:53:04 +01:00
CrazyMax ba8ae8535f
build: context page
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-11-07 11:15:30 +01:00
CrazyMax 271f8c3de5
build: merge build enhancements page in build section
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-10-25 19:46:23 +02:00
CrazyMax d775c8a6bf
build: multi-stage builds
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-15 13:37:37 +02:00
Milan van Wouden 67e9850c77
Fix horizontal scroll for mobile view
**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).
2022-06-24 13:31:30 +02:00
Finn Ellis 0508c664d2
Directories need the executable bit set. 2022-02-17 15:40:55 -08:00
ceotoolsuite 6cd34046ae
line 213, grammer
The other commands "will have"
vs
The other commands "have will"
2022-02-02 15:51:50 -06:00
Nathan Long 6e89c9daa3
Clarify that `--ssh default` uses `$SSH_AUTH_SOCK` (#12472)
* Clarify that `--ssh default` uses `$SSH_AUTH_SOCK`

I surmised this from [this post](https://medium.com/@tonistiigi/build-secrets-and-ssh-forwarding-in-docker-18-09-ae8161d066) and experimentation shows that the two commands do the same thing.

* Rework section to be more step-by-step

* Describe namespacing sockets

* PR feedback
2022-01-19 23:29:33 +05:30
Sebastiaan van Stijn df6a3281b9
Add some additional redirects for old URLs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-12-20 12:37:21 +01:00
Simon Lieschke 816426daf6
Link to detail about deploying a registry server (#13854)
* Link to detail about deploying a registry server

* Update link format

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-11-22 10:39:57 +00:00
Usha Mandya b3e792e495 Update Docker official images and DVPP references
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-08-19 00:01:01 +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 ba54a6519e
develop/develop-images: 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:55 +02:00
Usha Mandya f857e80221
Merge pull request #12938 from lirantal/patch-1
Feat: adding Node.js specific learning resources for developers building with Docker
2021-07-23 10:47:08 +01:00
Sebastiaan van Stijn 5011f61213
Fix Dockerfile COPY/ADD examples without a trailing slash
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>
2021-07-21 12:03:31 +02:00
Tianon Gravi 8219af3049 Update hello-world ref to clarify it is source only
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>
2021-07-06 11:03:50 -07:00
Alessandro Lenzen 1ef73b3a8a fix segfault 2021-06-14 16:21:25 +02:00
Alessandro Lenzen c01d6232da update example from xenial/16.04 to focal/20.04 2021-06-14 16:20:26 +02:00
Alessandro Lenzen 987c4a9357 fix links to glossary 2021-06-14 16:06:55 +02:00
Nils Breunese f21afebf4b
Alpine Linux is no longer under 5 MB
`alpine:latest` is currently 5.61 MB.
2021-06-08 13:54:31 +02:00
Liran Tal 8e80ec3dc0
Feat: adding Node.js specific learn resources 2021-06-02 17:32:45 +03:00
Kickimanjaro 0d5c87d584
#12800
This initially looked like a typo (reported in #12800) but I believe it is actually just an extra word that can be removed.
2021-05-05 10:43:19 -06:00
Usha Mandya f47930bcb0
Merge branch 'master' into build-secrets 2021-04-23 10:26:25 +01: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
Chris Crone fc7a472277 develop.build: Update secrets example
Signed-off-by: Chris Crone <christopher.crone@docker.com>
2021-04-16 19:29:21 +02:00
Itamar Turner-Trauring bce3cbf09d
Stop telling people not to install security updates 2021-03-25 08:41:05 -04:00
Mossroy b968f80922
Fix minor typo in example of documentation
I suppose the directory where to extract postgresql should be called postgres instead of postgress
2021-03-12 22:01:48 +01:00
Jesper Rønn-Jensen 2ef942f78b
Add compatibility notes for docker multistage build (#12379)
* 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>
2021-03-05 14:56:50 +00:00
Henare Degan 8889138246
Fix typo in Dockerfile Best Practices ENV section
The example below this change shows that the ENV value can be dumped so I think this was a typo saying that the ENV value can't be dumped.
2021-02-10 14:14:40 +11:00
Sebastiaan van Stijn 340fe84d1b
Update links to mkimage example scripts
Link to the contrib directory instead of individual scripts.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-01-05 14:55:58 +01:00
Usha Mandya 3fd2cb1e10
Merge pull request #11480 from nathanl/patch-1
Note that `ssh-add` may be needed
2020-11-04 15:17:50 +00: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 c119ed174e
Use https:// for links and examples
Found these using `http://[^lp10\*`<][^o]` (to exclude "localhost" and IP-addresses)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-13 12:09:11 +02:00
Nathan Long 349d17db12
Note that `ssh-add` may be needed 2020-10-05 15:33:03 -04:00
Duncan Ogilvie 62cf39dfbf
Make first apt example follow all best practices
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.
2020-09-28 22:55:35 +02:00
Sebastiaan van Stijn f6adc80d9a
remove examples for ENV key value without '='
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>
2020-09-23 15:16:35 +02:00
Sebastiaan van Stijn 3e767a72b3
Update architectures in matrix (#10999)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-06-16 14:39:07 +01:00
Sebastiaan van Stijn 9cd60d843e
develop: use relative markdown links
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>
2020-04-23 13:03:15 +02:00
ajay143444 21a633cd59
changed lots more to lots of (#10664)
changed lots more to lots of
2020-04-22 09:10:24 +01:00
ajay143444 7bd9befce0
contained by changed to contained in (#10663)
contained by changed to contained in
2020-04-22 09:09:22 +01: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
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
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
Shivang Goswami 94879d3ac2
In line 657,it should be can't instead of can
"Can" in place of "can't" is making the meaning of the paragraph confusing.In additional,it is in contrast with the example provided.
2019-12-24 22:33:28 +05:30
Jeff Anderson eeea0d586a Call out FROM can take a previous stage (#9566)
The included example could be improved with a more concrete use case, but illustrates the capability as is.
2019-12-09 10:48:45 +00:00
lena-larionova 54ca6a523b
Fixing glossary links (#9812)
Signed-off-by: Lena Larionova <lena.larionova@docker.com>
2019-11-06 11:00:13 -08:00