From 7fb9f5d026163ac643328cfa926e7c78041aa062 Mon Sep 17 00:00:00 2001 From: Katrina Prosise Date: Thu, 9 Nov 2023 04:26:19 -0500 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Andy Doan Co-authored-by: Daiane Angolini --- source/reference-manual/docker/container-secrets.rst | 2 +- source/user-guide/containers-and-docker/containers.rst | 4 ++-- .../containers-and-docker/multi-stage-container.rst | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/reference-manual/docker/container-secrets.rst b/source/reference-manual/docker/container-secrets.rst index 1a8e1e98c..6bd1477c4 100644 --- a/source/reference-manual/docker/container-secrets.rst +++ b/source/reference-manual/docker/container-secrets.rst @@ -14,7 +14,7 @@ However, the general approach to getting these secrets securely into your contai .. note:: - There are several `insecure ways`_ that should be avoid. + There are several `insecure ways`_ that should be avoided. The proper approach is described here based on new functionality in Docker's BuildKit. .. _insecure ways: diff --git a/source/user-guide/containers-and-docker/containers.rst b/source/user-guide/containers-and-docker/containers.rst index 0876a41a7..00e6283b2 100644 --- a/source/user-guide/containers-and-docker/containers.rst +++ b/source/user-guide/containers-and-docker/containers.rst @@ -83,8 +83,8 @@ A common case is including Git commit information into a container:: Advanced Container Dependencies ------------------------------- -On a rare occasion, a Factory will need custom code to run *before* the Docker build logic is called. -This can be done with a file in the top-level directory of ``containers.git``, ``pre-build.conf``. +On rare occasions, a Factory will need custom code to run *before* the Docker build logic is called. +This can be done by adding the file ``pre-build.conf`` in the top-level directory of ``containers.git``. Examples ~~~~~~~~ diff --git a/source/user-guide/containers-and-docker/multi-stage-container.rst b/source/user-guide/containers-and-docker/multi-stage-container.rst index a44183f1a..6b43f4237 100644 --- a/source/user-guide/containers-and-docker/multi-stage-container.rst +++ b/source/user-guide/containers-and-docker/multi-stage-container.rst @@ -16,7 +16,7 @@ In the first stage you can install dependencies for development, like a toolchai In the final stage, the image is kept clean with just the necessities for your application. This is done by making use of the final artifacts from the first stage. -This guide present a Dockerfile implementing a ``helloworld`` application written in C. +This guide presents a Dockerfile implementing a ``helloworld`` application written in C. In the first example, the Dockerfile is implementing everything in a single stage, leaving all objects and spare software in the image.