Fix RST formatting and style guide compliance (#255)

* Fix RST formatting and style guide compliance

Signed-off-by: Andrew Chen <[email protected]>

* fix install-nfd.rst

Signed-off-by: Andrew Chen <[email protected]>

* fix mig-ocp.rst

Signed-off-by: Andrew Chen <[email protected]>

* fix nvaie-with-ocp.rst

Signed-off-by: Andrew Chen <[email protected]>

* fix mirror-gpu-ocp-disconnected.rst

Signed-off-by: Andrew Chen <[email protected]>

* fix more indentation syntax issues

Signed-off-by: Andrew Chen <[email protected]>

* more indentation fixes + pre-requisites -> prerequisites

Signed-off-by: Andrew Chen <[email protected]>

* more changes to match style guide

Signed-off-by: Andrew Chen <[email protected]>

* more indentation fixes

Signed-off-by: Andrew Chen <[email protected]>

* revert gpu-operator-kubevirt.rst

Signed-off-by: Andrew Chen <[email protected]>

---------

Signed-off-by: Andrew Chen <[email protected]>

Author: chenopis

edge/anthos-guide.rst

@@ -102,7 +102,7 @@ The basic steps described in this document follows this workflow:
 
 #. Configure nodes
 
-   * Ensure each node (including the control plane) meets the pre-requisites, including time synchronization, correct versions of Docker and other conditions.
+   * Ensure each node (including the control plane) meets the prerequisites, including time synchronization, correct versions of Docker and other conditions.
 
 #. Configure networking (Optional)
 

kubernetes/index.rst

@@ -23,7 +23,7 @@ This document provides an overview of the necessary software to enable MIG suppo
 Refer to the `MIG User Guide <https://docs.nvidia.com/datacenter/tesla/mig-user-guide/index.html>`__ for more details on the technical concepts,
 setting up MIG and the NVIDIA Container Toolkit for running containers with MIG.
 
-The deployment workflow requires these pre-requisites:
+The deployment workflow requires these prerequisites:
 
 #. You have installed the NVIDIA R450+ datacenter (450.80.02+) drivers required for NVIDIA A100.
 #. You have installed the NVIDIA Container Toolkit v2.5.0+

mig/mig-k8s.rst

@@ -13,7 +13,7 @@ This document provides steps on getting started and running some example CUDA wo
 on MIG-enabled GPUs in a Kubernetes cluster.
 
 ************************
-Software Pre-requisites
+Software Prerequisites
 ************************
 
 The deployment workflow requires these prerequisites. Once these prerequisites have been met, 

openshift/appendix-ocp.rst

@@ -23,14 +23,14 @@ Introduction
 
    If you encounter the :ref:`"broken driver toolkit detected" <broken-dtk>` warning on OpenShift 4.10 or later, you should :ref:`troubleshoot <broken-dtk-troubleshooting>` to find the root cause instead of falling back to entitled driver builds.
 
-   If the broken DTK warning is encountered on an older version of OpenShift, refer to the documentation for an older version of the NVIDIA GPU operator to enable entitled builds. Keep in mind that older versions of OpenShift might no longer be supported.
+   If the broken DTK warning is encountered on an older version of OpenShift, refer to the documentation for an older version of the NVIDIA GPU Operator to enable entitled builds. Keep in mind that older versions of OpenShift might no longer be supported.
 
 .. _broken-dtk-troubleshooting:
 
 Troubleshooting Broken Driver Toolkit Errors
 --------------------------------------------
 
-The most likely reason for the broken DTK message is Node Feature Discovery (NFD) not working correctly. NFD might be disabled, failing, or not updating the kernel version label for other reasons. Another cause might be a missing or incomplete DTK image stream, e.g. because of broken mirroring.
+The most likely reason for the broken DTK message is Node Feature Discovery (NFD) not working correctly. NFD might be disabled, failing, or not updating the kernel version label for other reasons. Another cause might be a missing or incomplete DTK image stream, for example, because of broken mirroring.
 
 Follow these steps for initial troubleshooting of Node Feature Discovery:
 
@@ -48,15 +48,15 @@ Follow these steps for initial troubleshooting of Node Feature Discovery:
 
       $ oc get nodes -o jsonpath='{range .items[*]}{.metadata.name}{":\t"}{.metadata.labels.feature\.node\.kubernetes\.io/kernel-version\.full}{"\n"}{end}'
 
-   Ensure nodes have proper kernel version labels that match current OpenShift version of the cluster.
+   Ensure nodes have proper kernel version labels that match the current OpenShift version of the cluster.
 
 #. **Check Driver Toolkit image stream:**
 
    .. code-block:: console
 
       $ oc get -n openshift is/driver-toolkit
 
-   Verify the driver-toolkit image stream exists and has the correct tags that correspond to current OpenShift version.
+   Verify the driver-toolkit image stream exists and has the correct tags that correspond to the current OpenShift version.
 
 For additional troubleshooting resources:
 

openshift/clean-up.rst

@@ -6,11 +6,11 @@
 *****************************************
 Cleanup
 *****************************************
-This section describes how to clean up (remove) the GPU Operator in case it is no longer needed.
+This section describes how to clean up (remove) the GPU Operator if it is no longer needed.
 
 #. Delete the NVIDIA GPU Operator from the cluster following the guidance outlined in `Deleting Operators from a cluster <https://docs.openshift.com/container-platform/latest/operators/admin/olm-deleting-operators-from-cluster.html>`_.
 
-#. Delete the cluster policy using the OpenShift Container Platform CLI:
+#. Delete the cluster policy by using the OpenShift Container Platform CLI.
 
    .. code-block:: console
 

openshift/enable-gpu-monitoring-dashboard.rst

@@ -83,9 +83,9 @@ The following table provides a brief description of the graphs on the default da
 +--------------------------+------------------------------------------------------------+
 | Graph                    | Description                                                |
 +==========================+============================================================+
-| GPU Temperature          | GPU temperature in C.                                      |
+| GPU Temperature          | GPU temperature in Celsius.                                |
 +--------------------------+------------------------------------------------------------+
-| GPU Avg. Temp            | Average GPU temperature in C.                              |
+| GPU Avg. Temp            | Average GPU temperature in Celsius.                        |
 +--------------------------+------------------------------------------------------------+
 | GPU Power Usage          | Power usage in watts for each GPU.                         |
 +--------------------------+------------------------------------------------------------+

openshift/get-entitlement.rst

@@ -11,4 +11,4 @@ Entitled Driver Builds No Longer Supported
 
    **Entitled NVIDIA driver builds are deprecated and not supported.**
 
-   If you encounter issues with the NVIDIA GPU driver build that might require entitlement, please refer to the Driver Toolkit (DTK) troubleshooting section: :ref:`broken-dtk-troubleshooting`
+   If you encounter issues with the NVIDIA GPU driver build that might require entitlement, refer to the Driver Toolkit (DTK) troubleshooting section: :ref:`broken-dtk-troubleshooting`.