Issue #1055 Fix style errors in documentation

kowen-rh · praveenkumar · commit ff035d45179e · 2020-03-05T19:19:23.000+05:30
diff --git a/docs/source/getting_started/content/assembly_accessing-the-openshift-cluster.adoc b/docs/source/getting_started/content/assembly_accessing-the-openshift-cluster.adoc
@@ -1,7 +1,7 @@
 [id="accessing-the-openshift-cluster_{context}"]
 = Accessing the OpenShift cluster
 
-The OpenShift cluster running in the {prod} virtual machine can be accessed via the OpenShift web console or the OpenShift client binary ([command]`oc`).
+Access the OpenShift cluster running in the {prod} virtual machine via the OpenShift web console or client binary ([command]`oc`).
 
 include::proc_accessing-the-openshift-web-console.adoc[leveloffset=+1]
 
diff --git a/docs/source/getting_started/content/assembly_introducing-codeready-containers.adoc b/docs/source/getting_started/content/assembly_introducing-codeready-containers.adoc
@@ -1,6 +1,6 @@
 [id="introducing-codeready-containers_{context}"]
 = Introducing {rh-prod}
 
-include::con_understanding-codeready-containers.adoc[leveloffset=+1]
+include::con_about-codeready-containers.adoc[leveloffset=+1]
 
 include::con_differences-from-production-openshift-install.adoc[leveloffset=+1]
diff --git a/docs/source/getting_started/content/assembly_troubleshooting.adoc b/docs/source/getting_started/content/assembly_troubleshooting.adoc
@@ -4,8 +4,9 @@
 [NOTE]
 ====
 The goal of {rh-prod} is to deliver an OpenShift environment for development and testing purposes.
-Issues occurring during installation or usage of specific OpenShift applications are outside of the scope of {prod} and should be reported to the relevant project.
-For example, OpenShift issues are tracked on link:https://github.com/openshift/origin/issues[GitHub].
+Issues occurring during installation or usage of specific OpenShift applications are outside of the scope of {prod}.
+Report such issues to the relevant project.
+For example, OpenShift tracks issues on link:https://github.com/openshift/origin/issues[GitHub].
 ====
 
 include::proc_basic-troubleshooting.adoc[leveloffset=+1]
diff --git a/docs/source/getting_started/content/con_about-codeready-containers-configuration.adoc b/docs/source/getting_started/content/con_about-codeready-containers-configuration.adoc
@@ -1,12 +1,12 @@
 [id="about-codeready-containers-configuration_{context}"]
 = About {prod} configuration
 
-You can use the [command]`{bin} config` command to configure both the [command]`{bin}` binary and the {prod} virtual machine.
+Use the [command]`{bin} config` command to configure both the [command]`{bin}` binary and the {prod} virtual machine.
 The [command]`{bin} config` command requires a subcommand to act on the configuration.
 The available subcommands are `get`, `set,` `unset`, and `view`.
 The `get`, `set`, and `unset` subcommands operate on named configurable properties.
 Run the [command]`{bin} config --help` command to list the available properties.
 
 You can also use the [command]`{bin} config` command to configure the behavior of the startup checks for the [command]`{bin} start` and [command]`{bin} setup` commands.
 By default, startup checks report an error and stop execution when their conditions are not met.
-To change this behavior, set the value of a property starting with `skip-check` or `warn-check` to `true` to skip the check or report a warning rather than an error, respectively.
+Set the value of a property starting with `skip-check` or `warn-check` to `true` to skip the check or report a warning rather than an error, respectively.
diff --git a/docs/source/getting_started/content/con_about-codeready-containers.adoc b/docs/source/getting_started/content/con_about-codeready-containers.adoc
@@ -0,0 +1,11 @@
+[id="about-codeready-containers_{context}"]
+= About {prod}
+
+{rh-prod} brings a minimal OpenShift 4 cluster to your local computer.
+This cluster provides a minimal environment for development and testing purposes.
+{prod} is mainly targeted at running on developers' desktops.
+For other use cases, such as headless or multi-developer setups, use the link:https://cloud.redhat.com/openshift/install/[full OpenShift installer].
+
+Refer to the link:https://docs.openshift.com/container-platform/latest/welcome/index.html#developer-activities[OpenShift documentation] for a full introduction to OpenShift.
+
+{prod} includes the [command]`{bin}` command-line interface (CLI) to interact with the {prod} virtual machine running the OpenShift cluster.
diff --git a/docs/source/getting_started/content/con_differences-from-production-openshift-install.adoc b/docs/source/getting_started/content/con_differences-from-production-openshift-install.adoc
@@ -1,11 +1,12 @@
 [id="differences-from-production-openshift-install_{context}"]
