Terminology formatting updates

corrections

more corrections

corrections

further corrections

more corrections

modules/installation-registry-storage-block-recreate-rollout.adoc

@@ -32,7 +32,7 @@ $ oc patch config.imageregistry.operator.openshift.io/cluster --type=merge -p '{
 ----
 +
 . Provision the PV for the block storage device, and create a PVC for that volume. The requested block volume uses the ReadWriteOnce (RWO) access mode.
-.. Create a `pvc.yaml` file with the following contents to define a VMware vSphere PersistentVolumeClaim:
+.. Create a `pvc.yaml` file with the following contents to define a VMware vSphere `PersistentVolumeClaim` object:
 +
 [source,yaml]
 ----
@@ -47,11 +47,11 @@ spec:
     requests:
       storage: 100Gi <3>
 ----
-<1> A unique name that represents the PersistentVolumeClaim.
+<1> A unique name that represents the `PersistentVolumeClaim` object.
 <2> The access mode of the PersistentVolumeClaim. With `ReadWriteOnce`, the volume can be mounted with read and write permissions by a single node.
 <3> The size of the PersistentVolumeClaim.
 
-.. Create the PersistentVolumeClaim from the file:
+.. Create the `PersistentVolumeClaim`object from the file:
 +
 [source,terminal]
 ----

modules/installation-registry-storage-config.adoc

@@ -34,12 +34,12 @@ cannot create an S3 bucket and automatically configure storage, you must
 manually configure registry storage.
 endif::aws[]
 ifndef::aws[]
-The `image-registry` Operator is not initially available for platforms that do
+The Image Registry Operator is not initially available for platforms that do
 not provide default storage. After installation, you must configure your
 registry to use storage so that the Registry Operator is made available.
 endif::aws[]
 
-Instructions are shown for configuring a PersistentVolume, which is required for production clusters. Where applicable, instructions are shown for configuring an empty directory as the storage location, which is available for only non-production clusters.
+Instructions are shown for configuring a persistent volume, which is required for production clusters. Where applicable, instructions are shown for configuring an empty directory as the storage location, which is available for only non-production clusters.
 
 Additional instructions are provided for allowing the image registry to use block storage types by using the `Recreate` rollout strategy during upgrades.
 

modules/installation-registry-storage-non-production.adoc

@@ -11,7 +11,7 @@
 [id="installation-registry-storage-non-production_{context}"]
 = Configuring storage for the image registry in non-production clusters
 
-You must configure storage for the image registry Operator. For non-production
+You must configure storage for the Image Registry Operator. For non-production
 clusters, you can set the image registry to an empty directory. If you do so,
 all images are lost if you restart the registry.
 

modules/pruning-images.adoc

@@ -81,7 +81,7 @@ status:
 
 [IMPORTANT]
 ====
-The Image Registry Operator's behavior for managing the pruner is orthogonal to the `managementState` specified on the Image Registry Operator's `ClusterOperator` object. If the image registry Operator is not in the `Managed` state, the image pruner can still be configured and managed by the Pruning Custom Resource.
+The Image Registry Operator's behavior for managing the pruner is orthogonal to the `managementState` specified on the Image Registry Operator's `ClusterOperator` object. If the Image Registry Operator is not in the `Managed` state, the image pruner can still be configured and managed by the Pruning Custom Resource.
 
 However, the `managementState` of the Image Registry Operator alters the behavior of the deployed image pruner job:
 

modules/registry-configuring-storage-aws-user-infra.adoc

@@ -10,7 +10,7 @@
 During installation, your cloud credentials are sufficient to create an Amazon S3 bucket
 and the Registry Operator will automatically configure storage.
 
-If the Registry Operator cannot create an S3 bucket, and automatically configure
+If the Registry Operator cannot create an S3 bucket and automatically configure
 storage, you can create an S3 bucket and configure storage with the following
 procedure.
 

modules/registry-configuring-storage-baremetal.adoc

@@ -50,8 +50,8 @@ ifdef::ibm-z[* Persistent storage provisioned for your cluster.]
 ====
 {product-title} supports `ReadWriteOnce` access for image registry storage when you have only one replica. To deploy an image registry that supports high availability with two or more replicas, `ReadWriteMany` access is required.
 ====
