From 81909d70f0ec11b3b29e0b9c6ea8253f496ffca3 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Thu, 30 Apr 2020 00:17:28 +0200 Subject: [PATCH] docs: fix links, and minor markdown touch-ups Signed-off-by: Sebastiaan van Stijn (cherry picked from commit 116c9a1f591fa5f99c20fb218041042e7e3a1542) Signed-off-by: Sebastiaan van Stijn --- docs/reference/builder.md | 11 +++++++---- docs/reference/run.md | 6 +++--- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/reference/builder.md b/docs/reference/builder.md index 80ecdf80c19c..b998ea3a711b 100644 --- a/docs/reference/builder.md +++ b/docs/reference/builder.md @@ -54,6 +54,7 @@ Dockerfile. > > Do not use your root directory, `/`, as the `PATH` as it causes the build to > transfer the entire contents of your hard drive to the Docker daemon. +{:.warning} To use a file in the build context, the `Dockerfile` refers to the file specified in an instruction, for example, a `COPY` instruction. To increase the build's @@ -175,9 +176,9 @@ Docker runs instructions in a `Dockerfile` in order. A `Dockerfile` **must begin with a \`FROM\` instruction**. This may be after [parser directives](#parser-directives), [comments](#format), and globally scoped [ARGs](#arg). The `FROM` instruction specifies the [*Parent -Image*](glossary.md#parent-image) from which you are building. `FROM` -may only be preceded by one or more `ARG` instructions, which declare arguments -that are used in `FROM` lines in the `Dockerfile`. +Image*](https://docs.docker.com/glossary/#parent_image) from which you are +building. `FROM` may only be preceded by one or more `ARG` instructions, which +declare arguments that are used in `FROM` lines in the `Dockerfile`. Docker treats lines that *begin* with `#` as a comment, unless the line is a valid [parser directive](#parser-directives). A `#` marker anywhere @@ -1758,6 +1759,7 @@ ARG buildno > > Refer to the ["build images with BuildKit"](https://docs.docker.com/develop/develop-images/build_enhancements/#new-docker-build-secret-information) > section to learn about secure ways to use secrets when building images. +{:.warning} ### Default values @@ -2277,7 +2279,8 @@ This feature is only available when using the [BuildKit](#buildkit) backend. Docker build supports experimental features like cache mounts, build secrets and ssh forwarding that are enabled by using an external implementation of the -builder with a syntax directive. To learn about these features, [refer to the documentation in BuildKit repository](https://github.com/moby/buildkit/blob/master/frontend/dockerfile/docs/experimental.md). +builder with a syntax directive. To learn about these features, +[refer to the documentation in BuildKit repository](https://github.com/moby/buildkit/blob/master/frontend/dockerfile/docs/experimental.md). ## Dockerfile examples diff --git a/docs/reference/run.md b/docs/reference/run.md index dbdd85f76d90..7c3a2540a4f8 100644 --- a/docs/reference/run.md +++ b/docs/reference/run.md @@ -29,7 +29,7 @@ The basic `docker run` command takes this form: $ docker run [OPTIONS] IMAGE[:TAG|@DIGEST] [COMMAND] [ARG...] -The `docker run` command must specify an [*IMAGE*](glossary.md#image) +The `docker run` command must specify an [*IMAGE*](https://docs.docker.com/glossary/#image) to derive the container from. An image developer can define image defaults related to: @@ -45,8 +45,8 @@ operator's ability to override image and Docker runtime defaults is why [*run*](commandline/run.md) has more options than any other `docker` command. -To learn how to interpret the types of `[OPTIONS]`, see [*Option -types*](commandline/cli.md#option-types). +To learn how to interpret the types of `[OPTIONS]`, see +[*Option types*](commandline/cli.md#option-types). > **Note** >