-= Differences from a production OpenShift install
+= Differences from a production OpenShift installation
 
 {rh-prod} is a regular OpenShift installation with the following notable differences:
 
-* It uses a single node which behaves both as a master and as a worker node.
-* The `machine-config` and `monitoring` Operators are disabled by default.
-* These disabled Operators will cause the corresponding parts of the web console to be non functional.
-* For the same reason, there is currently no upgrade path to newer OpenShift versions.
-* Due to technical limitations, the {prod} cluster is ephemeral and will need to be recreated from scratch once a month using a newer release.
-* The OpenShift instance is running in a virtual machine, which could cause some other differences, in particular in relation with external networking.
+* **The {prod} OpenShift cluster is ephemeral and is not intended for production use.**
+* It uses a single node which behaves as both a master and worker node.
+* It disables the `machine-config` and `monitoring` Operators by default.
+** These disabled Operators cause the corresponding parts of the web console to be non-functional.
+** For the same reason, there is no upgrade path to newer OpenShift versions.
+* The OpenShift instance runs in a virtual machine.
+This may cause other differences, particularly with external networking.
diff --git a/docs/source/getting_started/content/con_understanding-codeready-containers.adoc b/docs/source/getting_started/content/con_understanding-codeready-containers.adoc
diff --git a/docs/source/getting_started/content/proc_accessing-the-openshift-cluster-with-oc.adoc b/docs/source/getting_started/content/proc_accessing-the-openshift-cluster-with-oc.adoc
@@ -28,12 +28,12 @@ $ oc login -u developer https://api.crc.testing:6443
 +
 [NOTE]
 ====
-The password for the `developer` user was printed in the output of the [command]`{bin} start` command.
+The [command]`{bin} start` command prints the password for the `developer` user.
 You can also view it by running the [command]`{bin} console --credentials` command.
 ====
 
 . You can now use [command]`oc` to interact with your OpenShift cluster.
-For example, to verify that the OpenShift cluster operators are available:
+For example, to verify that the OpenShift cluster Operators are available:
 +
 [subs="+quotes,attributes",options="nowrap"]
 ----
@@ -42,13 +42,12 @@ $ oc get co
 +
 [NOTE]
 ====
-* The `machine-config` cluster operator is expected to report `False` availability.
-* The `monitoring` cluster operator is expected to report `Unknown` availability.
+* {prod} disables the `machine-config` and `monitoring` Operators by default.
 ====
 
 See <<troubleshooting-codeready-containers_{context}>> if you cannot access the {prod} OpenShift cluster.
 
 .Additional resources
 
 * The link:https://docs.openshift.com/container-platform/latest/applications/projects/working-with-projects.html[OpenShift documentation] covers the creation of projects and applications.
-* link:https://docs.openshift.com/container-platform/4.2/cli_reference/openshift_developer_cli/understanding-odo.html[OpenShift Do] (`odo`) can also be used to create OpenShift projects and applications from the command line.
+* You can also use link:https://docs.openshift.com/container-platform/4.2/cli_reference/openshift_developer_cli/understanding-odo.html[OpenShift Do] (`odo`) to create OpenShift projects and applications from the command line.
diff --git a/docs/source/getting_started/content/proc_accessing-the-openshift-web-console.adoc b/docs/source/getting_started/content/proc_accessing-the-openshift-web-console.adoc
@@ -17,10 +17,10 @@ This will open your web browser and direct it to the web console.
 +
 [NOTE]
 ====
-* You can also view the password for the `developer` and `kubeadmin` user by running [command]`{bin} console --credentials`.
-* The cluster can initially be accessed through either the `kubeadmin` or `developer` user.
-For creating projects or OpenShift applications, and for application deployment, the `developer` user should be used.
-The `kubeadmin` user should only be used for administrative tasks such as creating new users, setting roles, and so on.
+* You can also view the password for the `developer` and `kubeadmin` users by running [command]`{bin} console --credentials`.
+* You can initially access the cluster through either the `kubeadmin` or `developer` user.
+Use the `developer` user for creating projects or OpenShift applications and for application deployment.
+Only use the `kubeadmin` user for administrative tasks such as creating new users, setting roles, and so on.
 ====
 
 See <<troubleshooting-codeready-containers_{context}>> if you cannot access the {prod} OpenShift cluster.