-
-* Must have "100Gi" capacity.
++
+* Must have 100Gi capacity.
 
 .Procedure
 
@@ -63,7 +63,7 @@ the `configs.imageregistry/cluster` resource.
 When using shared storage, review your security settings to prevent outside access.
 ====
 
-. Verify that you do not have a registry Pod:
+. Verify that you do not have a registry pod:
 +
 [source,terminal]
 ----

modules/registry-exposing-secure-registry-manually.adoc

@@ -31,7 +31,7 @@ To expose the registry using `DefaultRoute`:
 $ oc patch configs.imageregistry.operator.openshift.io/cluster --patch '{"spec":{"defaultRoute":true}}' --type=merge
 ----
 +
-. Log in with Podman:
+. Log in with `podman`:
 +
 [source,terminal]
 ----
@@ -74,5 +74,8 @@ spec:
 ...
 ----
 +
+[NOTE]
+====
 Only set `secretName` if you are providing a custom TLS configuration for the
 registry's route.
+====

modules/registry-operator-config-resources-secret-aws.adoc

@@ -15,8 +15,8 @@ credentials used by the Operator, if default credentials were found.
 
 For S3 on AWS storage, the secret is expected to contain two keys:
 
-* REGISTRY_STORAGE_S3_ACCESSKEY
-* REGISTRY_STORAGE_S3_SECRETKEY
+* `REGISTRY_STORAGE_S3_ACCESSKEY`
+* `REGISTRY_STORAGE_S3_SECRETKEY`
 
 .Procedure
 

modules/registry-operator-config-resources-secret-azure.adoc

@@ -17,7 +17,7 @@ credentials used by the Operator, if default credentials were found.
 For Azure registry storage, the secret is expected to contain one key whose value is the
 contents of a credentials file provided by Azure:
 
-* REGISTRY_STORAGE_AZURE_ACCOUNTKEY
+* `REGISTRY_STORAGE_AZURE_ACCOUNTKEY`
 
 .Procedure
 

modules/registry-operator-config-resources-secret-gcp.adoc

@@ -16,7 +16,7 @@ credentials used by the Operator, if default credentials were found.
 For GCS on GCP storage, the secret is expected to contain one key whose value is the
 contents of a credentials file provided by GCP:
 
-* REGISTRY_STORAGE_GCS_KEYFILE
+* `REGISTRY_STORAGE_GCS_KEYFILE`
 
 .Procedure
 

registry/configuring-registry-operator.adoc

@@ -16,7 +16,7 @@ registry storage.
 Storage is only automatically configured when you install an
 installer-provisioned infrastructure cluster on AWS, GCP, Azure, or OpenStack.
 
-When you install or upgrade an installer-provisioned infrastructure cluster on AWS or Azure, the Image Registry Operator sets the `spec.storage.managementState` parameter to `Managed`. If the `spec.storage.managementState` parameter is set to `Unmanaged`, the Image Registry Operator takes no action related to storage. 
+When you install or upgrade an installer-provisioned infrastructure cluster on AWS or Azure, the Image Registry Operator sets the `spec.storage.managementState` parameter to `Managed`. If the `spec.storage.managementState` parameter is set to `Unmanaged`, the Image Registry Operator takes no action related to storage.
 ====
 
 After the control plane deploys, the Operator will create a default
@@ -25,7 +25,7 @@ configuration detected in the cluster.
 
 If insufficient information is available to define a complete
 `configs.imageregistry.operator.openshift.io` resource, the incomplete resource
-will be defined and the operator will update the resource status with
+will be defined and the Operator will update the resource status with
 information about what is missing.
 
 The Image Registry Operator runs in the `openshift-image-registry` namespace,
@@ -35,9 +35,9 @@ and workload resources for the registry reside in that namespace.
 
 [IMPORTANT]
 ====
-The Image Registry Operator's behavior for managing the pruner is orthogonal to the `ManagementState` specified on the Image Registry Operator's `ClusterOperator` object. If the image registry operator is not in the `Managed` state, the image pruner can still be configured and managed by the Pruning Custom Resource.
+The Image Registry Operator's behavior for managing the pruner is orthogonal to the `managementState` specified on the `ClusterOperator` object for the Image Registry Operator. If the Image Registry Operator is not in the `Managed` state, the image pruner can still be configured and managed by the `Pruning` custom resource.
 
