Merge pull request #30835 from jboxman/fix-optional-style

jboxman · web-flow · commit 6715d11b327e · 2021-03-24T14:15:03.000-04:00
Use Optional: instead
diff --git a/modules/cnf-provisioning-real-time-and-low-latency-workloads.adoc b/modules/cnf-provisioning-real-time-and-low-latency-workloads.adoc
@@ -34,9 +34,9 @@ Establishing the right performance expectations refers to the fact that the real
 == Provisioning a worker with real-time capabilities
 
 . Install Performance Addon Operator to the cluster.
-. (Optional) Add a node to the {product-title} cluster.
+. Optional: Add a node to the {product-title} cluster.
 See link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux_for_real_time/8/html-single/tuning_guide/index#Setting_BIOS_parameters[Setting BIOS parameters].
-. (Optional) Create a new machine config pool for real-time nodes.
+. Optional: Create a new machine config pool for real-time nodes.
 . Add the node to the proper machine config pool, using node role labels.
 +
 You must decide which nodes will be configured with real-time workloads. It could be all of the nodes in the cluster or a subset of the nodes. The Performance Addon Operator expects all of the nodes are part of a dedicated machine config pool. If you use all of the nodes, you just point the Performance Addon Operator to the worker node role label. If you use a subset, you must group the nodes into a new machine config pool.
@@ -101,7 +101,7 @@ Use the following procedures for preparing a workload that will use real-time ca
 .Procedure
 
 . Create a pod with a QoS class of `Guaranteed`.
-. (Optional) Disable CPU load balancing for DPDK.
+. Optional: Disable CPU load balancing for DPDK.
 . Assign a proper node selector.
 
 When writing your applications, follow the general recommendations described in
@@ -167,7 +167,7 @@ If a container specifies its own memory limit, but does not specify a memory req
 ====
 
 [id="performance-addon-operator-disabling-cpu-load-balancing-for-dpdk_{context}"]
-== (Optional) Disabling CPU load balancing for DPDK
+== Optional: Disabling CPU load balancing for DPDK
 
 Functionality to disable or enable CPU load balancing is implemented on the CRI-O level. The code under the CRI-O disables or enables CPU load balancing only when the following requirements are met.
 
diff --git a/modules/ipi-install-node-requirements.adoc b/modules/ipi-install-node-requirements.adoc
@@ -22,7 +22,7 @@ endif::[]
 
 - **Latest generation:** Nodes must be of the most recent generation. Installer-provisioned installation relies on BMC protocols, which must be compatible across nodes. Additionally, {op-system-base} 8 ships with the most recent drivers for RAID controllers. Ensure that the nodes are recent enough to support {op-system-base} 8 for the `provisioner` node and {op-system} 8 for the control plane and worker nodes.
 
-- **Registry node:** (Optional) If setting up a disconnected mirrored registry, it is recommended the registry reside in its own node.
+- **Registry node:** Optional: If setting up a disconnected mirrored registry, it is recommended the registry reside in its own node.
 
 - **Provisioner node:** Installer-provisioned installation requires one `provisioner` node.
 
diff --git a/modules/pruning-hard-pruning-registry.adoc b/modules/pruning-hard-pruning-registry.adoc
@@ -97,7 +97,7 @@ $ oc adm policy add-cluster-role-to-user \
     ${service_account} -n openshift-image-registry
 ----
 
-. *(Optional) Run the pruner in dry-run mode.*
+. *Optional: Run the pruner in dry-run mode.*
 +
 To see how many blobs would be removed, run the hard pruner in dry-run mode. No changes are actually made. The following example references an image registry pod called `image-registry-3-vhndw`:
 +
diff --git a/modules/virt-confirming-policy-updates-on-nodes.adoc b/modules/virt-confirming-policy-updates-on-nodes.adoc
@@ -22,21 +22,21 @@ If the policy fails to be applied on the node, the enactment for that node inclu
 $ oc get nncp
 ----
 
-. (Optional) If a policy is taking longer than expected to successfully configure, you can inspect the requested state and status conditions of a particular policy:
+. Optional: If a policy is taking longer than expected to successfully configure, you can inspect the requested state and status conditions of a particular policy:
 +
 [source,terminal]
 ----
 $ oc get nncp <policy> -o yaml
 ----
 
-. (Optional) If a policy is taking longer than expected to successfully configure on all nodes, you can list the status of the enactments on the cluster:
+. Optional: If a policy is taking longer than expected to successfully configure on all nodes, you can list the status of the enactments on the cluster:
 +
 [source,terminal]
 ----
 $ oc get nnce
 ----
 
