Updating optional steps per the style guide

2026-02-05 21:46:22 +01:00 · 2019-06-25 14:53:17 -04:00
parent 0ece9b4e9c
commit 7793d8bb8b
19 changed files with 28 additions and 29 deletions
--- a/modules/cnv-resuming-node-maintenance-cli.adoc
+++ b/modules/cnv-resuming-node-maintenance-cli.adoc
@@ -16,7 +16,7 @@ the `NodeMaintenance` object for the node.
 $ oc get nodemaintenance
 ----

-. (Optional) Insepct the `NodeMaintenance` object to ensure it is associated with the correct node:
+. Optional: Insepct the `NodeMaintenance` object to ensure it is associated with the correct node:
 +
 ----
 $ oc describe nodemaintenance <node02-maintenance>
--- a/modules/identity-provider-registering-github.adoc
+++ b/modules/identity-provider-registering-github.adoc
@@ -19,7 +19,7 @@ https://github.com/settings/applications/new[Register a new OAuth application].
 . Enter an application name, for example `My OpenShift Install`.
 . Enter a homepage URL, such as
 `\https://oauth-openshift.apps.<cluster-name>.<cluster-domain>`.
-. Optionally, enter an application description.
+. Optional: Enter an application description.
 . Enter the authorization callback URL, where the end of the URL contains the
 identity provider `name`:
 +
--- a/modules/images-test-s2i.adoc
+++ b/modules/images-test-s2i.adoc
@@ -120,7 +120,7 @@ $ docker run _<BUILDER_IMAGE_NAME>_ .
 $ s2i build file:///path-to-sample-app _<BUILDER_IMAGE_NAME>_ _<OUTPUT_APPLICATION_IMAGE_NAME>_
 ----

-. Optionally, if you support *_save-artifacts_*, run step 2 once again to
+. Optional: if you support *_save-artifacts_*, run step 2 once again to
 verify that saving and restoring artifacts works properly.

 . Run the container:
--- a/modules/installation-aws-iam-user.adoc
+++ b/modules/installation-aws-iam-user.adoc
@@ -33,7 +33,7 @@ The cluster will not have the ability to grant additional credentials to
 individual components, so the same credentials are used by all components.
 ====

-. Optionally, add metadata to the user by attaching tags.
+. Optional: Add metadata to the user by attaching tags.

 . Confirm that the user name that you specified is granted the
 `AdministratorAccess` policy.
--- a/modules/installation-creating-worker-machineset.adoc
+++ b/modules/installation-creating-worker-machineset.adoc
@@ -15,7 +15,7 @@ cluster.

 .Procedure

-. Optionally, launch worker nodes that are controlled by the machine API.
+. Optional: Launch worker nodes that are controlled by the machine API.
 . View the list of MachineSets in the `openshift-machine-api` namespace:
 +
 ----
@@ -119,7 +119,7 @@ infrastructure name that you extracted from the Ignition config metadata,
 which has the format `<cluster-name>-<random-string>`.

 ////
-. Optionally, replace the `subnet` stanza with one that specifies the subnet
+. Optional: Replace the `subnet` stanza with one that specifies the subnet
 to deploy the machines on:
 +
 ----
--- a/modules/installation-generate-aws-user-infra.adoc
+++ b/modules/installation-generate-aws-user-infra.adoc
@@ -43,7 +43,7 @@ names for the installation assets might change between releases. Use caution
 when copying installation files from an earlier {product-title} version.
 ====
 .. At the prompts, provide the configuration details for your cloud:
-... Optionally, select an SSH key to use to access your cluster machines.
+... Optional: Select an SSH key to use to access your cluster machines.
 +
 [NOTE]
 ====
@@ -73,7 +73,7 @@ compute:
  replicas: 0
 ----

-. Optionally, back up the `install-config.yaml` file.
+. Optional: Back up the `install-config.yaml` file.
 +
 [IMPORTANT]
 ====
--- a/modules/installation-initializing.adoc
+++ b/modules/installation-initializing.adoc
@@ -35,7 +35,7 @@ names for the installation assets might change between releases. Use caution
 when copying installation files from an earlier {product-title} version.
 ====
 .. At the prompts, provide the configuration details for your cloud:
-... Optionally, select an SSH key to use to access your cluster machines.
+... Optional: Select an SSH key to use to access your cluster machines.
 +
 [NOTE]
 ====
--- a/modules/installation-launching-installer.adoc
+++ b/modules/installation-launching-installer.adoc
@@ -56,7 +56,7 @@ when copying installation files from an earlier {product-title} version.
 --
 Provide values at the prompts:

-.. Optionally, select an SSH key to use to access your cluster machines.
+.. Optional: Select an SSH key to use to access your cluster machines.
 +
 [NOTE]
 ====
@@ -93,5 +93,5 @@ You must not delete the installation program or the files that the installation
 program creates. Both are required to delete the cluster.
 ====

-. Optionally, remove or disable the `AdministratorAccess` policy from the IAM
+. Optional: Remove or disable the `AdministratorAccess` policy from the IAM
 account that you used to install the cluster.
--- a/modules/installation-uninstall-aws.adoc
+++ b/modules/installation-uninstall-aws.adoc
@@ -13,7 +13,7 @@ You can remove a cluster that you installed on Amazon Web Services (AWS).

 .Procedure

-. Optionally, from the computer that you used to install the cluster, run the
+. Optional: From the computer that you used to install the cluster, run the
 following command and record the UUID that it outputs:
 +
 ----
@@ -39,5 +39,5 @@ your cluster. The installation program requires the `metadata.json` file in this
 directory to delete the cluster.
 ====

-. Optionally, delete the `<installation_directory>` directory and the
+. Optional: Delete the `<installation_directory>` directory and the
 {product-title} installation program.
--- a/modules/installation-vsphere-machines.adoc
+++ b/modules/installation-vsphere-machines.adoc
@@ -121,7 +121,7 @@ include the machine type in the name, such as `control-plane-0` or `compute-1`.
 you created for the cluster.
 .. On the *Select a compute resource* tab, select the name of a host in your
 datacenter.
-.. Optionally, on the *Select storage* tab, customize the storage options.
+.. Optional: On the *Select storage* tab, customize the storage options.
 .. On the *Select clone options*, select
 *Customize this virtual machine's hardware*.
 .. On the *Customize hardware* tab, click *VM Options* -> *Advanced*.
--- a/modules/monitoring-enabling-dynamically-provisioned-storage.adoc
+++ b/modules/monitoring-enabling-dynamically-provisioned-storage.adoc
@@ -14,7 +14,7 @@ Instead of statically-provisioned storage, you can use dynamically-provisioned s
 * `openshift_cluster_monitoring_operator_prometheus_storage_enabled`   (Default: false)
 * `openshift_cluster_monitoring_operator_alertmanager_storage_enabled` (Default: false)
 +
-. (optional) After you enable dynamic storage, you can also set the `storageclass` for the persistent volume claim for each component in the following parameters in the Ansible inventory file:
+. Optional: After you enable dynamic storage, you can also set the `storageclass` for the persistent volume claim for each component in the following parameters in the Ansible inventory file:
 +
 * `openshift_cluster_monitoring_operator_prometheus_storage_class_name`   (default: "")
 * `openshift_cluster_monitoring_operator_alertmanager_storage_class_name` (default: "")
--- a/modules/monitoring-getting-information-about-alerts-and-alerting-rules.adoc
+++ b/modules/monitoring-getting-information-about-alerts-and-alerting-rules.adoc
@@ -11,11 +11,11 @@ You can find an alert and see information about it or its governing alerting rul

 . Open the {product-title} web console and navigate to *Monitoring* -> *Alerts*.

-. Optionally, filter the alerts by name using the *Filter alerts by name* field.
+. Optional: Filter the alerts by name using the *Filter alerts by name* field.

-. Optionally, filter the alerts by state using one or more of the state buttons *Firing*, *Silenced*, *Pending*, *Not firing*.
+. Optional: Filter the alerts by state using one or more of the state buttons *Firing*, *Silenced*, *Pending*, *Not firing*.

