docs: update links and layout

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
docker · Oct 7, 2022 · 871b930 · 871b930
1 parent 105bf59
commit 871b930
Show file tree

Hide file tree

Showing 22 changed files with 155 additions and 138 deletions.
diff --git a/README.md b/README.md
diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md
@@ -16,7 +16,7 @@ While pushing to a registry, you may encounter these kinds of issues:
 * `unexpected response: 401 Unauthorized`
 
 These issues are not directly related to this action but are rather linked to
-[buildx](https://github.com/docker/buildx), [buildkit](https://github.com/moby/buildkit),
+[Buildx](https://github.com/docker/buildx), [BuildKit](https://github.com/moby/buildkit),
 [containerd](https://github.com/containerd/containerd) or the registry on which
 you're pushing your image. The quality of error message depends on the registry
 and are usually not very informative.
@@ -29,7 +29,7 @@ action step and attach BuildKit container logs to your issue.
 ### With containerd
 
 Next you can test pushing with [containerd action](https://github.com/crazy-max/ghaction-setup-containerd)
-using the following workflow. If it works then open an issue on [buildkit](https://github.com/moby/buildkit)
+using the following workflow. If it works then open an issue on [BuildKit](https://github.com/moby/buildkit)
 repository.
 
 ```yaml

diff --git a/dev.Dockerfile b/dev.Dockerfile
@@ -1,4 +1,4 @@
-# syntax=docker/dockerfile:1.4
+# syntax=docker/dockerfile:1
 
 ARG NODE_VERSION=16
 ARG DOCKER_VERSION=20.10.13

diff --git a/docs/advanced/cache.md b/docs/advanced/cache.md
@@ -6,11 +6,14 @@
   * [Cache backend API](#cache-backend-api)
   * [Local cache](#local-cache)
 
-> More info about cache on [BuildKit](https://github.com/moby/buildkit#export-cache) and [Buildx](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#cache-from) repositories.
+> **Note**
+>
+> See [our guide](https://github.com/docker/buildx/blob/master/docs/guides/cache/index.md)
+> for more details about cache storage backends.
 
 ## Inline cache
 
-In most cases you want to use the [`type=inline` cache exporter](https://github.com/moby/buildkit#inline-push-image-and-cache-together).
+In most cases you want to use the [`type=inline` cache exporter](https://github.com/docker/buildx/blob/master/docs/guides/cache/inline.md).
 However, note that the `inline` cache exporter only supports `min` cache mode. To enable `max` cache mode, push the
 image and the cache separately by using the `registry` cache exporter as shown in the [next example](#registry-cache).
 
@@ -33,7 +36,7 @@ jobs:
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
       -
-        name: Login to DockerHub
+        name: Login to Docker Hub
         uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
@@ -52,7 +55,7 @@ jobs:
 ## Registry cache
 
 You can import/export cache from a cache manifest or (special) image configuration on the registry with the
-[`type=registry` cache exporter](https://github.com/moby/buildkit/tree/master#registry-push-image-and-cache-separately).
+[`type=registry` cache exporter](https://github.com/docker/buildx/blob/master/docs/guides/cache/registry.md).
 
 ```yaml
 name: ci
@@ -73,7 +76,7 @@ jobs:
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
       -
-        name: Login to DockerHub
+        name: Login to Docker Hub
         uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
@@ -93,15 +96,17 @@ jobs:
 
 ### Cache backend API
 
-> :test_tube: This cache exporter is considered EXPERIMENTAL until further notice. Please provide feedback on
-> [BuildKit repository](https://github.com/moby/buildkit) if you encounter any issues.
-
-Since [buildx 0.6.0](https://github.com/docker/buildx/releases/tag/v0.6.0) and [BuildKit 0.9.0](https://github.com/moby/buildkit/releases/tag/v0.9.0),
-you can use the [`type=gha` cache exporter](https://github.com/moby/buildkit/tree/master#github-actions-cache-experimental).
-
-GitHub Actions cache exporter backend uses the [GitHub Cache API](https://github.com/tonistiigi/go-actions-cache/blob/master/api.md)
-to fetch and upload cache blobs. That's why this type of cache should be exclusively used in a GitHub Action workflow
-as the `url` (`$ACTIONS_CACHE_URL`) and `token` (`$ACTIONS_RUNTIME_TOKEN`) attributes are populated when a workflow
+> **Warning**
+>
+> This cache exporter is considered EXPERIMENTAL until further notice. Please
+> provide feedback on [BuildKit repository](https://github.com/moby/buildkit)
+> if you encounter any issues.
+
+[GitHub Actions cache exporter](https://github.com/docker/buildx/blob/master/docs/guides/cache/gha.md)
+backend uses the [GitHub Cache API](https://github.com/tonistiigi/go-actions-cache/blob/master/api.md)
+to fetch and upload cache blobs. That's why this type of cache should be
+exclusively used in a GitHub Action workflow as the `url` (`$ACTIONS_CACHE_URL`)
+and `token` (`$ACTIONS_RUNTIME_TOKEN`) attributes are populated when a workflow
 is started.
 
 ```yaml
@@ -123,7 +128,7 @@ jobs:
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
       -
-        name: Login to DockerHub
+        name: Login to Docker Hub
         uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
@@ -141,11 +146,13 @@ jobs:
 
 ### Local cache
 
-> :warning: At the moment caches are copied over the existing cache so it [keeps growing](https://github.com/docker/build-push-action/issues/252).
-> The `Move cache` step is used as a temporary fix (see https://github.com/moby/buildkit/issues/1896).
+> **Warning**
+>
+> At the moment caches are copied over the existing cache, so it [keeps growing](https://github.com/docker/build-push-action/issues/252).
+> The `Move cache` step is used as a workaround (see [moby/buildkit#1896](https://github.com/moby/buildkit/issues/1896) for more info).
 
-You can also leverage [GitHub cache](https://docs.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows)
-using [actions/cache](https://github.com/actions/cache) and [`type=local` cache exporter](https://github.com/moby/buildkit#local-directory-1)
+You can also leverage [GitHub cache](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows)
+using the [actions/cache](https://github.com/actions/cache) and [`type=local` cache exporter](https://github.com/docker/buildx/blob/master/docs/guides/cache/local.md)
 with this action:
 
 ```yaml
@@ -175,7 +182,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-buildx-
       -
-        name: Login to DockerHub
+        name: Login to Docker Hub
         uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}

diff --git a/docs/advanced/dockerhub-desc.md b/docs/advanced/dockerhub-desc.md
@@ -1,7 +1,7 @@
-# Update DockerHub repo description
+# Update Docker Hub repo description
 
-You can update the [DockerHub repository description](https://docs.docker.com/docker-hub/repos/) using
-a third party action called [DockerHub Description](https://github.com/peter-evans/dockerhub-description)
+You can update the [Docker Hub repository description](https://docs.docker.com/docker-hub/repos/)
+using a third party action called [Docker Hub Description](https://github.com/peter-evans/dockerhub-description)
 with this action:
 
 ```yaml
@@ -26,7 +26,7 @@ jobs:
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
       -
-        name: Login to DockerHub
+        name: Login to Docker Hub
         uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}

diff --git a/docs/advanced/local-registry.md b/docs/advanced/local-registry.md
@@ -1,6 +1,7 @@
 # Local registry
 
-For testing purposes you may need to create a [local registry](https://hub.docker.com/_/registry) to push images into:
+For testing purposes you may need to create a [local registry](https://hub.docker.com/_/registry)
+to push images into:
 
 ```yaml
 name: ci

diff --git a/docs/advanced/multi-platform.md b/docs/advanced/multi-platform.md
@@ -1,10 +1,14 @@
 # Multi-platform image
 
-You can build multi-platform images using the [`platforms` input](../../README.md#inputs) as described below.
+You can build [multi-platform images](https://docs.docker.com/build/building/multi-platform/)
+using the [`platforms` input](../../README.md#inputs) as described below.
 
-> :bulb: List of available platforms will be displayed and available through our [setup-buildx](https://github.com/docker/setup-buildx-action#about) action.
-
-> :bulb: If you want support for more platforms, you can use QEMU with our [setup-qemu](https://github.com/docker/setup-qemu-action) action.
+> **Note**
+>
+> * List of available platforms will be displayed and available through our
+>   [setup-buildx](https://github.com/docker/setup-buildx-action#about) action.
+> * If you want support for more platforms, you can use QEMU with our
+>   [setup-qemu](https://github.com/docker/setup-qemu-action) action.
 
 ```yaml
 name: ci
@@ -28,7 +32,7 @@ jobs:
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
       -
-        name: Login to DockerHub
+        name: Login to Docker Hub
         uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}

diff --git a/docs/advanced/named-contexts.md b/docs/advanced/named-contexts.md
@@ -7,6 +7,9 @@ Dockerfile defines a stage with the same name it is overwritten.
 This can be useful with GitHub Actions to reuse results from other builds or
 pin an image to a spcific tag in your workflow.
 
+* [Pin image to a specific tag](#pin-image-to-a-specific-tag)
+* [Usage of the built image in other build steps](#usage-of-the-built-image-in-other-build-steps)
+
 ## Pin image to a specific tag
 
 Replace `alpine:latest` with a pinned one:

diff --git a/docs/advanced/push-multi-registries.md b/docs/advanced/push-multi-registries.md
@@ -1,12 +1,8 @@
 # Push to multi-registries
 
-* [Docker Hub and GHCR](#docker-hub-and-ghcr)
-
-## Docker Hub and GHCR
-
-The following workflow will connect you to [DockerHub](https://github.com/docker/login-action#dockerhub)
-and [GitHub Container Registry](https://github.com/docker/login-action#github-container-registry) and push the
-image to these registries.
+The following workflow will connect you to [Docker Hub](https://github.com/docker/login-action#dockerhub)
+and [GitHub Container Registry](https://github.com/docker/login-action#github-container-registry)
+and push the image to these registries:
 
 ```yaml
 name: ci
@@ -30,7 +26,7 @@ jobs:
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
       -
-        name: Login to DockerHub
+        name: Login to Docker Hub
         uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}

diff --git a/docs/advanced/secrets.md b/docs/advanced/secrets.md
@@ -1,20 +1,19 @@
 # Secrets
 
-In the following example we will expose and use the [GITHUB_TOKEN secret](https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret)
+In the following example we will expose and use the [GITHUB_TOKEN secret](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret)
 as provided by GitHub in your workflow.
 
 First let's create our `Dockerfile` to use our secret:
 
-```Dockerfile
-#syntax=docker/dockerfile:1.2
-
+```dockerfile
+# syntax=docker/dockerfile:1
 FROM alpine
 RUN --mount=type=secret,id=github_token \
   cat /run/secrets/github_token
 ```
 
-As you can see we have named our secret `github_token`. Here is the workflow you can use to expose this secret using
-the [`secrets` input](../../README.md#inputs):
+As you can see we have named our secret `github_token`. Here is the workflow
+you can use to expose this secret using the [`secrets` input](../../README.md#inputs):
 
 ```yaml
 name: ci
@@ -48,14 +47,17 @@ jobs:
             "github_token=${{ secrets.GITHUB_TOKEN }}"
 ```
 
-> :bulb: You can also expose a secret file to the build with [`secret-files`](../../README.md#inputs) input:
+> **Note**
+>
+> You can also expose a secret file to the build with the [`secret-files`](../../README.md#inputs) input:
 > ```yaml
 > secret-files: |
 >   "MY_SECRET=./secret.txt"
 > ```
 
-If you're using [GitHub secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) and need to handle
-multi-line value, you will need to place the key-value pair between quotes:
+If you're using [GitHub secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets)
+and need to handle multi-line value, you will need to place the key-value pair
+between quotes:
 
 ```yaml
 secrets: |
@@ -72,13 +74,15 @@ secrets: |
   "JSON_SECRET={""key1"":""value1"",""key2"":""value2""}"
 ```
 
-| Key                | Value                                            |
-|--------------------|--------------------------------------------------|
-| `MYSECRET`         | `***********************` |
-| `GIT_AUTH_TOKEN`   | `abcdefghi,jklmno=0123456789` |
-| `MYSECRET`         | `aaaaaaaa\nbbbbbbb\nccccccccc` |
-| `FOO`              | `bar` |
-| `EMPTYLINE`        | `aaaa\n\nbbbb\nccc` |
+| Key                | Value                               |
+|--------------------|-------------------------------------|
+| `MYSECRET`         | `***********************`           |
+| `GIT_AUTH_TOKEN`   | `abcdefghi,jklmno=0123456789`       |
+| `MYSECRET`         | `aaaaaaaa\nbbbbbbb\nccccccccc`      |
+| `FOO`              | `bar`                               |
+| `EMPTYLINE`        | `aaaa\n\nbbbb\nccc`                 |
 | `JSON_SECRET`      | `{"key1":"value1","key2":"value2"}` |
 
-> :bulb: All quote signs need to be doubled for escaping.
+> **Note**
+>
+> All quote signs need to be doubled for escaping.
diff --git a/docs/advanced/share-image-jobs.md b/docs/advanced/share-image-jobs.md
@@ -1,8 +1,10 @@
 # Share built image between jobs
 
-As each job is isolated in its own runner you cannot use your built image between jobs (except for [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners)).
-However, you can [pass data between jobs in a workflow](https://docs.github.com/en/actions/guides/storing-workflow-data-as-artifacts#passing-data-between-jobs-in-a-workflow)
-using the [actions/upload-artifact](https://github.com/actions/upload-artifact) and [actions/download-artifact](https://github.com/actions/download-artifact)
+As each job is isolated in its own runner you cannot use your built image
+between jobs (except for [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners)).
+However, you can [pass data between jobs in a workflow](https://docs.github.com/en/actions/using-workflows/storing-workflow-data-as-artifacts#passing-data-between-jobs-in-a-workflow)
+using the [actions/upload-artifact](https://github.com/actions/upload-artifact)
+and [actions/download-artifact](https://github.com/actions/download-artifact)
 actions:
 
 ```yaml

diff --git a/docs/advanced/tags-labels.md b/docs/advanced/tags-labels.md
@@ -1,8 +1,9 @@
 # Handle tags and labels
 
 If you want an "automatic" tag management and [OCI Image Format Specification](https://github.com/opencontainers/image-spec/blob/master/annotations.md)
-for labels, you can do it in a dedicated step. The following workflow will use the [Docker metadata action](https://github.com/docker/metadata-action)
-to handle tags and labels based on GitHub actions events and Git metadata.
+for labels, you can do it in a dedicated step. The following workflow will use
+the [Docker metadata action](https://github.com/docker/metadata-action) to
+handle tags and labels based on GitHub actions events and Git metadata:
 
 ```yaml
 name: ci
@@ -51,7 +52,7 @@ jobs:
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
       -
-        name: Login to DockerHub
+        name: Login to Docker Hub
         if: github.event_name != 'pull_request'
         uses: docker/login-action@v2
         with:

diff --git a/docs/advanced/test-before-push.md b/docs/advanced/test-before-push.md
@@ -33,7 +33,7 @@ jobs:
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
       -
-        name: Login to DockerHub
+        name: Login to Docker Hub
         uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
@@ -59,6 +59,8 @@ jobs:
           tags: ${{ env.TEST_TAG }}
 ```
 
-> :bulb: Build time will not be increased with this workflow because internal
-> cache for `linux/amd64` will be used from previous step on `Build and push`
-> step so only `linux/arm64` will be actually built.
+> **Note**
+>
+> Build time will not be increased with this workflow because internal cache
+> for `linux/amd64` will be used from previous step on `Build and push` step
+> so only `linux/arm64` will be actually built.
diff --git a/test/Dockerfile b/test/Dockerfile
@@ -1,3 +1,3 @@
+# syntax=docker/dockerfile:1
 FROM alpine
-
 RUN echo "Hello world!"
diff --git a/test/addhost.Dockerfile b/test/addhost.Dockerfile
@@ -1,2 +1,3 @@
+# syntax=docker/dockerfile:1
 FROM busybox
 RUN cat /etc/hosts
diff --git a/test/buildcontext.Dockerfile b/test/buildcontext.Dockerfile
@@ -1,3 +1,3 @@
-# syntax=docker/dockerfile-upstream:master
+# syntax=docker/dockerfile:1
 FROM alpine
 RUN cat /etc/*release
diff --git a/test/cgroup.Dockerfile b/test/cgroup.Dockerfile
@@ -1,2 +1,3 @@
+# syntax=docker/dockerfile:1
 FROM alpine
 RUN cat /proc/self/cgroup
diff --git a/test/multi-sudo.Dockerfile b/test/multi-sudo.Dockerfile
@@ -1,9 +1,8 @@
+# syntax=docker/dockerfile:1
 FROM --platform=$BUILDPLATFORM golang:alpine AS build
-
 ARG TARGETPLATFORM
 ARG BUILDPLATFORM
 RUN echo "I am running on $BUILDPLATFORM, building for $TARGETPLATFORM" > /log
-
 RUN apk --update --no-cache add \
     shadow \
     sudo \
@@ -17,6 +16,5 @@ RUN sudo chown buildx. /log
 USER root
 
 FROM alpine
-
 COPY --from=build /log /log
 RUN ls -al /log
diff --git a/test/multi.Dockerfile b/test/multi.Dockerfile
@@ -1,3 +1,4 @@
+# syntax=docker/dockerfile:1
 FROM --platform=$BUILDPLATFORM golang:alpine AS build
 
 ARG TARGETPLATFORM

diff --git a/test/nocachefilter.Dockerfile b/test/nocachefilter.Dockerfile
@@ -1,3 +1,4 @@
+# syntax=docker/dockerfile:1
 FROM busybox AS base
 RUN echo "Hello world!" > /hello
 

diff --git a/test/shmsize.Dockerfile b/test/shmsize.Dockerfile
@@ -1,2 +1,3 @@
+# syntax=docker/dockerfile:1
 FROM busybox
 RUN mount | grep /dev/shm