-. (Optional) To view the configuration of a particular enactment, including any error reporting for a failed configuration:
+. Optional: To view the configuration of a particular enactment, including any error reporting for a failed configuration:
 +
 [source,terminal]
 ----
diff --git a/modules/virt-creating-bridge-nad-web.adoc b/modules/virt-creating-bridge-nad-web.adoc
@@ -20,5 +20,5 @@ to provide existing layer-2 networking to pods and virtual machines.
 . Enter a unique *Name* and optional *Description*.
 . Click the *Network Type* list and select *CNV Linux bridge*.
 . Enter the name of the bridge in the *Bridge Name* field.
-. (Optional) If the resource has VLAN IDs configured, enter the ID numbers in the *VLAN Tag Number* field.
+. Optional: If the resource has VLAN IDs configured, enter the ID numbers in the *VLAN Tag Number* field.
 . Click *Create*.
diff --git a/modules/virt-creating-vm-wizard-web.adoc b/modules/virt-creating-vm-wizard-web.adoc
@@ -27,21 +27,21 @@ Create Network interface cards (NICs) and storage disks later and attach them to
 
 .  Click *Customize virtual machine* to go to the *General* step.
 
-.. (Optional) Edit the *Name* field to specify a custom name for the virtual machine.
+.. Optional: Edit the *Name* field to specify a custom name for the virtual machine.
 
-.. (Optional) In the *Description* field, add a description.
+.. Optional: In the *Description* field, add a description.
 
 . Click *Next* to go to the *Networking* step. A `nic0` NIC is attached by default.
 
-.. (Optional) Click *Add Network Interface* to create additional NICs.
+.. Optional: Click *Add Network Interface* to create additional NICs.
 
-.. (Optional) You can remove any or all NICs by clicking the Options menu {kebab} and selecting *Delete*. A virtual machine does not need a NIC attached to be created. You can create NICs after the virtual machine has been created.
+.. Optional: You can remove any or all NICs by clicking the Options menu {kebab} and selecting *Delete*. A virtual machine does not need a NIC attached to be created. You can create NICs after the virtual machine has been created.
 
 . Click *Next* to go to the *Storage* step.
 
-.. (Optional) Click *Add Disk* to create additional disks. These disks can be removed by clicking the Options menu {kebab} and selecting *Delete*.
+.. Optional: Click *Add Disk* to create additional disks. These disks can be removed by clicking the Options menu {kebab} and selecting *Delete*.
 
-.. (Optional) Click the Options menu {kebab} to edit the disk and save your changes.
+.. Optional: Click the Options menu {kebab} to edit the disk and save your changes.
 
 . Click *Next* to go to the *Advanced* step and review the details for *Cloud-init*.
 
diff --git a/modules/virt-creating-vm-yaml-web.adoc b/modules/virt-creating-vm-yaml-web.adoc
@@ -21,7 +21,7 @@ Navigating away from the YAML screen while editing cancels any changes to the co
 . Click *Create* and select *Virtual Machine With YAML*.
 . Write or paste your virtual machine configuration in the editable window.
 .. Alternatively, use the `example` virtual machine provided by default in the YAML screen.
-. (Optional) Click *Download* to download the YAML configuration file in its present state.
+. Optional: Click *Download* to download the YAML configuration file in its present state.
 . Click *Create* to create the virtual machine.
 
 The virtual machine is listed in the *Virtual Machines* tab.
diff --git a/updating/updating-cluster-rhel-compute.adoc b/updating/updating-cluster-rhel-compute.adoc
@@ -31,7 +31,7 @@ include::modules/understanding-upgrade-channels.adoc[leveloffset=+1]
 include::modules/update-upgrading-web.adoc[leveloffset=+1]
 
 [id="updating-cluster-rhel-compute-hooks"]
-== (Optional) Adding hooks to perform Ansible tasks on RHEL machines
+== Optional: Adding hooks to perform Ansible tasks on RHEL machines
 
 You can use _hooks_ to run Ansible tasks on the RHEL compute machines during
 the {product-title} update.

Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ $ oc adm policy add-cluster-role-to-user \`
`97`	`97`	`${service_account} -n openshift-image-registry`
`98`	`98`	`----`
`99`	`99`
`100`		`-. (Optional) Run the pruner in dry-run mode.`
	`100`	`+. Optional: Run the pruner in dry-run mode.`
`101`	`101`	`+`
`102`	`102`	To see how many blobs would be removed, run the hard pruner in dry-run mode. No changes are actually made. The following example references an image registry pod called `image-registry-3-vhndw`:
`103`	`103`	`+`