Skip to content

Commit 60261b4

Browse files
kowen-rhcfergeau
authored andcommitted
Issue #1156 Apply IBM style guide to documentation
1 parent 20d32e7 commit 60261b4

7 files changed

+10
-10
lines changed

docs/source/topics/assembly_accessing-the-openshift-cluster.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[id="accessing-the-openshift-cluster_{context}"]
22
= Accessing the OpenShift cluster
33

4-
Access the OpenShift cluster running in the {prod} virtual machine via the OpenShift web console or client binary ([command]`oc`).
4+
Access the OpenShift cluster running in the {prod} virtual machine through the OpenShift web console or client binary ([command]`oc`).
55

66
include::proc_accessing-the-openshift-web-console.adoc[leveloffset=+1]
77

docs/source/topics/proc_accessing-the-openshift-cluster-with-oc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ For more information, see <<starting-the-virtual-machine_{context}>>.
88

99
.Procedure
1010

11-
To access the OpenShift cluster via the [command]`oc` command, follow these steps:
11+
To access the OpenShift cluster through the [command]`oc` command, follow these steps:
1212

1313
. Run the [command]`{bin} oc-env` command to print the command needed to add the cached [command]`oc` binary to your `_PATH_`:
1414
+

docs/source/topics/proc_basic-troubleshooting.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ Resolve most issues by stopping the {prod} virtual machine, deleting it, and sta
55

66
.Prerequisites
77

8-
* You set up the host machine via the [command]`{bin} setup` command.
8+
* You set up the host machine through the [command]`{bin} setup` command.
99
For more information, see <<setting-up-codeready-containers_{context}>>.
10-
* You started {prod} via the [command]`{bin} start` command.
10+
* You started {prod} through the [command]`{bin} start` command.
1111
For more information, see <<starting-the-virtual-machine_{context}>>.
1212
* You are using the latest {prod} release.
1313
Using a version earlier than {prod} 1.2.0 may result in errors related to expired x509 certificates.

docs/source/topics/proc_starting-codeready-containers-behind-proxy.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
* To use an existing [command]`oc` binary on your host machine, export the `.testing` domain as part of the `no_proxy` environment variable.
77

88
* The embedded [command]`oc` binary does not require manual settings.
9-
For more information on using the embedded [command]`oc` binary, see <<accessing-the-openshift-cluster-with-oc_{context}>>.
9+
For more information about using the embedded [command]`oc` binary, see <<accessing-the-openshift-cluster-with-oc_{context}>>.
1010

1111

1212
.Procedure
@@ -22,10 +22,10 @@ $ {bin} config set https-proxy http://example.proxy.com:__<port>__
2222
$ {bin} config set no-proxy __<comma-separated-no-proxy-entries>__
2323
----
2424
+
25-
The [command]`{bin}` binary will be able to use the defined proxy once set via environment variables or {prod} configuration.
25+
The [command]`{bin}` binary will be able to use the defined proxy once set through environment variables or {prod} configuration.
2626

2727
[NOTE]
2828
====
29-
* Proxy-related values set in the configuration for {prod} have priority over values set via environment variables.
29+
* Proxy-related values set in the configuration for {prod} have priority over values set through environment variables.
3030
* SOCKS proxies are not supported by OpenShift Container Platform.
3131
====

docs/source/topics/proc_starting-monitoring-alerting-telemetry.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Telemetry functionality is responsible for listing your cluster in the link:http
99

1010
* A running {prod} virtual machine and a working [command]`oc` command.
1111
For more information, see <<accessing-the-openshift-cluster-with-oc_{context}>>.
12-
* You must log in via [command]`oc` as the `kubeadmin` user.
12+
* You must log in through [command]`oc` as the `kubeadmin` user.
1313
* You must assign additional memory to the {prod} virtual machine.
1414
At least 12 GiB of memory (a value of `12288`) is recommended.
1515
For more information, see <<configuring-the-virtual-machine_{context}>>.

docs/source/topics/proc_starting-the-virtual-machine.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The [command]`{bin} start` command starts the {prod} virtual machine and OpenShi
55

66
.Prerequisites
77

8-
* You set up the host machine via the [command]`{bin} setup` command.
8+
* You set up the host machine through the [command]`{bin} setup` command.
99
For more information, see <<setting-up-codeready-containers_{context}>>.
1010
* You have a valid OpenShift user pull secret.
1111
Copy or download the pull secret from the Pull Secret section of the link:https://cloud.redhat.com/openshift/install/crc/installer-provisioned[Install on Laptop: {rh-prod}] page on cloud.redhat.com.

docs/source/topics/ref_dns-configuration.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Additional checks are done to verify DNS is properly configured when running [co
2020
On Linux, {prod} expects the following DNS configuration:
2121

2222
* {prod} expects NetworkManager to manage networking.
23-
* NetworkManager uses `dnsmasq` via the [filename]`/etc/NetworkManager/conf.d/crc-nm-dnsmasq.conf` configuration file.
23+
* NetworkManager uses `dnsmasq` through the [filename]`/etc/NetworkManager/conf.d/crc-nm-dnsmasq.conf` configuration file.
2424
* The configuration file for this `dnsmasq` instance is [filename]`/etc/NetworkManager/dnsmasq.d/crc.conf`:
2525
+
2626
----

0 commit comments

Comments
 (0)