-However, the `ManagementState` of the Image Registry Operator alters the behavior of the deployed image pruner job:
+However, the `managementState` of the Image Registry Operator alters the behavior of the deployed image pruner job:
 
 * `Managed`: the `--prune-registry` flag for the image pruner is set to `true`.
 * `Removed`: the `--prune-registry` flag for the image pruner is set to `false`, meaning it only prunes image metatdata in etcd.

rest_api/config_apis/image-config-openshift-io-v1.adoc

@@ -8,7 +8,7 @@ toc::[]
 
 
 Description::
-  Image governs policies related to imagestream imports and runtime configuration for external registries. It allows cluster admins to configure which registries OpenShift is allowed to import images from, extra CA trust bundles for external registries, and policies to block or allow registry hostnames. When exposing OpenShift's image registry to the public, this also lets cluster admins specify the external hostname.
+  Image governs policies related to image stream imports and runtime configuration for external registries. It allows cluster admins to configure which registries OpenShift is allowed to import images from, extra CA trust bundles for external registries, and policies to block or allow registry hostnames. When exposing the OpenShift image registry to the public, this also lets cluster admins specify the external hostname.
 
 Type::
   `object`
@@ -25,11 +25,11 @@ Required::
 
 | `.apiVersion`
 | `string`
-| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+| `apiVersion` defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
 
 | `.kind`
 | `string`
-| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+| `kind` is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
 
 | `.metadata`
 | xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`]
@@ -37,16 +37,16 @@ Required::
 
 | `.spec`
 | `object`
-| spec holds user settable values for configuration
+| `spec` holds user settable values for configuration
 
 | `.status`
 | `object`
-| status holds observed values from the cluster. They may not be overridden.
+| `status` holds observed values from the cluster. They may not be overridden.
 
 |===
 ..spec
 Description::
-  spec holds user settable values for configuration
+  `spec` holds user settable values for configuration
 
 Type::
   `object`
@@ -60,28 +60,28 @@ Type::
 
 | `additionalTrustedCA`
 | `object`
-| additionalTrustedCA is a reference to a ConfigMap containing additional CAs that should be trusted during imagestream import, pod image pull, build image pull, and imageregistry pullthrough. The namespace for this config map is openshift-config.
+| `additionalTrustedCA` is a reference to a `ConfigMap` object containing additional CAs that should be trusted during image stream import, pod image pull, build image pull, and imageregistry pullthrough. The namespace for this config map is `openshift-config`.
 
 | `allowedRegistriesForImport`
 | `array`
-| allowedRegistriesForImport limits the container image registries that normal users may import images from. Set this list to the registries that you trust to contain valid Docker images and that you want applications to be able to import from. Users with permission to create Images or ImageStreamMappings via the API are not affected by this policy - typically only administrators or system integrations will have those permissions.
+| `allowedRegistriesForImport` limits the container image registries that normal users may import images from. Set this list to the registries that you trust to contain valid Docker images and that you want applications to be able to import from. Users with permission to create images or image stream mappings via the API are not affected by this policy - typically only administrators or system integrations will have those permissions.
 
 | `allowedRegistriesForImport[]`
 | `object`
-| RegistryLocation contains a location of the registry specified by the registry domain name. The domain name might include wildcards, like '*' or '??'.
+| `RegistryLocation` contains a location of the registry specified by the registry domain name. The domain name might include wildcards, like '*' or '??'.
 
 | `externalRegistryHostnames`
 | `array (string)`
-| externalRegistryHostnames provides the hostnames for the default external image registry. The external hostname should be set only when the image registry is exposed externally. The first value is used in 'publicDockerImageRepository' field in ImageStreams. The value must be in "hostname[:port]" format.
+| `externalRegistryHostnames` provides the hostnames for the default external image registry. The external hostname should be set only when the image registry is exposed externally. The first value is used in 'publicDockerImageRepository' field in image streams. The value must be in "hostname[:port]" format.
 
 | `registrySources`
 | `object`
-| registrySources contains configuration that determines how the container runtime should treat individual registries when accessing images for builds+pods. (e.g. whether or not to allow insecure access).  It does not contain configuration for the internal cluster registry.
+| `registrySources` contains configuration that determines how the container runtime should treat individual registries when accessing images for builds and pods. (e.g. whether or not to allow insecure access).  It does not contain configuration for the internal cluster registry.
 
 |===
 ..spec.additionalTrustedCA
 Description::
-  additionalTrustedCA is a reference to a ConfigMap containing additional CAs that should be trusted during imagestream import, pod image pull, build image pull, and imageregistry pullthrough. The namespace for this config map is openshift-config.
+  `additionalTrustedCA` is a reference to a `ConfigMap` object containing additional CAs that should be trusted during image stream import, pod image pull, build image pull, and imageregistry pullthrough. The namespace for this config map is `openshift-config`.
 
 Type::
   `object`
@@ -97,12 +97,12 @@ Required::
 
 | `name`
 | `string`
-| name is the metadata.name of the referenced config map
+| `name` is the `metadata.name` of the referenced config map
 
 |===
 ..spec.allowedRegistriesForImport
 Description::
-  allowedRegistriesForImport limits the container image registries that normal users may import images from. Set this list to the registries that you trust to contain valid Docker images and that you want applications to be able to import from. Users with permission to create Images or ImageStreamMappings via the API are not affected by this policy - typically only administrators or system integrations will have those permissions.
+  `allowedRegistriesForImport` limits the container image registries that normal users may import images from. Set this list to the registries that you trust to contain valid Docker images and that you want applications to be able to import from. Users with permission to create images or image stream mappings via the API are not affected by this policy - typically only administrators or system integrations will have those permissions.
 
 Type::
   `array`
@@ -112,7 +112,7 @@ Type::
 
 ..spec.allowedRegistriesForImport[]
 Description::
-  RegistryLocation contains a location of the registry specified by the registry domain name. The domain name might include wildcards, like '*' or '??'.
+  `RegistryLocation` contains a location of the registry specified by the registry domain name. The domain name might include wildcards, like `*` or `?`.
 
 Type::
   `object`
@@ -126,16 +126,16 @@ Type::
 
 | `domainName`
 | `string`
-| domainName specifies a domain name for the registry In case the registry use non-standard (80 or 443) port, the port should be included in the domain name as well.
+| `domainName` specifies a domain name for the registry In case the registry use non-standard (80 or 443) port, the port should be included in the domain name as well.
 
 | `insecure`
 | `boolean`
-| insecure indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure.
+| `insecure` indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure.
 
 |===
 ..spec.registrySources
 Description::
-  registrySources contains configuration that determines how the container runtime should treat individual registries when accessing images for builds+pods. (e.g. whether or not to allow insecure access).  It does not contain configuration for the internal cluster registry.
+  `registrySources` contains configuration that determines how the container runtime should treat individual registries when accessing images for builds and pods. (e.g. whether or not to allow insecure access).  It does not contain configuration for the internal cluster registry.
 
 Type::
   `object`
@@ -149,22 +149,22 @@ Type::
 
 | `allowedRegistries`
 | `array (string)`
-| allowedRegistries are the only registries permitted for image pull and push actions. All other registries are denied. 
+| `allowedRegistries` are the only registries permitted for image pull and push actions. All other registries are denied.
  Only one of BlockedRegistries or AllowedRegistries may be set.
 
 | `blockedRegistries`
 | `array (string)`
-| blockedRegistries cannot be used for image pull and push actions. All other registries are permitted. 
+| `blockedRegistries` cannot be used for image pull and push actions. All other registries are permitted.
  Only one of BlockedRegistries or AllowedRegistries may be set.
 
 | `insecureRegistries`
 | `array (string)`
-| insecureRegistries are registries which do not have a valid TLS certificates or only support HTTP connections.
+| `insecureRegistries` are registries which do not have a valid TLS certificates or only support HTTP connections.
 
 |===
 ..status
 Description::
-  status holds observed values from the cluster. They may not be overridden.
+  `status` holds observed values from the cluster. They may not be overridden.
 
 Type::
   `object`
@@ -178,11 +178,11 @@ Type::
 
 | `externalRegistryHostnames`
 | `array (string)`
-| externalRegistryHostnames provides the hostnames for the default external image registry. The external hostname should be set only when the image registry is exposed externally. The first value is used in 'publicDockerImageRepository' field in ImageStreams. The value must be in "hostname[:port]" format.
+| `externalRegistryHostnames` provides the hostnames for the default external image registry. The external hostname should be set only when the image registry is exposed externally. The first value is used in `publicDockerImageRepository` field in image streams. The value must be in `hostname[:port]` format.
 
 | `internalRegistryHostname`
 | `string`
-| internalRegistryHostname sets the hostname for the default internal image registry. The value must be in "hostname[:port]" format. This value is set by the image registry operator which controls the internal registry hostname. For backward compatibility, users can still use OPENSHIFT_DEFAULT_REGISTRY environment variable but this setting overrides the environment variable.
+| `internalRegistryHostname` sets the hostname for the default internal image registry. The value must be in `hostname[:port]` format. This value is set by the Image Registry Operator which controls the internal registry hostname. For backward compatibility, users can still use `OPENSHIFT_DEFAULT_REGISTRY` environment variable but this setting overrides the environment variable.
 
 |===
 
@@ -269,7 +269,7 @@ Defaults to unset
 .HTTP responses
 [cols="1,1",options="header"]
 |===
-| HTTP code | Reponse body
+| HTTP code | Response body
 | 200 - OK
 | xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`]
 | 401 - Unauthorized