diff --git a/docs/source/getting_started/content/proc_basic-troubleshooting.adoc b/docs/source/getting_started/content/proc_basic-troubleshooting.adoc
@@ -1,17 +1,16 @@
 [id="basic-troubleshooting_{context}"]
 = Basic troubleshooting
 
-The majority of issues can be resolved by stopping a running {prod} virtual machine, deleting the virtual machine, and starting a new instance of the virtual machine.
+Resolve most issues by stopping the {prod} virtual machine, deleting it, and starting a new instance.
 
 .Prerequisites
 
-* The host machine has been set up using the [command]`{bin} setup` command.
+* You set up the host machine via the [command]`{bin} setup` command.
 For more information, see <<setting-up-codeready-containers_{context}>>.
-* The virtual machine has been started using the [command]`{bin} start` command.
+* You started {prod} via the [command]`{bin} start` command.
 For more information, see <<starting-the-virtual-machine_{context}>>.
 * You are using the latest {prod} release.
-The generated certificates for the embedded system image bundle expire after 30 days.
-Using an older system image bundle may result in errors related to expired x509 certificates.
+Using a version earlier than {prod} 1.2.0 may result in errors related to expired x509 certificates.
 For more information, see <<troubleshooting-expired-certificates_{context}>>.
 
 .Procedure
@@ -41,11 +40,11 @@ $ {bin} start
 +
 [NOTE]
 ====
-The cluster takes a minimum of four minutes to start the necessary containers and operators before serving a request.
+The cluster takes a minimum of four minutes to start the necessary containers and Operators before serving a request.
 ====
 
-If your issue has not been resolved by this procedure, perform the following steps:
+If your issue is not resolved by this procedure, perform the following steps:
 
 . link:https://github.com/code-ready/crc/issues[Search open issues] for the issue that you are encountering.
 . If no existing issue addresses the encountered issue, link:https://github.com/code-ready/crc/issues/new[create an issue] and link:https://help.github.com/en/articles/file-attachments-on-issues-and-pull-requests[attach the [filename]`~/.crc/crc.log` file] to the created issue.
-The [filename]`~/.crc/crc.log` file contains detailed debugging and troubleshooting information which can help diagnose the problem that you are experiencing.
+The [filename]`~/.crc/crc.log` file has detailed debugging and troubleshooting information which can help diagnose the problem that you are experiencing.
diff --git a/docs/source/getting_started/content/proc_configuring-the-virtual-machine.adoc b/docs/source/getting_started/content/proc_configuring-the-virtual-machine.adoc
@@ -5,7 +5,7 @@ Use the `cpus` and `memory` properties to configure the default number of vCPUs
 
 [IMPORTANT]
 ====
-You cannot modify the configuration of an existing {prod} virtual machine.
+You cannot change the configuration of an existing {prod} virtual machine.
 To enable configuration changes, you must delete the existing virtual machine and create a new one.
 
 To create the new virtual machine, first delete the existing {prod} virtual machine, then start a new virtual machine with the configuration changes:
@@ -33,7 +33,7 @@ $ {bin} config set cpus _<number>_
 ----
 +
 The default value for the `cpus` property is `4`.
-The number of vCPUs to allocate must be greater than or equal to the default.
+The number of vCPUs to assign must be greater than or equal to the default.
 
 * To increase the memory available to the virtual machine:
 +
@@ -44,9 +44,9 @@ $ {bin} config set memory _<number-in-mib>_
 +
 [NOTE]
 ====
-Values for available memory must be supplied in mebibytes (MiB).
+Values for available memory are set in mebibytes (MiB).
 One gibibyte (GiB) of memory is equal to 1024 MiB.
 ====
 +
 The default value for the `memory` property is `8192`.
-The amount of memory to allocate must be greater than or equal to the default.
+The amount of memory to assign must be greater than or equal to the default.
diff --git a/docs/source/getting_started/content/proc_getting-shell-access-to-the-openshift-cluster.adoc b/docs/source/getting_started/content/proc_getting-shell-access-to-the-openshift-cluster.adoc
@@ -2,16 +2,17 @@
 = Getting shell access to the OpenShift cluster
 
 Direct access to the OpenShift cluster is not needed for regular use and is strongly discouraged.