-. Optionally, sort the alerts by clicking one or more of the *Name*, *State*, and *Severity* column headers.
+. Optional: Sort the alerts by clicking one or more of the *Name*, *State*, and *Severity* column headers.

 . After you see the alert, you can see either details of the alert or details of its governing alerting rule.
 +
--- a/modules/monitoring-getting-information-about-silences.adoc
+++ b/modules/monitoring-getting-information-about-silences.adoc
@@ -11,11 +11,11 @@ You can find a silence and view its details.

 . Open the {product-title} web console and navigate to *Monitoring* -> *Silences*.

-. Optionally, filter the silences by name using the *Filter Silences by name* field.
+. Optional: Filter the silences by name using the *Filter Silences by name* field.

-. Optionally, filter the silences by state using one or more of the state buttons *Active*, *Pending*, *Expired*.
+. Optional: Filter the silences by state using one or more of the state buttons *Active*, *Pending*, *Expired*.

-. Optionally, sort the silences by clicking one or more of the *Name*, *State*, and *Firing alerts* column headers.
+. Optional: Sort the silences by clicking one or more of the *Name*, *State*, and *Firing alerts* column headers.

 . After you see the silence, you can click its name to see the details, including:
 +
@@ -26,4 +26,3 @@ You can find a silence and view its details.
 * End time
 * Number and list of firing alerts
 --
-
--- a/modules/monitoring-silencing-alerts.adoc
+++ b/modules/monitoring-silencing-alerts.adoc
@@ -25,6 +25,6 @@ To silence a specific alert:

 . For the alert that you want to silence, click the button in the last column and click *Silence Alert*. The *Create Silence* form will appear with prepopulated specification of the chosen alert.

-. Optionally, modify the silence.
+. Optional: Modify the silence.

 . To create the silence, click *Create*.
--- a/modules/nw-kube-proxy-configuring.adoc
+++ b/modules/nw-kube-proxy-configuring.adoc
@@ -75,7 +75,7 @@ items:
 kind: List
 ----

-. Optionally, run the following command to confirm that the Cluster Network
+. Optional: Run the following command to confirm that the Cluster Network
 Operator accepted the configuration change:
 +
 ----
--- a/modules/nw-modifying-operator-install-config.adoc
+++ b/modules/nw-modifying-operator-install-config.adoc
@@ -76,6 +76,6 @@ you must specify only the parameters that you want to change in the
 `Network.operator.openshift.io` CR.

 . Save the `cluster-network-03-config.yml` file and quit the text editor.
-. Optionally, back up the `manifests/cluster-network-03-config.yml` file. The
+. Optional: Back up the `manifests/cluster-network-03-config.yml` file. The
 installation program deletes the `manifests/` directory when creating the
 cluster.
--- a/modules/nw-multitenant-joining.adoc
+++ b/modules/nw-multitenant-joining.adoc
@@ -24,7 +24,7 @@ Alternatively, instead of specifying specific project names, you can use the
 `--selector=<project_selector>` option to specify projects based upon an
 associated label.

-. Optionally, run the following command to view the pod networks that you have
+. Optional: Run the following command to view the pod networks that you have
 joined together:
 +
 ----
--- a/modules/service-accounts-creating.adoc
+++ b/modules/service-accounts-creating.adoc
@@ -10,7 +10,7 @@ binding it to a role.

 .Procedure

-. (Optional) To view the service accounts in the current project:
+. Optional: To view the service accounts in the current project:
 +
 ----
 $ oc get sa
@@ -30,7 +30,7 @@ serviceaccount "robot" created
 ----
 <1> To create a service account in a different project, specify `-n <project_name>`.

-. (Optional) View the secrets for the service account:
+. Optional: View the secrets for the service account:
 +
 ----
 $ oc describe sa robot
--- a/modules/setting-up-cpu-manager.adoc
+++ b/modules/setting-up-cpu-manager.adoc
@@ -7,7 +7,7 @@

 .Procedure

-. Optionally, label a node:
+. Optional: Label a node:
 +
 ----
 # oc label node perf-node.example.com cpumanager=true