From bad2be0b6440874b5fa3e8bfe18c3628d738d46b Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 23 Nov 2022 16:53:04 +0100 Subject: [PATCH] build: tidy 'develop' section in guides (#16196) Signed-off-by: David Karlsson --- _data/toc.yaml | 6 +-- .../building/base-images.md | 3 +- develop/dev-best-practices.md | 2 +- .../dockerfile_best-practices.md | 2 +- develop/develop-images/image_management.md | 44 ------------------- language/golang/build-images.md | 2 +- language/index.md | 1 - language/nodejs/build-images.md | 2 +- language/python/build-images.md | 2 +- 9 files changed, 9 insertions(+), 55 deletions(-) rename develop/develop-images/baseimages.md => build/building/base-images.md (96%) delete mode 100644 develop/develop-images/image_management.md diff --git a/_data/toc.yaml b/_data/toc.yaml index 49ebe8dcb4..f0a587a1b0 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -139,10 +139,6 @@ guides: section: - path: /develop/develop-images/dockerfile_best-practices/ title: Dockerfile best practices - - path: /develop/develop-images/image_management/ - title: Manage images - - path: /develop/develop-images/baseimages/ - title: Create your own base image (advanced) - path: /develop/scan-images/ title: Scan images - sectiontitle: Deploy your app to the cloud @@ -1557,6 +1553,8 @@ manuals: title: Multi-stage builds - path: /build/building/multi-platform/ title: Multi-platform images + - path: /build/building/base-images/ + title: Create your own base image - sectiontitle: Customizing builds section: - sectiontitle: High-level builds with Bake diff --git a/develop/develop-images/baseimages.md b/build/building/base-images.md similarity index 96% rename from develop/develop-images/baseimages.md rename to build/building/base-images.md index 8d3395e2a8..21dda6b099 100644 --- a/develop/develop-images/baseimages.md +++ b/build/building/base-images.md @@ -5,6 +5,7 @@ redirect_from: - /articles/baseimages/ - /engine/articles/baseimages/ - /engine/userguide/eng-image/baseimages/ +- /develop/develop-images/baseimages/ title: Create a base image --- @@ -109,5 +110,5 @@ There are lots of resources available to help you write your `Dockerfile`. * There's a [complete guide to all the instructions](../../engine/reference/builder.md) available for use in a `Dockerfile` in the reference section. * To help you write a clear, readable, maintainable `Dockerfile`, we've also -written a [`Dockerfile` best practices guide](dockerfile_best-practices.md). +written a [Dockerfile best practices guide](../../develop/develop-images/dockerfile_best-practices.md). * If your goal is to create a new Docker Official Image, read [Docker Official Images](../../docker-hub/official_images.md). diff --git a/develop/dev-best-practices.md b/develop/dev-best-practices.md index 030818bcc5..ea3ccc76d5 100644 --- a/develop/dev-best-practices.md +++ b/develop/dev-best-practices.md @@ -45,7 +45,7 @@ keep image size small: ``` - If you have multiple images with a lot in common, consider creating your own - [base image](develop-images/baseimages.md) with the shared + [base image](../build/building/base-images.md) with the shared components, and basing your unique images on that. Docker only needs to load the common layers once, and they are cached. This means that your derivative images use memory on the Docker host more efficiently and load more diff --git a/develop/develop-images/dockerfile_best-practices.md b/develop/develop-images/dockerfile_best-practices.md index b584cdc026..de73db3913 100644 --- a/develop/develop-images/dockerfile_best-practices.md +++ b/develop/develop-images/dockerfile_best-practices.md @@ -886,8 +886,8 @@ These Official Images have exemplary `Dockerfile`s: ## Additional resources: * [Dockerfile Reference](../../engine/reference/builder.md) -* [More about Base Images](baseimages.md) * [More about Automated Builds](../../docker-hub/builds/index.md) * [Guidelines for Creating Docker Official Images](../../docker-hub/official_images.md) * [Best practices to containerize Node.js web applications with Docker](https://snyk.io/blog/10-best-practices-to-containerize-nodejs-web-applications-with-docker){:target="_blank" rel="noopener" class="_"} +* [More about Base Images](../../build/building/base-images.md) diff --git a/develop/develop-images/image_management.md b/develop/develop-images/image_management.md deleted file mode 100644 index c07ea91e23..0000000000 --- a/develop/develop-images/image_management.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -redirect_from: -- /reference/api/hub_registry_spec/ -- /userguide/image_management/ -- /engine/userguide/eng-image/image_management/ -description: Documentation for docker Registry and Registry API -keywords: docker, registry, api, hub -title: Manage images ---- - -The easiest way to make your images available for use by others inside or -outside your organization is to use a Docker registry, such as [Docker Hub](#docker-hub), -or by running your own [private registry](#docker-registry). - - -## Docker Hub - -[Docker Hub](../../docker-hub/index.md) is a public registry managed by Docker, -Inc. It centralizes information about organizations, user accounts, and images. -It includes a web UI, authentication and authorization using organizations, CLI -and API access using commands such as `docker login`, `docker pull`, and `docker -push`, comments, stars, search, and more. - -## Docker Registry - -The Docker Registry is a component of Docker's ecosystem. A registry is a -storage and content delivery system, holding named Docker images, available in -different tagged versions. For example, the image `distribution/registry`, with -tags `2.0` and `latest`. Users interact with a registry by using docker push and -pull commands such as `docker pull myregistry.com/stevvooe/batman:voice`. - -Docker Hub is an instance of a Docker Registry. - -## Content Trust - -When transferring data among networked systems, *trust* is a central concern. In -particular, when communicating over an untrusted medium such as the internet, it -is critical to ensure the integrity and publisher of all of the data a system -operates on. You use Docker to push and pull images (data) to a registry. -Content trust gives you the ability to both verify the integrity and the -publisher of all the data received from a registry over any channel. - -See [Content trust](../../engine/security/trust/index.md) for information about -configuring and using this feature on Docker clients. diff --git a/language/golang/build-images.md b/language/golang/build-images.md index 663b6e0b05..ea2aab0421 100644 --- a/language/golang/build-images.md +++ b/language/golang/build-images.md @@ -154,7 +154,7 @@ When we have used that `FROM` command, we told Docker to include in our image al > **Note** > -> If you want to learn more about creating your own base images, see [creating base images](../../develop/develop-images/baseimages.md) section of the guide. +> If you want to learn more about creating your own base images, see [creating base images](../../build/building/base-images.md) section of the guide. To make things easier when running the rest of our commands, let’s create a directory _inside_ the image that we are building. This also instructs Docker diff --git a/language/index.md b/language/index.md index 7e4f8ab71e..d575ef39cf 100644 --- a/language/index.md +++ b/language/index.md @@ -15,7 +15,6 @@ For more information, refer to the following topics: * [Best practices for writing Dockerfiles](../develop/develop-images/dockerfile_best-practices.md) * [Docker development best practices](../develop/dev-best-practices.md) * [Build images with BuildKit](../build/buildkit/index.md#getting-started) -* [Manage images](../develop/develop-images/image_management.md) ## Language-specific getting started guides diff --git a/language/nodejs/build-images.md b/language/nodejs/build-images.md index 0e20f81df1..8c1dbfa6e7 100644 --- a/language/nodejs/build-images.md +++ b/language/nodejs/build-images.md @@ -113,7 +113,7 @@ In the same way, when we use the `FROM` command, we tell Docker to include in ou > **Note** > -> If you want to learn more about creating your own base images, see [Creating base images](../../develop/develop-images/baseimages.md). +> If you want to learn more about creating your own base images, see [Creating base images](../../build/building/base-images.md). The `NODE_ENV` environment variable specifies the environment in which an application is running (usually, development or production). One of the simplest things you can do to improve performance is to set `NODE_ENV` to `production`. diff --git a/language/python/build-images.md b/language/python/build-images.md index aa63aba13b..ca67ac37af 100644 --- a/language/python/build-images.md +++ b/language/python/build-images.md @@ -82,7 +82,7 @@ Docker images can be inherited from other images. Therefore, instead of creating > **Note** > -> To learn more about creating your own base images, see [Creating base images](../../develop/develop-images/baseimages.md). +> To learn more about creating your own base images, see [Creating base images](../../build/building/base-images.md). To make things easier when running the rest of our commands, let’s create a working directory. This instructs Docker to use this path as the default location for all subsequent commands. By doing this, we do not have to type out full file paths but can use relative paths based on the working directory.