-If direct access to the cluster is needed for troubleshooting or debugging purposes, follow this procedure.
+To access the cluster for troubleshooting or debugging purposes, follow this procedure.
 
 .Prerequisites
 
-* [command]`oc` access to the cluster is enabled and you are logged in as the `kubeadmin` user.
+* Enable [command]`oc` access to the cluster and log in as the `kubeadmin` user.
 For detailed steps, see <<accessing-the-openshift-cluster-with-oc_{context}>>.
 
 .Procedure
 
-. Run [command]`oc get nodes`. The output will be similar to this:
+. Run [command]`oc get nodes`.
+The output will be similar to this:
 +
 [subs="+quotes,attributes",options="nowrap"]
 ----
@@ -20,4 +21,4 @@ NAME                 STATUS   ROLES           AGE    VERSION
 crc-shdl4-master-0   Ready    master,worker   7d7h   v1.14.6+7e13ab9a7
 ----
 
-. Run [command]`oc debug nodes/_<node>_` where `_<node>_` is the name of the node which was printed in the previous step.
+. Run [command]`oc debug nodes/_<node>_` where `_<node>_` is the name of the node printed in the previous step.
diff --git a/docs/source/getting_started/content/proc_setting-up-codeready-containers.adoc b/docs/source/getting_started/content/proc_setting-up-codeready-containers.adoc
@@ -7,13 +7,13 @@ This procedure will create the [filename]`~/.crc` directory if it does not alrea
 
 .Prerequisites
 
-* Your user account must have permission to use the [command]`sudo` command.
+* Your user account has permission to use the [command]`sudo` command.
 
 [NOTE]
 ====
-* The `{bin}` binary should not be run as `root` (or Administrator).
-The `{bin}` binary should always be run with your user account.
-* If you are setting up a new version, capture any changes made to the instance before setting up a new {prod} release.
+* Do not run the [command]`{bin}` binary as `root` (or Administrator).
+Always run the [command]`{bin}` binary with your user account.
+* If you are setting up a new version, capture any changes made to the virtual machine before setting up a new {prod} release.
 ====
 
 .Procedure
diff --git a/docs/source/getting_started/content/proc_starting-codeready-containers-behind-proxy.adoc b/docs/source/getting_started/content/proc_starting-codeready-containers-behind-proxy.adoc
@@ -5,7 +5,7 @@
 
 * To use an existing [command]`oc` binary on your host machine, export the `.testing` domain as part of the `no_proxy` environment variable.
 
-* No manual settings are required to use the embedded [command]`oc` binary.
+* The embedded [command]`oc` binary does not require manual settings.
 For more information on using the embedded [command]`oc` binary, see <<accessing-the-openshift-cluster-with-oc_{context}>>.
 
 
diff --git a/docs/source/getting_started/content/proc_starting-monitoring-alerting-telemetry.adoc b/docs/source/getting_started/content/proc_starting-monitoring-alerting-telemetry.adoc
@@ -1,8 +1,9 @@
 [id="starting-monitoring-alerting-telemetry_{context}"]
 = Starting Monitoring, Alerting, and Telemetry
 
-In order to make sure {prod} can run on a typical laptop, some resource–heavy services get disabled by default.
-One of these is Prometheus and all the related monitoring, alerting, and telemetry functionality, with the latter being responsible for your cluster being listed in the link:https://cloud.redhat.com/openshift[Red Hat OpenShift Cluster Manager].
+To make sure {prod} can run on a typical laptop, some resource-heavy services get disabled by default.
+One of these is Prometheus and the related monitoring, alerting, and telemetry functionality.
+Telemetry functionality is responsible for listing your cluster in the link:https://cloud.redhat.com/openshift[Red Hat OpenShift Cluster Manager].
 
 .Prerequisites
 
diff --git a/docs/source/getting_started/content/proc_starting-the-virtual-machine.adoc b/docs/source/getting_started/content/proc_starting-the-virtual-machine.adoc
@@ -5,21 +5,19 @@ The [command]`{bin} start` command starts the {prod} virtual machine and OpenShi
 
 .Prerequisites
 
-* The host machine has been set up using the [command]`{bin} setup` command.
+* You set up the host machine via the [command]`{bin} setup` command.
 For more information, see <<setting-up-codeready-containers_{context}>>.
