Commit Graph

186 Commits

Author SHA1 Message Date
CrazyMax cc0fc46783
jekyll(assets): move images to assets folder
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-05 15:49:23 +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
Carlos H Brandt 75adef65dd
Add link to Dockerfile/build reference (#12579)
* Add link to Dockerfile/build reference

This fixes #12578

* Update develop/index.md

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2022-04-22 10:42:21 +00: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
Usha Mandya 7b0e7b94f4 Update docker scan pages to include info on Log4J fix
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-12-15 11:42:37 +00: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 01a6d5d55f Update scan CTA
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-09-24 11:46:04 +01:00
Usha Mandya e73cdcf0f1 More updates related to subscription changes, address review comments
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-08-31 14:35:21 +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
Tomas Gonzalez 418814920d
Update index.md
minor typo... sync to snyk
2021-07-27 17:51:35 -04: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
Usha Mandya afd7c1fff9 Update scan CTA to use the new design
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-07-22 15:34:21 +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
Usha Mandya f5c6fe1357 Add CTA on Docker scan
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-07-16 15:29:46 +01: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
Usha Mandya eb50246437
Merge pull request #13016 from alenzen/patch
improve documentation
2021-06-25 12:07:25 +01:00
Usha Mandya e921987dcf
Merge pull request #12930 from przmv/patch-2
Fix links to glossary terms
2021-06-25 11:37:27 +01:00
Usha Mandya 1fffde4247 Add info on Snyk Advisor
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-06-15 15:56:53 +01: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
Petr Razumov d77568872b
Fix links to glossary terms 2021-06-02 00:42:40 +03:00
Usha Mandya 4219284bba Fix a typo
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-05-26 13:37:43 +01:00
Usha Mandya 5cf0154179 Add Docker Scan best practices guide
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2021-05-25 18:20:44 +01: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
Sebastiaan van Stijn f4ed09424b
move compose examples to the samples directory
Unifying all "examples" in this directory; some of these should still be
reviewed and/or removed in favor of examples from "awesome compose"

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-19 10:38:56 +02:00
Sebastiaan van Stijn e4455a5f8f
Add / update some redirects for old URLs, and move old engine examples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-19 10:38:52 +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
Usha Mandya 332f38eb12
Update develop/index.md
Co-authored-by: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>
2021-02-25 12:17:06 +00:00
Muhammad Tehami 97a48fa9b4 Add links to Docker Engine SDK and the HTTP API 2021-02-23 17:30:11 +05: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
lemonez 5b6824c105
Update dev-best-practices.md
minor typo fix
2020-11-06 07:52:32 -08: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
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
Nathan Long 349d17db12
Note that `ssh-add` may be needed 2020-10-05 15:33:03 -04:00