Skip to content

Commit 45318b1

Browse files
authored
Merge pull request #20616 from jboxman/check-optional
Fix style for options that are not compulsory
2 parents ae93275 + 9913129 commit 45318b1

7 files changed

+17
-17
lines changed

modules/cluster-logging-collector-fluentd.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ For example:
191191
$ oc create configmap secure-forward --from-file=secure-forward.conf -n openshift-logging
192192
----
193193

194-
. Optionally, import any secrets required for the receiver:
194+
. Optional: Import any secrets required for the receiver:
195195
+
196196
----
197197
$ oc create secret generic secure-forward --from-file=<arbitrary-name-of-key1>=cert_file_from_fluentd_receiver --from-literal=shared_key=value_from_fluentd_receiver

modules/migration-running-migration-plan-cam.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ You can run *Stage* multiple times to reduce the actual migration time.
2929
+
3030
*Migrate* stops the application workload on the source cluster and recreates its resources on the target cluster.
3131

32-
. Optionally, in the *Migrate* window, you can select *Do not stop applications on the source cluster during migration*.
32+
. Optional: In the *Migrate* window, you can select *Do not stop applications on the source cluster during migration*.
3333
. Click *Migrate*.
3434
. When the migration is complete, verify that the application migrated successfully in the {product-title} web console:
3535

modules/monitoring-enabling-monitoring-of-your-own-services.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ data:
3535

3636
. Save the file to apply the changes. Monitoring your own services is enabled automatically.
3737

38-
. Optionally, you can check that the `prometheus-user-workload` pods were created:
38+
. Optional: You can check that the `prometheus-user-workload` pods were created:
3939
+
4040
----
4141
$ oc -n openshift-user-workload-monitoring get pod

modules/nw-egressnetworkpolicy-edit.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To edit an existing egress network policy object for a project, complete the fol
2424
$ oc get -n <project> egressnetworkpolicy
2525
----
2626

27-
. Optionally, if you did not save a copy of the EgressNetworkPolicy object when you created the egress network firewall, enter the following command to create a copy.
27+
. Optional: If you did not save a copy of the EgressNetworkPolicy object when you created the egress network firewall, enter the following command to create a copy.
2828
+
2929
----
3030
$ oc get -n <project> \ <1>