@@ -328,7 +328,7 @@ Defaults to unset
 .HTTP responses
 [cols="1,1",options="header"]
 |===
-| HTTP code | Reponse body
+| HTTP code | Response body
 | 200 - OK
 | xref:../objects/index.adoc#imagelist-config-openshift-io-v1[`ImageList config.openshift.io/v1`]
 | 401 - Unauthorized
@@ -360,13 +360,13 @@ Description::
 | Parameter | Type | Description
 | `body`
 | xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`]
-| 
+|
 |===
 
 .HTTP responses
 [cols="1,1",options="header"]
 |===
-| HTTP code | Reponse body
+| HTTP code | Response body
 | 200 - OK
 | xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`]
 | 201 - Created
@@ -429,13 +429,13 @@ Description::
 | Parameter | Type | Description
 | `body`
 | xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`]
-| 
+|
 |===
 
 .HTTP responses
 [cols="1,1",options="header"]
 |===
-| HTTP code | Reponse body
+| HTTP code | Response body
 | 200 - OK
 | xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`]
 | 202 - Accepted
@@ -466,7 +466,7 @@ Defaults to unset
 .HTTP responses
 [cols="1,1",options="header"]
 |===
-| HTTP code | Reponse body
+| HTTP code | Response body
 | 200 - OK
 | xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`]
 | 401 - Unauthorized
@@ -498,13 +498,13 @@ Description::
 | Parameter | Type | Description
 | `body`
 | xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`]
-| 
+|
 |===
 
 .HTTP responses
 [cols="1,1",options="header"]
 |===
-| HTTP code | Reponse body
+| HTTP code | Response body
 | 200 - OK
 | xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`]
 | 401 - Unauthorized
@@ -536,13 +536,13 @@ Description::
 | Parameter | Type | Description
 | `body`
 | xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`]
-| 
+|
 |===
 
 .HTTP responses
 [cols="1,1",options="header"]
 |===
-| HTTP code | Reponse body
+| HTTP code | Response body
 | 200 - OK
 | xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`]
 | 201 - Created
@@ -594,7 +594,7 @@ Defaults to unset
 .HTTP responses
 [cols="1,1",options="header"]
 |===
-| HTTP code | Reponse body
+| HTTP code | Response body
 | 200 - OK
 | xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`]
 | 401 - Unauthorized
@@ -626,13 +626,13 @@ Description::
 | Parameter | Type | Description
 | `body`
 | xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`]
-| 
+|
 |===
 
 .HTTP responses
 [cols="1,1",options="header"]
 |===
-| HTTP code | Reponse body
+| HTTP code | Response body
 | 200 - OK
 | xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`]
 | 401 - Unauthorized
@@ -664,13 +664,13 @@ Description::
 | Parameter | Type | Description
 | `body`
 | xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`]
-| 
+|
 |===
 
 .HTTP responses
 [cols="1,1",options="header"]
 |===
-| HTTP code | Reponse body
+| HTTP code | Response body
 | 200 - OK
 | xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`]
 | 201 - Created
@@ -678,5 +678,3 @@ Description::
 | 401 - Unauthorized
 | Empty
 |===
-
-