CASMINST-6993: Linting (#5341)

* CASMINST-6993: Linting * Update operations/node_management/Replacing_Foxconn_User_Pass.md Signed-off-by: Mitch Harding <mitchell.harding@hpe.com> --------- Signed-off-by: Mitch Harding <mitchell.harding@hpe.com>
Cray-HPE · Sep 4, 2024 · 8eb0853 · 8eb0853
1 parent 2f961fc
commit 8eb0853
Show file tree

Hide file tree

Showing 21 changed files with 574 additions and 575 deletions.
diff --git a/install/README.md b/install/README.md
@@ -40,39 +40,35 @@ describes how to install additional HPE Cray EX software products using the
 The topics in this chapter need to be done as part of an ordered procedure so are
 shown here with numbered topics.
 
-- [Cray System Management Install](#cray-system-management-install)
-    - [Bifurcated CAN notice](#bifurcated-can-notice)
-    - [High-level overview of CSM install](#high-level-overview-of-csm-install)
-    - [Topics](#topics)
-    - [Pre-installation](#pre-installation)
-        - [1. Preparing for a re-installation](#1-preparing-for-a-re-installation)
-        - [2. Boot installation environment](#2-boot-installation-environment)
-        - [3. Download the CSM tarball](#3-download-the-csm-tarball)
-        - [4. Create system configuration](#4-create-system-configuration)
-        - [5. Import the CSM tarball](#5-import-the-csm-tarball)
-        - [6. Validate the LiveCD](#6-validate-the-livecd)
-        - [7. Configure management network switches](#7-configure-management-network-switches)
-            - [Ensure SNMP is configured on the management network switches](#ensure-snmp-is-configured-on-the-management-network-switches)
-                - [When the management network is already configured](#when-the-management-network-is-already-configured)
-                - [When the management network has not been configured](#when-the-management-network-has-not-been-configured)
-            - [Configure the management network with CANU](#configure-the-management-network-with-canu)
-    - [Installation](#installation)
-        - [1. Deploy management nodes](#1-deploy-management-nodes)
-        - [2. Install CSM services](#2-install-csm-services)
-        - [3. Validate CSM health before final NCN deployment](#3-validate-csm-health-before-final-ncn-deployment)
-        - [4. Deploy final NCN](#4-deploy-final-ncn)
-        - [5. Configure administrative access](#5-configure-administrative-access)
-        - [6. Validate CSM health](#6-validate-csm-health)
-        - [7. Configure Prometheus alert notifications](#7-configure-prometheus-alert-notifications)
-        - [8. Update ceph node-exporter config for SNMP counters](#8-update-ceph-node-exporter-config-for-snmp-counters)
-        - [9. Upload Olympus BMC recovery firmware into TFTP server](#9-upload-olympus-bmc-recovery-firmware-into-tftp-server)
-        - [10. Update firmware with FAS](#10-update-firmware-with-fas)
-        - [11. Prepare compute nodes](#11-prepare-compute-nodes)
-        - [12. Troubleshooting installation problems](#12-troubleshooting-installation-problems)
-    - [Post-Installation](#post-installation)
-        - [1. Kubernetes encryption](#1-kubernetes-encryption)
-        - [2. Export Nexus data](#2-export-nexus-data)
-    - [Installation of additional HPE Cray EX software products](#installation-of-additional-hpe-cray-ex-software-products)
+- [Pre-installation](#pre-installation)
+    1. [Preparing for a re-installation](#1-preparing-for-a-re-installation)
+    1. [Boot installation environment](#2-boot-installation-environment)
+    1. [Download the CSM tarball](#3-download-the-csm-tarball)
+    1. [Create system configuration](#4-create-system-configuration)
+    1. [Import the CSM tarball](#5-import-the-csm-tarball)
+    1. [Validate the LiveCD](#6-validate-the-livecd)
+    1. [Configure management network switches](#7-configure-management-network-switches)
+        - [Ensure SNMP is configured on the management network switches](#ensure-snmp-is-configured-on-the-management-network-switches)
+            - [When the management network is already configured](#when-the-management-network-is-already-configured)
+            - [When the management network has not been configured](#when-the-management-network-has-not-been-configured)
+        - [Configure the management network with CANU](#configure-the-management-network-with-canu)
+- [Installation](#installation)
+    1. [Deploy management nodes](#1-deploy-management-nodes)
+    1. [Install CSM services](#2-install-csm-services)
+    1. [Validate CSM health before final NCN deployment](#3-validate-csm-health-before-final-ncn-deployment)
+    1. [Deploy final NCN](#4-deploy-final-ncn)
+    1. [Configure administrative access](#5-configure-administrative-access)
+    1. [Validate CSM health](#6-validate-csm-health)
+    1. [Configure Prometheus alert notifications](#7-configure-prometheus-alert-notifications)
+    1. [Update ceph node-exporter config for SNMP counters](#8-update-ceph-node-exporter-config-for-snmp-counters)
+    1. [Upload Olympus BMC recovery firmware into TFTP server](#9-upload-olympus-bmc-recovery-firmware-into-tftp-server)
+    1. [Update firmware with FAS](#10-update-firmware-with-fas)
+    1. [Prepare compute nodes](#11-prepare-compute-nodes)
+    1. [Troubleshooting installation problems](#12-troubleshooting-installation-problems)
+- [Post-Installation](#post-installation)
+    1. [Kubernetes encryption](#1-kubernetes-encryption)
+    1. [Export Nexus data](#2-export-nexus-data)
+- [Installation of additional HPE Cray EX software products](#installation-of-additional-hpe-cray-ex-software-products)
 
 > **`NOTE`** If problems are encountered during the installation,
 > [Troubleshooting installation problems](#12-troubleshooting-installation-problems) and

diff --git a/install/configure_administrative_access.md b/install/configure_administrative_access.md
@@ -10,19 +10,17 @@ and BMC/controller passwords.
 
 ## Topics
 
-- [Configure Administrative Access](#configure-administrative-access)
-    - [Topics](#topics)
-    - [1. Configure the Cray and SAT command line interfaces](#1-configure-the-cray-and-sat-command-line-interfaces)
-        - [Automatic configuration using temporary Keycloak account](#automatic-configuration-using-temporary-keycloak-account)
-        - [Manual configuration](#manual-configuration)
-    - [2. Set `Management` role on the BMCs of management nodes](#2-set-management-role-on-the-bmcs-of-management-nodes)
-    - [3. Lock management nodes](#3-lock-management-nodes)
-    - [4. Configure BMC and controller parameters with SCSD](#4-configure-bmc-and-controller-parameters-with-scsd)
-    - [5. Set up passwordless SSH](#5-set-up-passwordless-ssh)
-    - [6. Configure the root password and SSH keys in Vault](#6-configure-the-root-password-and-ssh-keys-in-vault)
-    - [7. Add switch admin password to Vault](#7-add-switch-admin-password-to-vault)
-    - [8. Configure management nodes with CFS](#8-configure-management-nodes-with-cfs)
-    - [9. Proceed to next topic](#9-proceed-to-next-topic)
+1. [Configure the Cray and SAT command line interfaces](#1-configure-the-cray-and-sat-command-line-interfaces)
+    - [Automatic configuration using temporary Keycloak account](#automatic-configuration-using-temporary-keycloak-account)
+    - [Manual configuration](#manual-configuration)
+1. [Set `Management` role on the BMCs of management nodes](#2-set-management-role-on-the-bmcs-of-management-nodes)
+1. [Lock management nodes](#3-lock-management-nodes)
+1. [Configure BMC and controller parameters with SCSD](#4-configure-bmc-and-controller-parameters-with-scsd)
+1. [Set up passwordless SSH](#5-set-up-passwordless-ssh)
+1. [Configure the root password and SSH keys in Vault](#6-configure-the-root-password-and-ssh-keys-in-vault)
+1. [Add switch admin password to Vault](#7-add-switch-admin-password-to-vault)
+1. [Configure management nodes with CFS](#8-configure-management-nodes-with-cfs)
+1. [Proceed to next topic](#9-proceed-to-next-topic)
 
 > **`NOTE`** The procedures in this section of installation documentation are intended to be done in order, even though the topics are
 > administrative or operational procedures. The topics themselves do not have navigational links to the next topic in the sequence.

diff --git a/introduction/deprecated_features/README.md b/introduction/deprecated_features/README.md
@@ -41,7 +41,7 @@ in chronological order.
 
 - [Boot Orchestration Service (BOS)](../../glossary.md#boot-orchestration-service-bos) v1
 - [Cray Advanced Platform Monitoring and Control (CAPMC)](../../glossary.md#cray-advanced-platform-monitoring-and-control-capmc)
-  is deprecated, starting in CSM 1.5, and may be removed in the future.  It has been
+  is deprecated, starting in CSM 1.5, and may be removed in the future. It has been
   replaced with the [Power Control Service (PCS)](../../glossary.md#power-control-service-pcs).
   Everyone is encouraged to transition to PCS as soon as possible.
 - User Access Service