modules/nw-sriov-network-attachment.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,32 +54,32 @@ spec:
5454
----
5555
<1> Replace `<name>` with a name for the CR. The Operator will create a NetworkAttachmentDefinition CR with same name.
5656
<2> Specify the namespace where the SR-IOV Operator is installed.
57-
<3> Optional. Replace `<target_namespace>` with the namespace where the NetworkAttachmentDefinition CR will be created. The default value is `openshift-sriov-network-operator`.
58-
<4> Optional. Replace `<ipam>` a configuration object for the ipam CNI plug-in as a YAML block scalar. The plug-in manages IP address assignment for the attachment definition.
59-
<5> Optional. Replace `<vlan>` with a Virtual LAN (VLAN) ID for the additional network. The integer value must be from `0` to `4095`. The default value is `0`.
57+
<3> Optional: Replace `<target_namespace>` with the namespace where the NetworkAttachmentDefinition CR will be created. The default value is `openshift-sriov-network-operator`.
58+
<4> Optional: Replace `<ipam>` a configuration object for the ipam CNI plug-in as a YAML block scalar. The plug-in manages IP address assignment for the attachment definition.
59+
<5> Optional: Replace `<vlan>` with a Virtual LAN (VLAN) ID for the additional network. The integer value must be from `0` to `4095`. The default value is `0`.
6060
<6> Replace `<sriov_resource_name>` with the value for the `.spec.resourceName` parameter from the SriovNetworkNodePolicy CR that defines the SR-IOV hardware for this additional network.
61-
<7> Optional. Replace `<link_state>` with the link state of Virtual Function (VF). Allowed value are `enable`, `disable` and `auto`.
62-
<8> Optional. Replace `<max_tx_rate>` with a maximum transmission rate, in Mbps, for the VF.
63-
<9> Optional. Replace `<min_tx_rate>` with a minimum transmission rate, in Mbps, for the VF. This value should always be less than or equal to Maximum transmission rate.
61+
<7> Optional: Replace `<link_state>` with the link state of Virtual Function (VF). Allowed value are `enable`, `disable` and `auto`.
62+
<8> Optional: Replace `<max_tx_rate>` with a maximum transmission rate, in Mbps, for the VF.
63+
<9> Optional: Replace `<min_tx_rate>` with a minimum transmission rate, in Mbps, for the VF. This value should always be less than or equal to Maximum transmission rate.
6464
+
6565
[NOTE]
6666
====
6767
Intel NICs do not support the `minTxRate` parameter. For more information, see link:https://bugzilla.redhat.com/show_bug.cgi?id=1772847[BZ#1772847].
6868
====
69-
<10> Optional. Replace `<vlan_qos>` with an IEEE 802.1p priority level for the VF. The default value is `0`.
70-
<11> Optional. Replace `<spoof_check>` with the spoof check mode of the VF. The allowed values are the strings `"on"` and `"off"`.
69+
<10> Optional: Replace `<vlan_qos>` with an IEEE 802.1p priority level for the VF. The default value is `0`.
70+
<11> Optional: Replace `<spoof_check>` with the spoof check mode of the VF. The allowed values are the strings `"on"` and `"off"`.
7171
+
7272
[IMPORTANT]
7373
====
7474
You must enclose the value you specify in quotes or the CR will be rejected by the SR-IOV Network Operator.
7575
====
76-
<12> Optional. Replace `<trust_vf>` with the trust mode of the VF. The allowed values are the strings `"on"` and `"off"`.
76+
<12> Optional: Replace `<trust_vf>` with the trust mode of the VF. The allowed values are the strings `"on"` and `"off"`.
7777
+
7878
[IMPORTANT]
7979
====
8080
You must enclose the value you specify in quotes or the CR will be rejected by the SR-IOV Network Operator.
8181
====
82-
<13> Optional. Replace `<capabilities>` with the capabilities to configure for this network. You can specify `"{ "ips": true }"` to enable IP address support or `"{ "mac": true }"` to enable MAC address support.
82+
<13> Optional: Replace `<capabilities>` with the capabilities to configure for this network. You can specify `"{ "ips": true }"` to enable IP address support or `"{ "mac": true }"` to enable MAC address support.
8383

8484
[start=2]
8585
. Create the CR by running the following command:

modules/odc-creating-projects-using-developer-perspective.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ You can create a project using the *Developer* perspective, as follows:
2424
image::odc_create_project.png[Create Project]
2525

2626
. In the *Create Project* dialog box, enter a unique name for the *Name* field. For example, enter `myproject` as the name of the project in the *Name* field.
27-
. Optionally, add the *Display Name* and *Description* details for the Project.
27+
. Optional: Add the *Display Name* and *Description* details for the Project.
2828
. Click *Create*.
2929
. Navigate to the *Advanced → Project Details* page to see the dashboard for your project.
3030
. In the *Project* drop-down menu at the top of the screen, select *all projects* to list all of the projects in your cluster. If you have adequate permissions for a project, you can use the *Options* menu {kebab} to edit or delete the project.

modules/odc-importing-codebase-from-git-to-create-application.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Create, build, and deploy an application on {product-title} using an existing co
1616
image::odc_import_from_git.png[Import from Git]
1717

1818
. In the *Git* section, enter the Git repository URL for the codebase you want to use to create an application. For example, enter the URL of this sample Node.js application `\https://github.com/sclorg/nodejs-ex`. The URL is then validated.
19-
. Optionally, you can click *Show Advanced Git Options* to add details such as:
19+
. Optional: You can click *Show Advanced Git Options* to add details such as:
2020

2121
* *Git Reference* to point to code in a specific branch, tag, or commit to be used to build the application.
2222
* *Context Dir* to specify the subdirectory for the application source code you want to use to build the application.
@@ -45,7 +45,7 @@ The *Knative Service* option is displayed in the *Import from git* form only if
4545
====
4646

4747
. In the *Advanced Options* section, the *Create a route to the application* is selected by default so that you can access your application using a publicly available URL. You can clear the check box if you do not want to expose your application on a public route.
48-
. Optionally, you can use the following advanced options to further customize your application:
48+
. Optional: You can use the following advanced options to further customize your application:
4949

5050
Routing::
5151
Click the *Routing* link to:

0 commit comments

Comments
 (0)