-* A valid OpenShift user pull secret.
-The pull secret can be copied or downloaded 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.
+* You have a valid OpenShift user pull secret.
+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.
 +
 [NOTE]
 ====
-A Red Hat account is required in order to access the user pull secret.
+Accessing the user pull secret requires a Red Hat account.
 ====
 
 .Procedure
 
 * Start the {prod} virtual machine:
-
-** For native hypervisors:
 +
 [subs="+quotes,attributes"]
 ----
@@ -30,6 +28,6 @@ $ {bin} start
 
 [NOTE]
 ====
-* The cluster takes a minimum of four minutes to start the necessary containers and operators before serving a request.
-* If errors are encountered during [command]`{bin} start`, check the <<troubleshooting-codeready-containers_{context}>> section for potential solutions.
+* The cluster takes a minimum of four minutes to start the necessary containers and Operators before serving a request.
+* If you see errors during [command]`{bin} start`, check the <<troubleshooting-codeready-containers_{context}>> section for potential solutions.
 ====
diff --git a/docs/source/getting_started/content/proc_troubleshooting-bundle-version-mismatch.adoc b/docs/source/getting_started/content/proc_troubleshooting-bundle-version-mismatch.adoc
@@ -1,8 +1,9 @@
 [id="troubleshooting-bundle-version-mismatch_{context}"]
 = Troubleshooting bundle version mismatch
 
-{prod} instances are created with bundle information and instance data.
-When a new {prod} release is set up, the bundle information and instance data is not updated due to customization in the previous instance data.
+Created {prod} virtual machines contain bundle information and instance data.
+Bundle information and instance data is not updated when setting up a new {prod} release.
+This information is not updated due to customization in the earlier instance data.
 This will lead to errors when running the [command]`{bin} start` command:
 
 [subs="+quotes,attributes"]
diff --git a/docs/source/getting_started/content/proc_troubleshooting-expired-certificates.adoc b/docs/source/getting_started/content/proc_troubleshooting-expired-certificates.adoc
@@ -1,18 +1,19 @@
 [id="troubleshooting-expired-certificates_{context}"]
 = Troubleshooting expired certificates
 
-Prior to {rh-prod} 1.2.0, the system bundle included in each released `{bin}` binary expired 30 days after the release due to certificates embedded in the OpenShift cluster.
-Using an older `{bin}` binary or system bundle will result in an expired certificates error.
+Before {rh-prod} 1.2.0, the system bundle in each released [command]`{bin}` binary expired 30 days after the release.
+This expiration was due to certificates embedded in the OpenShift cluster.
+As a result, using an older [command]`{bin}` binary or system bundle results in an expired certificates error.
 
-Starting from {prod} 1.2.0, the embedded certificates can be automatically renewed by `{bin}`.
-The certificate renewal process is triggered when needed when [command]`{bin} start` is run.
-When certificates need to be renewed, this can add up to five minutes to the start time of the cluster.
+Starting from {prod} 1.2.0, the embedded certificates can be automatically renewed by [command]`{bin}`.
+The [command]`{bin} start` command triggers the certificate renewal process when needed.
+Certificate renewal can add up to five minutes to the start time of the cluster.
 
 .Procedure
 
 With {prod} releases older than 1.2.0, to resolve expired certificate errors:
 
-. link:{crc-download-url}[Download the latest {prod} release] and place the `{bin}` binary in your `$PATH`.
+. link:{crc-download-url}[Download the latest {prod} release] and place the [command]`{bin}` binary in your `$PATH`.
 
 . Remove the cluster with certificate errors using the [command]`{bin} delete` command:
 +
@@ -25,7 +26,7 @@ include::snip_crc-delete.adoc[]
 $ {bin} setup
 ----
 
-. Start the new cluster:
+. Start the new virtual machine:
 +
 [subs="+quotes,attributes"]
 ----
diff --git a/docs/source/getting_started/content/proc_upgrading-codeready-containers.adoc b/docs/source/getting_started/content/proc_upgrading-codeready-containers.adoc
diff --git a/docs/source/getting_started/content/ref_dns-configuration.adoc b/docs/source/getting_started/content/ref_dns-configuration.adoc
diff --git a/docs/source/getting_started/content/ref_minimum-system-requirements.adoc b/docs/source/getting_started/content/ref_minimum-system-requirements.adoc
diff --git a/docs/source/getting_started/content/ref_required-software-packages.adoc b/docs/source/getting_started/content/ref_required-software-packages.adoc
