TECHPUBS-4588: Spell and style check fixes (#99)

* TECHPUBS-4588: minor fixes, spellcheck, and md linting

* TECHPUBS-4588: fixed review comments

Author: nrockershousen

.github/config/markdown_style.yaml

@@ -56,11 +56,11 @@ MD006: true
 # MD007/ul-indent - Unordered list indentation
 MD007:
   # Spaces for indent
-  indent: 4
+  indent: 2
   # Whether to indent the first level of the list
   start_indented: false
   # Spaces for first level indent (when start_indented is set)
-  start_indent: 4
+  start_indent: 2
 
 # MD009/no-trailing-spaces - Trailing spaces
 MD009:

.spelling

@@ -6,6 +6,12 @@
 #
 # General
 #
+0x82
+0x83
+0x84
+0x85
+0x86
+0x87
 1G
 100Gbps
 1-port
@@ -15,6 +21,7 @@
 200Gbps
 2-port
 802.1Q
+adminStatus
 AMA
 AMAs
 amdgpu
@@ -46,6 +53,7 @@ Basesystem
 BER
 BERs
 behavior
+behaviors
 benchmarking
 bisectional
 Bond0
@@ -75,6 +83,7 @@ COS Base
 CN
 CNs
 CPE
+CPTs
 Cray
 cray
 cray-diags-fabric
@@ -118,7 +127,13 @@ debugfs
 default.yml
 defragmented
 dgnettest
+diags
 diskless
+disk-ful
+DIS_HOST
+DIS_ETH
+DIS_SMB
+DIS_USB
 DITA-OT
 ditamap
 ditamaps
@@ -166,6 +181,7 @@ FM
 FMN
 GbE
 Gbps
+Gen4
 gc_thresh
 Git
 Gitea
@@ -183,6 +199,7 @@ heatsink
 highpriority
 hodagd
 honor
+honoring
 hostname
 hostnames
 HPCM
@@ -215,6 +232,7 @@ IPs
 IPv4
 ISO
 ISOs
+journald
 JSON
 jwt
 JWT
@@ -252,6 +270,11 @@ LNM
 Loadbalance
 loadbalance
 localtime
+LOG_DEBUG
+LogLevelMax
+LOG_NOTICE
+LOG_INFO
+LOG_WARN
 Loopback
 loopback
 low-noise-mode
@@ -288,6 +311,7 @@ munged*
 multisocket
 n00
 n01
+NACKs
 nameserver
 NAPI
 ncn-personalization
@@ -315,6 +339,8 @@ ncn-w004
 Neighbor
 neighbor
 neighbors
+neighboring
+Netlink
 nfsserv
 NID
 NIDs
@@ -327,6 +353,8 @@ node-identity
 nodename
 non-CFS
 non-VLAN
+nonprivileged
+Nonprivileged
 nodelist
 NUMA
 Nvidia
@@ -348,6 +376,7 @@ pdsh
 Perftest
 perftest
 perf
+PEs
 pfc_fifo_oflw
 PKTBUF_ERROR
 playbook
@@ -375,6 +404,8 @@ Redfish
 RedHat
 release-rpms
 repo
+requeue
+Requeue
 RHEL-based
 RoCE
 roce_perf_check_loopback
@@ -396,17 +427,21 @@ rxe
 rxe0
 rxe1
 rxtx
+SBL_ASYNC_ALERT_LINK_DOWN
 SBL_ASYNC_ALERT_SERDES_FW_CORRUPTION
+SCTs
 SD-DAEMON
-SD_NOTICE
-SD_INFO
-SD_DEBUG
+_SD-DAEMON_
+_SD_NOTICE_
+_SD_INFO_
+_SD_DEBUG_
 SDK
 sdk
 SEL
 SELinux
 SerDes
 serdes
+SEQUENCE_ERROR
 shadow
 SharePoint
 SHS
@@ -422,14 +457,18 @@ SLE
 SLES
 SLE15_sp4
 SLE15-SP4
+SLES15-SP4
 socklnd
 Soft-RoCE
 Standalone
 standalone
 StatsFS
+SPTs
 subcommand
 subcommands
+substep
 subrole
+SU-leader
 superblock
 Supercomputing
 SuSE
@@ -439,9 +478,11 @@ sysctl
 syslog
 systemctl
 systemd
+Taskset
 tcp
 tcp1
 tcs
+TCTs
 TEMPLATE_NAME
 tmpfs
 TLV
@@ -458,6 +499,7 @@ UANs
 uC
 UDEV
 udev
+uint128
 uncomment
 untagged_eth_pcp
 untar
@@ -479,7 +521,11 @@ wildcard
 wildcards
 WLM
 WLMs
+WP_NIC0
+WP_NIC1
 writable
+x100x
+x16
 x86
 x86_64
 xname

docs/portal/developer-portal/HPE_Slingshot_Host_Software_Troubleshooting_Guide.ditamap

@@ -67,7 +67,7 @@
         <topicref href="troubleshoot/compute/troubleshoot_bond0_not_up.md" format="mdita"/>
     </topicref>
     <topicref href="troubleshoot/cassini/HPE_Slingshot_200Gbps_NIC.md" format="mdita">
-        <topicref href="troubleshoot/cassini/HPE_Slingshot_200Gpbs_NIC_troubleshooting.md"
+        <topicref href="troubleshoot/cassini/HPE_Slingshot_200Gbps_NIC_troubleshooting.md"
             format="mdita">
             <topicref
                 href="troubleshoot/cassini/check_and_fix_misconfigured_nonvlan_tagged_ethernet_pcp_settings.md"

docs/portal/developer-portal/install/Soft_RoCE_on_HPE_Slingshot_200Gbps_NICs.md

@@ -1,4 +1,4 @@
-# Soft-RoCE on HPE Slingshot 200Gpbs NICs
+# Soft-RoCE on HPE Slingshot 200Gbps NICs
 
 Remote direct memory access (RDMA) over Converged Ethernet (RoCE) is a network protocol that enables RDMA over an Ethernet network.
 RoCE can be implemented both in the hardware and in the software. Soft-RoCE is the software implementation of the RDMA transport.

docs/portal/developer-portal/install/cxi_core_driver.md

@@ -7,7 +7,7 @@ GPU Direct RDMA allows a PCIe device (the HPE Slingshot 200GbE NIC in this case)
 ## Vendors supported
 
 - AMD - ROCm library, amdgpu driver
-- Nvidia - Cuda library, nvidia driver
+- NVIDIA - Cuda library, NVIDIA driver
 - Intel - Level Zero library, dmabuf kernel interface
 
 ## Special considerations
@@ -16,7 +16,7 @@ ___NVIDIA driver___
 
 The NVIDIA driver contains a feature called Persistent Memory. It does not release pinned pages when device memory is freed unless explicitly directed by the NIC driver or upon job completion.
 
-A cxi-ss1 parameter `nv_p2p_persistent` is used to enable Persistent Memory. The default is enabled.
+A `cxi-ss1` parameter `nv_p2p_persistent` is used to enable Persistent Memory. The default is enabled.
 
 The `nv_p2p_persistent` parameter can be disabled by setting it to 0 in the `modprobe cxi-ss1` command.
 

docs/portal/developer-portal/install/install_or_upgrade_compute_nodes.md

@@ -1,6 +1,6 @@
 # Install compute nodes
 
-Perform this procedure to install SHS on compute nodes. This procedure can be used for systems that use either Mellanox NICs or HPE Slingshot 200Gpbs NICs.
+Perform this procedure to install SHS on compute nodes. This procedure can be used for systems that use either Mellanox NICs or HPE Slingshot 200Gbps NICs.
 
 The installation method will depend on what type of NIC is installed on the system.
 Select one of the following procedures depending on the NIC in use:
@@ -39,7 +39,7 @@ NOTE: The upgrade process is nearly identical to the installation, and the proce
 
    a. The RPMs should be copied or moved to a location accessible to one or more hosts where the RPMs will be installed. This can be a network file share, a physically backed location such as a disk drive on the host, or a remotely accessible location such as a web server that hosts the RPMs.
 
-   b. The host or host OS image should be modified to add a repository for the newly downloaded RPMs for the package manager used in the OS distribution. Select the RPMs from the distribution file for your environment (slingshot_compute_cos-2.4... for COS 2.4, slingshot_compute_sle15_sp4 for SLE15_sp4, and so on)
+   b. The host or host OS image should be modified to add a repository for the newly downloaded RPMs for the package manager used in the OS distribution. Select the RPMs from the distribution file for your environment (`slingshot_compute_cos-2.4...` for COS 2.4, `slingshot_compute_sle15_sp4` for SLE15_sp4, and so on)
    For SLE 15, `zypper` is used as the package manager for the host. A Zypper repository should be added which provides the path to the RPMs are hosted. An example for this could be the following:
 
    Assume that the RPMs were downloaded and added to a web server that is external to the host,

docs/portal/developer-portal/install/softroce_on_HPE_Slingshot_200Gbps.md

@@ -1,4 +1,4 @@
-# Configure Soft-RoCE on HPE Slingshot 200Gpbs NICs
+# Configure Soft-RoCE on HPE Slingshot 200Gbps NICs
 
 ## Prerequisites
 

docs/portal/developer-portal/operations/Cassini_Retry_Handler_cxi_rh.md

@@ -13,4 +13,4 @@ The retry handler identifies these scenarios as "Timeouts" or "NACKs" respective
 - **NACKs**: Indicates that the target NIC observed some issue with a packet it received.
   A lack of space to land the packet could result in various NACKs being sent back to the source (depending on which resource was lacking).
   The most common NACK that is typically seen is a SEQUENCE_ERROR NACK. This simply indicates that a packet with an incorrect sequence number arrived. This is not an unusual situation.
-  A prior packet being lost (say sequence number X) will lead to subsequent packets (all with sequence numbers greater than X) getting a SEQUENCE_ERROR NACK in response.
+  A prior packet being lost (say sequence number X) will lead to subsequent packets (all with sequence numbers greater than X) getting a SEQUENCE_ERROR NACK in response.

docs/portal/developer-portal/operations/cassini_retry_handler_logging.md

@@ -13,7 +13,7 @@ journalctl -u cxi_rh@cxi0
 
 ## Log levels
 
-As of SHS 11.1, the RH primarily uses four log Levels. Some messages have been moved to different levels as compared to previous releases.
+As of the SHS 11.1 release, the RH primarily uses four log Levels. Some messages have been moved to different levels as compared to previous releases.
 
 - **LOG_WARN**: Cancellation Related Messages, Config Messages, Connection Level Messages (SCTs, TCTs), Retrying a Connection.
 - **LOG_NOTICE**: SPT Timeouts, Retry Completes for Timed out Packets.

docs/portal/developer-portal/operations/compute_node_configuration.md

@@ -26,7 +26,7 @@ The `sat bootprep` input file should contain sections similar to the following t
 For the examples below,
 
 - Replace `<version>` with the version of SHS desired
-- Replace `<playbook>` with the SHS ansible playbook that should be used
+- Replace `<playbook>` with the SHS Ansible playbook that should be used
 - Replace `ims_require_dkms: true` with `ims_require_dkms: false` if pre-built kernel binaries should be used instead of DKMS kernel packages. NOTE: This setting only exists with CSM 1.5 and later deployments.
 
 **Note:** `shs_mellanox_install.yml` should be used if the Mellanox NIC is installed. `shs_cassini_install.yml` should be used if the HPE Slingshot 200Gbps NIC is installed.

docs/portal/developer-portal/operations/configure_qos_shs.md

@@ -1,6 +1,6 @@
 # Configure QoS for Slingshot Host Software (SHS)
 
-The cxi-driver includes multiple QoS profiles for SHS. This includes PCP to DSCP mappings and other settings that must match the Rosetta side configs, as well as which internal HPE Slingshot 200Gbps NIC resources are made available to each traffic class in a profile.
+The cxi-driver includes multiple QoS profiles for SHS. This includes PCP to DSCP mappings and other settings that must match the Rosetta side configurations, as well as which internal HPE Slingshot 200Gbps NIC resources are made available to each traffic class in a profile.
 
 An admin will be able to choose from one of the profiles that is made available. See the following subsections for guidance on viewing and selecting QoS profiles on the host.
 
@@ -10,7 +10,7 @@ For general information on QoS outside the context of SHS, see "Configure Qualit
 
 QoS profile names on the host match those on the switch. On the host there will be an integer value associated with each QoS Profile. This value is used to select the QoS Profile that the driver should load.
 
-Starting in the Slingshot 2.2 release, the following profiles will be supported on the host:
+Starting in the HPE Slingshot 2.2 release, the following profiles will be supported on the host:
 
 - 1 - HPC
 - 2 - LL_BE_BD_ET
@@ -34,7 +34,7 @@ parm:           active_qos_profile:QoS Profile to load. Must match fabric QoS Pr
 
 ## Select QoS profile on the host
 
-The `active_qos_profile` module parameter to the cxi-ss1 driver allows admins to choose a QoS profile. As with any module parameter, there are multiple ways for an admin to apply the change, such as the following:
+The `active_qos_profile` module parameter to the `cxi-ss1` driver allows admins to choose a QoS profile. As with any module parameter, there are multiple ways for an admin to apply the change, such as the following:
 
 - Directly via `insmod`/`modprobe`
 - Kernel Command Line
@@ -49,7 +49,7 @@ For example, to load the LL_BE_BD_ET profile via `modprobe`:
 Important notes:
 
 - All nodes _must_ use the same QoS Profile on a particular fabric. See "Configure Quality of Service (QoS)" in the _HPE Slingshot Installation Guide_ for the environment in use.
-- QoS Profile change cannot be done "live", as the cxi-ss1 driver must be reloaded. To change profiles, reboot nodes with the desired QoS profile specified.
+- QoS Profile change cannot be done "live", as the `cxi-ss1` driver must be reloaded. To change profiles, reboot nodes with the desired QoS profile specified.
 
 ## Query QoS information on the host
 
@@ -100,7 +100,7 @@ The following error message on the host can be reported if the 200Gbps NIC and H
 
 **Note:** The above errors, specifically `pfc_fifo_oflw` errors, can also occur if the Fabric Manager is not configured with 200Gbps NIC QoS settings.
 
-The PCP to utilize for non-VLAN tagged Ethernet frames is defined in a QoS profile. The CXI Driver (cxi-ss1) defines a kernel module parameter, `untagged_eth_pcp`, to optionally change this value. The default value of -1 means the value defined in the QoS profile will be used.
+The PCP to utilize for non-VLAN tagged Ethernet frames is defined in a QoS profile. The CXI Driver (`cxi-ss1`) defines a kernel module parameter, `untagged_eth_pcp`, to optionally change this value. The default value of -1 means the value defined in the QoS profile will be used.
 
 The following is an example of how to override the value defined in the profile via modprobe:
 

docs/portal/developer-portal/operations/workflow_decisions.md

@@ -34,7 +34,7 @@ At this point, some workflow decisions must be made. These decisions depend on r
     ncn-m001# OLD_IMPORT_BRANCH_REF=refs/remotes/origin/cray/slingshot-host-software/${OLD_RELEASE}
     ```
 
-  - Else if there are no `integration-*` branches, but there is an integration branch with no `-<RELEASE>` suffix, determine what the release integration was based on by running the `git log` command.This finds the newest commit in the output (the commit closest to the top), which contains a message similar to "Import of 'slingshot-host-software' product version `<OLD-RELEASE>`".
+  - Else if there are no `integration-*` branches, but there is an integration branch with no `-<RELEASE>` suffix, determine what the release integration was based on by running the `git log` command. This finds the newest commit in the output (the commit closest to the top), which contains a message similar to "Import of 'slingshot-host-software' product version `<OLD-RELEASE>`".
 
     ```screen
     ncn-m001# git log --topo-order refs/remotes/origin/integration | less
@@ -110,11 +110,11 @@ Failure to define any of the three variables above may result in install, upgrad
 
 If group variable files are used, then a file must be defined for each target node type. Three groups of nodes are supported:
 
-| Node Type          | Product | Target Kernel Distribution                      | Group Variable File Name      |
-| ------------------ | ------- | ----------------------------------------------- | ----------------------------- |
-| Compute            | COS     | COS (see COS installation for target OS kernel) | Compute/default.yml           |
-| User Access/Login  | UAN     | COS (see COS installation for target OS kernel) | Application/default.yml       |
-| Non-compute Worker | CSM     | CSM (see CSM installation for target OS kernel) | Management_Worker/default.yml |
+| Node Type          | Product | Target Kernel Distribution                      | Group Variable File Name        |
+|--------------------|---------|-------------------------------------------------|---------------------------------|
+| Compute            | COS     | COS (see COS installation for target OS kernel) | `Compute/default.yml`           |
+| User Access/Login  | UAN     | COS (see COS installation for target OS kernel) | `Application/default.yml`       |
+| Non-compute Worker | CSM     | CSM (see CSM installation for target OS kernel) | `Management_Worker/default.yml` |
 
 An example configuration for a Compute node (`ansible/group_vars/Compute/default.yml`) on HPE Cray EX System Software 1.5 using COS 2.4 and CSM 1.3 might be the following:
 

docs/portal/developer-portal/troubleshoot/cassini/HPE_Slingshot_200Gbps_NIC_troubleshooting.md

@@ -0,0 +1 @@
+# HPE Slingshot 200Gbps NIC troubleshooting

docs/portal/developer-portal/troubleshoot/cassini/HPE_Slingshot_200Gpbs_NIC_troubleshooting.md

@@ -34,9 +34,9 @@ The availability of a CXI interface indicates several key signs of health. An in
 - The interface retry handler is running
 - A matching L2 interface is available
 - The L1 interface has a temporary, locally administered, unicast address assigned to it. This is presumed to be an AMA applied by the fabric manager.
-- The L1 link state is reported if verbosity is enabled. L1 link state reported by `fi_info` will match the state reported by the L2 device through the ip tool.
+- The L1 link state is reported if verbosity is enabled. L1 link state reported by `fi_info` will match the state reported by the L2 device through the `ip` tool.
 
-All these checks together make `fi_inf0` an excellent first tool to use to check the general health of 200Gbps NIC RDMA interfaces.
+All these checks together make `fi_info` an excellent first tool to use to check the general health of 200Gbps NIC RDMA interfaces.
 
 **fi_pingpong:**