From e86a063e1e15283c423c120cea215789cd727132 Mon Sep 17 00:00:00 2001 From: Cristovao Cordeiro Date: Mon, 15 Apr 2024 14:36:20 +0200 Subject: [PATCH] fix(oci): re-wording - apply suggestions from code review Co-authored-by: Sally --- oci/index.rst | 2 +- oci/oci-explanation/ubuntu-oci-container.rst | 7 +++---- oci/oci-explanation/ubuntu-pro-oci-container.rst | 8 ++++---- oci/oci-how-to/getting-started.rst | 4 ++-- oci/oci-how-to/index.rst | 7 +++---- oci/oci-reference/oci-image-configuration.rst | 4 ++-- oci/oci-tutorials/index.rst | 2 +- 7 files changed, 16 insertions(+), 18 deletions(-) diff --git a/oci/index.rst b/oci/index.rst index deece71b..199b411d 100644 --- a/oci/index.rst +++ b/oci/index.rst @@ -7,7 +7,7 @@ Ubuntu on OCI container registries **A base container for trusted application images.** Container image provenance is a key aspect of any supply chain. The Ubuntu container image offers the ideal starting point for your application images, both in utility and trustworthiness. -**Compatible with multiple platforms and available in different flavours.** The Ubuntu container image is published as a multi-arch OCI (Open Container Initiative) image that is available for ``amd64``, ``arm``, ``arm64``, ``ppc64le`` and ``s390x``. Moreover, Ubuntu Pro is also available for containers, which means hardened and security-enhanced versions of the public Ubuntu container image are also available. +**Compatible with multiple platforms and available in different flavours.** The Ubuntu container image is published as a multi-arch Open Container Initiative (OCI) image, available for ``amd64``, ``arm``, ``arm64``, ``ppc64le`` and ``s390x``. Ubuntu Pro is also available for containers, which means hardened and security-enhanced versions of the public Ubuntu container image are also available. .. toctree:: diff --git a/oci/oci-explanation/ubuntu-oci-container.rst b/oci/oci-explanation/ubuntu-oci-container.rst index 0b806731..48dee665 100644 --- a/oci/oci-explanation/ubuntu-oci-container.rst +++ b/oci/oci-explanation/ubuntu-oci-container.rst @@ -3,12 +3,12 @@ Ubuntu OCI container images =========================== -The Open Container Initiative (OCI) establishes standards for constructing container +The `Open Container Initiative (OCI) `_ establishes standards for constructing container images that can be reliably installed across a variety of compliant host environments. Ubuntu’s `LTS Docker Image Portfolio `_ provides OCI-compliant images that receive stable security updates and predictable -software updates, thus ensuring consistency in both maintenance schedule and operational +software updates, ensuring consistency in both maintenance schedule and operational interfaces for the underlying software your software builds on. Moreover, `Ubuntu-based containers `_ (like @@ -16,7 +16,6 @@ chiselled container images) all leverage the Ubuntu container image as their starting point, and thus also profit from its support and security commitments. The Ubuntu container image is built from a minimal rootfs tarball. This tarball -is similar to `Ubuntu Base `_ -but it already contains the modifications needed to make the rootfs suitable for +contains the modifications needed to make the rootfs suitable for building OCI/Docker container images. The Ubuntu OCI rootfs tarballs are published in `OCI partner images `_. diff --git a/oci/oci-explanation/ubuntu-pro-oci-container.rst b/oci/oci-explanation/ubuntu-pro-oci-container.rst index 7e4492e0..26e7a7a6 100644 --- a/oci/oci-explanation/ubuntu-pro-oci-container.rst +++ b/oci/oci-explanation/ubuntu-pro-oci-container.rst @@ -4,9 +4,9 @@ Ubuntu Pro OCI container images =============================== -Similar to the `Ubuntu Pro images in public clouds -`_, one can build an Ubuntu Pro container image to leverage services like ESM -(Extended Security Maintenance) and FIPS. +As with the `Ubuntu Pro images in public clouds +`_, one can build an Ubuntu Pro container image to leverage services like +`Expanded Security Maintenance (ESM) `_ and `FIPS `_. The easiest way to build an Ubuntu Pro container image is to make use of existing container management tools (like Docker) and enable the Pro services on top of an existing Ubuntu container image (e.g. `ubuntu:focal `_). @@ -14,4 +14,4 @@ The easiest way to build an Ubuntu Pro container image is to make use of existin Ubuntu Pro container images should be run on hosts that are already covered by an Ubuntu Pro subscription. Please consult the `Ubuntu Pro service description `_ for more details. -This process is described in detail in :ref:`this How-to guide `. The resulting Ubuntu Pro container image can then be loaded into your local Docker daemon and/or can be deployed normally as any other container image. +Find out how to enable :ref:`Ubuntu Pro services in a Dockerfile `. The resulting Ubuntu Pro container image can then be loaded into your local Docker daemon and/or can be deployed normally as any other container image. diff --git a/oci/oci-how-to/getting-started.rst b/oci/oci-how-to/getting-started.rst index 6aca2d18..f5ad3108 100644 --- a/oci/oci-how-to/getting-started.rst +++ b/oci/oci-how-to/getting-started.rst @@ -1,4 +1,4 @@ -Getting Started +Getting started *************** This is where to find the Ubuntu container images: @@ -40,5 +40,5 @@ day, depending on whether there have been upstream changes in the Ubuntu archive affecting the packages that constitute the container image. **Exception**: the only exception is the official Ubuntu image in Docker Hub which, -due to the Docker's policies, cannot be submitted too regularly, and thus are +due to Docker's policies, cannot be submitted too regularly, and so are only updated every two weeks. \ No newline at end of file diff --git a/oci/oci-how-to/index.rst b/oci/oci-how-to/index.rst index b184c43c..05cc9c23 100644 --- a/oci/oci-how-to/index.rst +++ b/oci/oci-how-to/index.rst @@ -4,8 +4,8 @@ How-to guides ************* If you have a specific goal but are already familiar with the Ubuntu container -images, our How-to guides have more in-depth detail than our tutorials, and dig -a bit further into more advanced usages of the Ubuntu container images. +images, our how-to guides have more in-depth detail than our tutorials, and dig +a bit further into the more advanced uses of Ubuntu container images. They'll help you achieve an end result but may require you to understand and adapt the steps to fit your specific requirements. @@ -54,8 +54,7 @@ Documentation ------------- If you have found something missing in this documentation, or have useful -information to add whether it is a tutorial, a guide, or something else, we -compiled a couple of guides for you to facilitate your contribution. +information to add (whether it is a tutorial, a guide, or something else), this guide will help you to make your contribution. .. toctree:: :maxdepth: 1 diff --git a/oci/oci-reference/oci-image-configuration.rst b/oci/oci-reference/oci-image-configuration.rst index 2a38204f..968913ff 100644 --- a/oci/oci-reference/oci-image-configuration.rst +++ b/oci/oci-reference/oci-image-configuration.rst @@ -4,8 +4,8 @@ Ubuntu OCI image configuration The definition of the Ubuntu container image follows the `OCI image format specification `_. -Thus, as with any other container image, the Ubuntu image contains enough metadata -such that one can inspect the image without actually running the container. +So, as with any other container image, the Ubuntu image includes enough metadata +that one can inspect the image without actually running the container. Layers ------ diff --git a/oci/oci-tutorials/index.rst b/oci/oci-tutorials/index.rst index 3bc8e591..6208a98a 100644 --- a/oci/oci-tutorials/index.rst +++ b/oci/oci-tutorials/index.rst @@ -5,7 +5,7 @@ Tutorials ********* If you want to learn the basics from experience, then our tutorials will help -you acquire the necessary competencies from real-life examples with fully +you using real-life examples with fully reproducible steps.