Merge pull request #95 from hpe/TPCCMS-638

html has numbered sections and ToC below guide title
HewlettPackard · Nov 13, 2024 · bf511fe · bf511fe
2 parents 273d2a6 + 99f1a3c
commit bf511fe
Show file tree

Hide file tree

Showing 34 changed files with 225 additions and 204 deletions.
diff --git a/docs/portal/developer-portal/HPE_Slingshot_Host_Software_Administration_Guide.ditamap b/docs/portal/developer-portal/HPE_Slingshot_Host_Software_Administration_Guide.ditamap
@@ -9,66 +9,37 @@
     </topicmeta>
     <topicref href="VeRsIoN.md" format="mdita"/>
     <topicref href="overview/overview_admin.md" format="mdita"/>
-    <topichead>
-        <topicmeta>
-            <navtitle>Common operational tasks</navtitle>
-        </topicmeta>
+    <topicref href="install/Common_operational_tasks.md" format="mdita">
         <topicref href="install/generic_hpe_slingshot_configuration.md" format="mdita"/>
         <topicref href="install/host_adapter_naming.md" format="mdita"/>
         <topicref href="install/algorithmic_mac_address_mac_configuration.md" format="mdita"/>
-        <topicref href="install/multiple_network_adapters.md" format="mdita"/> 
+        <topicref href="install/multiple_network_adapters.md" format="mdita"/>
         <topicref href="install/sysctl_configuration_example.md" format="mdita"/>
         <topicref href="install/arp_settings.md" format="mdita"/>
-    </topichead>
-    <topichead>
-        <topicmeta>
-            <navtitle>Firmware management</navtitle>
-        </topicmeta>
+    </topicref>
+    <topicref href="operations/Firmware_management.md" format="mdita">
         <topicref href="operations/update_firmware_hpcm_metal.md" format="mdita"/>
         <topicref href="operations/update_firmware_csm.md" format="mdita"/>
-    </topichead>
-    <topichead>
-        <topicmeta>
-            <navtitle>Quality of Service (QoS)</navtitle>
-        </topicmeta>
-        <topicref href="operations/configure_qos_shs.md" format="mdita"/>
-    </topichead>
-    <topichead>
-        <topicmeta>
-             <navtitle>HSN performance</navtitle>
-        </topicmeta>
-        <topicref href="performance/performance_overview.md" format="mdita"/>
+    </topicref>
+    <topicref href="operations/configure_qos_shs.md" format="mdita"/>
+    <topicref href="performance/HSN_performance.md" format="mdita">
         <topicref href="performance/gpcnet_benchmark.md" format="mdita"/>
         <topicref href="performance/osu_benchmark.md" format="mdita"/>
         <topicref href="performance/openmpi.md" format="mdita"/>
         <topicref href="performance/libfabrics.md" format="mdita"/>
         <topicref href="performance/perftest.md" format="mdita"/>
-        <topichead>
-            <topicmeta>
-                <navtitle>HSN performance benchmark tools</navtitle>
-            </topicmeta>
-            <topicref href="performance/HSN_performance_benchmarking.md" format="mdita"/>
-            </topichead>
+        <topicref href="performance/HSN_performance_benchmarking.md" format="mdita"/>
         <topicref href="performance/ARP.md" format="mdita"/>
         <topicref href="performance/ethtool_node_tuning.md" format="mdita"/>
         <topicref href="performance/AMA.md" format="mdita"/>
         <topicref href="performance/TCP_performance_tuning.md" format="mdita"/>
-    </topichead>
-    <topichead>
-        <topicmeta>
-             <navtitle>Cassini Retry Handler (cxi_rh)</navtitle>
-        </topicmeta>
-        <topicref href="operations/cassini_retry_handler.md" format="mdita"/>
+    </topicref>
+    <topicref href="operations/Cassini_Retry_Handler_cxi_rh.md" format="mdita">
         <topicref href="operations/cassini_retry_handler_configuration.md" format="mdita"/>
         <topicref href="operations/cassini_retry_handler_usage.md" format="mdita"/>
         <topicref href="operations/cassini_retry_handler_logging.md" format="mdita"/>
         <topicref href="operations/cassini_retry_handler_monitoring_and_telemetry.md" format="mdita"/>
         <topicref href="operations/cassini_retry_handler_troubleshooting.md" format="mdita"/>
-    </topichead>
-    <topichead>
-        <topicmeta>
-             <navtitle>kdreg2</navtitle>
-        </topicmeta>
-        <topicref href="operations/kdreg2_configuration.md" format="mdita"/>
-    </topichead>
+    </topicref>
+    <topicref href="operations/kdreg2_configuration.md" format="mdita"/>
 </map>
diff --git a/...developer-portal/HPE_Slingshot_Host_Software_Installation_and_Configuration_Guide.ditamap b/...developer-portal/HPE_Slingshot_Host_Software_Installation_and_Configuration_Guide.ditamap
@@ -9,10 +9,7 @@
         </topicmeta>
     <topicref href="VeRsIoN.md" format="mdita"/>
     <topicref href="overview/overview.md" format="mdita"/>
-    <topichead>
-        <topicmeta>
-            <navtitle>Install SHS for CSM</navtitle>
-        </topicmeta>
+    <topicref href="install/Install_SHS_for_CSM.md" format="mdita">
         <topicref href="install/install_shs_on_csm_14_or_newer.md" format="mdita"/>
         <topicref href="operations/operational_activities_csm.md" format="mdita">
             <topicref href="install/kdreg2_csm.md" format="mdita"/>
@@ -31,40 +28,32 @@
         <topicref href="operations/compute_node_configuration.md" format="mdita"/>
         <topicref href="operations/application_node_configuration.md" format="mdita"/>
         <topicref href="operations/image_building.md" format="mdita"/>
-    </topichead>
-    <topichead>
-        <topicmeta>
-            <navtitle>Install SHS for HPCM</navtitle>
-        </topicmeta>
+    </topicref>
+    <topicref href="install/Install_SHS_for_HPCM.md" format="mdita">
         <topicref href="install/install_or_upgrade_shs_on_hpcm_compute_nodes.md" format="mdita">
-            <topicref href="install/HPE_Slingshot_200Gbps_cxi_nic_system_install_upgrade_procedure.md" format="mdita"/>
-            <topicref href="install/mellanox_based_system_install_upgrade_procedure.md" format="mdita"/>
+            <topicref
+                href="install/HPE_Slingshot_200Gbps_cxi_nic_system_install_upgrade_procedure.md"
+                format="mdita"/>
+            <topicref href="install/mellanox_based_system_install_upgrade_procedure.md"
+                format="mdita"/>
         </topicref>
         <topicref href="install/ama_hpcm.md" format="mdita"/>
-    </topichead>
-    <topichead>
-        <topicmeta>
-            <navtitle>Install SHS for bare metal</navtitle>
-        </topicmeta>
+    </topicref>
+    <topicref href="install/Install_SHS_for_bare_metal.md" format="mdita">
         <topicref href="install/compute_install_prereqs.md" format="mdita"/>
         <topicref href="install/install_or_upgrade_compute_nodes.md" format="mdita">
             <topicref href="install/install_200gbps_nic_host_software.md" format="mdita"/>
-            <topicref href="install/HPE_Slingshot_configuration_with_Mellanox_nics.md" format="mdita"/>
+            <topicref href="install/HPE_Slingshot_configuration_with_Mellanox_nics.md"
+                format="mdita"/>
         </topicref>
-    </topichead>
-    <topichead>
-        <topicmeta>
-            <navtitle>Install kdreg2</navtitle>
-        </topicmeta>
+    </topicref>
+    <topicref href="install/Install_kdreg2.md" format="mdita">
         <topicref href="install/kdreg2_introduction.md" format="mdita"/>
         <topicref href="install/kdreg2_install.md" format="mdita"/>
-    </topichead>
-    <topichead>
-        <topicmeta>
-            <navtitle>Soft-RoCE on HPE Slingshot 200Gbps NICs</navtitle>
-        </topicmeta>
-        <topicref href="install/configure_softroce.md" format="mdita"/>
-        <topicref href="install/softroce_on_HPE_Slingshot_200Gbps.md" format="markdown"/>
-        <topicref href="install/lustre_network_driver_lnd_ko2iblnd_configuration.md" format="mdita"/>
-    </topichead>
+    </topicref>
+    <topicref href="install/Soft_RoCE_on_HPE_Slingshot_200Gbps_NICs.md" format="mdita">
+        <topicref href="install/softroce_on_HPE_Slingshot_200Gbps.md" format="mdita"/>
+        <topicref href="install/lustre_network_driver_lnd_ko2iblnd_configuration.md" format="mdita"
+        />
+    </topicref>
 </map>
diff --git a/docs/portal/developer-portal/HPE_Slingshot_Host_Software_Release_Notes.ditamap b/docs/portal/developer-portal/HPE_Slingshot_Host_Software_Release_Notes.ditamap
@@ -15,17 +15,12 @@
     <topicref href="release_notes/component_map.md" format="markdown"/>
     <topicref href="release_notes/securityissues.md" format="markdown"/>
     <topicref href="release_notes/knownissues.md" format="markdown"/>
-    <topichead>
-      <topicmeta>
-          <navtitle>System Software Requirements for Host Software</navtitle>
-       </topicmeta>
+    <topicref href="release_notes/System_Software_Requirements_for_Host_Software.md" format="mdita">
         <topicref href="release_notes/support_matrix.md" format="markdown"/>
-    </topichead>
+    </topicref>
     <topicref href="release_notes/cassini_firmware.md" format="markdown"/>
-    <topichead>
-      <topicmeta>
-          <navtitle>Appendix A: Validate Slingshot Software/Firmware</navtitle>
-       </topicmeta>
+    <topicref href="release_notes/Appendix_A_Validate_Slingshot_Software_and_Firmware.md"
+        format="mdita">
         <topicref href="release_notes/hash_validation_howto.md" format="markdown"/>
-    </topichead>
+    </topicref>
 </map>
diff --git a/docs/portal/developer-portal/HPE_Slingshot_Host_Software_Troubleshooting_Guide.ditamap b/docs/portal/developer-portal/HPE_Slingshot_Host_Software_Troubleshooting_Guide.ditamap
@@ -13,10 +13,9 @@
         <topicref href="troubleshoot/cxi/cxi_diags_bandwidth.md" format="mdita"/>
         <topicref href="troubleshoot/cxi/cxi_diags_latency.md" format="mdita"/>
         <topicref href="troubleshoot/cxi/cxi_diags_thermal.md" format="mdita"/>
-        <topichead id="cxi-diags-troubleshoot" keys="cxi-diags-troubleshoot">
-            <topicmeta>
-                <navtitle>Troubleshoot CXI Diagnostics and Utilities</navtitle>
-            </topicmeta>
+        <topicref
+            href="troubleshoot/cxi/Troubleshoot_CXI_Diagnostics_and_Utilities_cxi_diags_troubleshoot.md"
+            format="mdita">
             <topicref href="troubleshoot/cxi/Cannot_reach_server.md" format="mdita"/>
             <topicref href="troubleshoot/cxi/No_server_running_at_remote_host.md" format="mdita"/>
             <topicref href="troubleshoot/cxi/TCP_port_already_in_use.md" format="mdita"/>
@@ -30,108 +29,74 @@
             <topicref href="troubleshoot/cxi/sync_timeout.md" format="mdita"/>
             <topicref href="troubleshoot/cxi/semaphore_already_exists.md" format="mdita"/>
             <topicref href="troubleshoot/cxi/failed_to_allocate_LNI.md" format="mdita"/>
-        </topichead>
+        </topicref>
     </topicref>
-    <topichead id="cxi-healthcheck">
-        <topicmeta>
-            <navtitle>CXI HealthCheck</navtitle>
-        </topicmeta>
-        <topicref href="troubleshoot/cxi/CXI_HealthCheck_Overview.md" format="mdita"/>
+    <topicref href="troubleshoot/cxi/CXI_Healthcheck.md" format="mdita">
         <topicref href="troubleshoot/cxi/Common_CXI_core_error_messages.md" format="mdita"/>
-    </topichead>
-    <topichead id="cxi-error-handling-guidance-and-recommendations">
-        <topicmeta>
-            <navtitle>CXI Error Handling Guidance and Recommendations</navtitle>
-        </topicmeta>
-        <topicref href="troubleshoot/cxi/cxi_logged_events.md" format="mdita">
-            <topicref href="troubleshoot/cxi/Kernel_Severity_EMERG_0.md" format="mdita"/>
-            <topicref href="troubleshoot/cxi/Kernel_Severity_ALERT_1.md" format="mdita"/>
-            <topicref href="troubleshoot/cxi/Kernel_Severity_CRIT_2.md" format="mdita"/>
-            <topicref href="troubleshoot/cxi/Kernel_Severity_ERR_3.md" format="mdita"/>
-            <topicref href="troubleshoot/cxi/Kernel_Severity_WARNING_4.md" format="mdita"/>
-            <topicref href="troubleshoot/cxi/Kernel_Severity_NOTICE_5.md" format="mdita"/>
-            <topicref href="troubleshoot/cxi/Kernel_Severity_INFO_6.md" format="mdita"/>
-            <topicref href="troubleshoot/cxi/Kernel_Severity_DEBUG_7.md" format="mdita"/>
-        </topicref>
-    </topichead>
-    <topichead id="network-diagnostics">
-        <topicmeta>
-            <navtitle>Network Diagnostics</navtitle>
-        </topicmeta>
-        <topicref href="troubleshoot/net_diags/net_diags_overview.md" format="mdita"/>
-        <topichead>
-            <topicmeta>
-                <navtitle>dgnettest</navtitle>
-            </topicmeta>
-            <topicref href="troubleshoot/net_diags/net_diags_dgnettest.md" format="mdita"/>
+    </topicref>
+    <topicref href="troubleshoot/cxi/cxi_logged_events.md" format="mdita">
+        <topicref href="troubleshoot/cxi/Kernel_Severity_EMERG_0.md" format="mdita"/>
+        <topicref href="troubleshoot/cxi/Kernel_Severity_ALERT_1.md" format="mdita"/>
+        <topicref href="troubleshoot/cxi/Kernel_Severity_CRIT_2.md" format="mdita"/>
+        <topicref href="troubleshoot/cxi/Kernel_Severity_ERR_3.md" format="mdita"/>
+        <topicref href="troubleshoot/cxi/Kernel_Severity_WARNING_4.md" format="mdita"/>
+        <topicref href="troubleshoot/cxi/Kernel_Severity_NOTICE_5.md" format="mdita"/>
+        <topicref href="troubleshoot/cxi/Kernel_Severity_INFO_6.md" format="mdita"/>
+        <topicref href="troubleshoot/cxi/Kernel_Severity_DEBUG_7.md" format="mdita"/>
+    </topicref>
+    <topicref href="troubleshoot/net_diags/Network_Diagnostics.md" format="mdita">
+        <topicref href="troubleshoot/net_diags/net_diags_dgnettest.md" format="mdita">
             <topicref href="troubleshoot/net_diags/dgnettest_run.md" format="mdita"/>
-            <topicref href="troubleshoot/net_diags/troubleshoot_net_diags_dgnettest.md" format="mdita"/>
-        </topichead>
-        <topichead>
-            <topicmeta>
-                <navtitle>cxibwcheck.sh</navtitle>
-            </topicmeta>
-            <topicref href="troubleshoot/net_diags/net_diags_cxibwcheck.md" format="mdita"/>
-            <topicref href="troubleshoot/net_diags/troubleshoot_net_diags_cxibwcheck.md" format="mdita"/>
-        </topichead>
-        <topichead>
-            <topicmeta>
-                <navtitle>bwcheck.sh</navtitle>
-            </topicmeta>
-            <topicref href="troubleshoot/net_diags/net_diags_bwcheck.md" format="mdita"/>
-            <topicref href="troubleshoot/net_diags/troubleshoot_net_diags_bwcheck.md" format="mdita"/>
-        </topichead>
-        <topichead>
-            <topicmeta>
-                <navtitle>cxiberstat.sh</navtitle>
-            </topicmeta>
-        <topicref href="troubleshoot/net_diags/net_diags_cxiberstat.md" format="mdita"/>
-        <topicref href="troubleshoot/net_diags/troubleshoot_net_diags_cxiberstat.md" format="mdita"/>
-        </topichead>
-    </topichead>
-    <topichead id="compute-node-troubleshooting">
-        <topicmeta>
-            <navtitle>Compute node troubleshooting</navtitle>
-        </topicmeta>
-        <topicref href="troubleshoot/compute/troubleshoot_compute.md" format="mdita"/>
+            <topicref href="troubleshoot/net_diags/troubleshoot_net_diags_dgnettest.md"
+                format="mdita"/>
+        </topicref>
+        <topicref href="troubleshoot/net_diags/net_diags_cxibwcheck.md" format="mdita">
+            <topicref href="troubleshoot/net_diags/troubleshoot_net_diags_cxibwcheck.md"
+                format="mdita"/>
+        </topicref>
+        <topicref href="troubleshoot/net_diags/net_diags_bwcheck.md" format="mdita">
+            <topicref href="troubleshoot/net_diags/troubleshoot_net_diags_bwcheck.md" format="mdita"
+            />
+        </topicref>
+        <topicref href="troubleshoot/net_diags/net_diags_cxiberstat.md" format="mdita">
+            <topicref href="troubleshoot/net_diags/troubleshoot_net_diags_cxiberstat.md"
+                format="mdita"/>
+        </topicref>
+    </topicref>
+    <topicref href="troubleshoot/compute/troubleshoot_compute.md" format="mdita">
         <topicref href="troubleshoot/compute/troubleshoot_bond0_not_up.md" format="mdita"/>
-    </topichead>
-    <topichead id="hpe-slingshot-200Gbps-nic">
-        <topicmeta>
-            <navtitle>HPE Slingshot 200Gbps NIC</navtitle>
-        </topicmeta>
-        <topichead id="hpe-slingshot-200Gbps-nic-troubleshooting">
-            <topicmeta>
-                <navtitle>HPE Slingshot 200Gbps NIC troubleshooting</navtitle>
-            </topicmeta>
-            <topicref href="troubleshoot/cassini/check_and_fix_misconfigured_nonvlan_tagged_ethernet_pcp_settings.md" format="mdita"/>
-            <topicref href="troubleshoot/cassini/check_and_fix_lldp_issues_on_the_fabric.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"
+            format="mdita">
+            <topicref
+                href="troubleshoot/cassini/check_and_fix_misconfigured_nonvlan_tagged_ethernet_pcp_settings.md"
+                format="mdita"/>
+            <topicref href="troubleshoot/cassini/check_and_fix_lldp_issues_on_the_fabric.md"
+                format="mdita"/>
             <topicref href="troubleshoot/cassini/lldp_mac_address_issue.md" format="mdita"/>
-        </topichead>
-        <topichead id="hpe-slingshot-200Gbps-nic-host-troubleshooting">
-        <topicmeta>
-            <navtitle>HPE Slingshot 200Gbps NIC Host troubleshooting</navtitle>
-        </topicmeta>
-        <topicref href="troubleshoot/cassini/200gbps_nic_appear_down.md" format="mdita"/>
-        <topicref href="troubleshoot/cassini/retry_handler.md" format="mdita"/>
-        <topicref href="troubleshoot/cassini/200gbps_nic_loopback_mode.md" format="mdita"/>
-        <topicref href="troubleshoot/cassini/ethernet_driven_configuration.md" format="mdita"/>
-        <topicref href="troubleshoot/cassini/200gbps_nic_errors.md" format="mdita"/>
-        <topicref href="troubleshoot/cassini/pcie_interface_troubleshooting.md" format="mdita"/>
-        <topicref href="troubleshoot/cassini/ethernet_interface_troubleshooting.md" format="mdita"/>
+        </topicref>
+        <topicref href="troubleshoot/cassini/HPE_Slingshot_200Gbps_NIC_Host_troubleshooting.md"
+            format="mdita">
+            <topicref href="troubleshoot/cassini/200gbps_nic_appear_down.md" format="mdita"/>
+            <topicref href="troubleshoot/cassini/retry_handler.md" format="mdita"/>
+            <topicref href="troubleshoot/cassini/200gbps_nic_loopback_mode.md" format="mdita"/>
+            <topicref href="troubleshoot/cassini/ethernet_driven_configuration.md" format="mdita"/>
+            <topicref href="troubleshoot/cassini/200gbps_nic_errors.md" format="mdita"/>
+            <topicref href="troubleshoot/cassini/pcie_interface_troubleshooting.md" format="mdita"/>
+            <topicref href="troubleshoot/cassini/ethernet_interface_troubleshooting.md"
+                format="mdita"/>
             <topicref href="troubleshoot/cassini/RDMA_interface_troubleshooting.md" format="mdita"/>
-    </topichead>
-    <topichead id="hpe-slingshot-200Gbps-nic-firmware-troubleshooting">
-        <topicmeta>
-            <navtitle>HPE Slingshot 200Gbps NIC Firmware troubleshooting</navtitle>
-        </topicmeta>
-        <topicref href="troubleshoot/cassini/firmware_update_failure.md" format="mdita"/>
-        <topicref href="troubleshoot/cassini/firmware_factory_reset.md" format="mdita"/>
-    </topichead>
-    <topicref href="troubleshoot/cassini/pause_too_long.md" format="mdita">
-        <topicref href="troubleshoot/cassini/pause_too_long_map_ethernet.md" format="mdita"/>
-        <topicref href="troubleshoot/cassini/pause_too_long_fabric_recovery.md" format="mdita"/>
+        </topicref>
+        <topicref href="troubleshoot/cassini/HPE_Slingshot_200Gbps_NIC_Firmware_troubleshooting.md"
+            format="mdita">
+            <topicref href="troubleshoot/cassini/firmware_update_failure.md" format="mdita"/>
+            <topicref href="troubleshoot/cassini/firmware_factory_reset.md" format="mdita"/>
+        </topicref>
+        <topicref href="troubleshoot/cassini/pause_too_long.md" format="mdita">
+            <topicref href="troubleshoot/cassini/pause_too_long_map_ethernet.md" format="mdita"/>
+            <topicref href="troubleshoot/cassini/pause_too_long_fabric_recovery.md" format="mdita"/>
+        </topicref>
     </topicref>
-    </topichead>
     <topicref href="troubleshoot/cxi/High_rate_puts_and_internal_loopack.md" format="mdita"/>
 </map>
diff --git a/docs/portal/developer-portal/Makefile b/docs/portal/developer-portal/Makefile
@@ -160,6 +160,7 @@ dir: $(TMPDIR)/VeRsIoN.md
 	cp -r $(CSSDIR) $(HTMLBUILDDIR)
 	cp *.ditamap $(TMPDIR)
 	cp *.json $(TMPDIR)
+	cp -r dita_ot_jumbo_html5_files $(TMPDIR)
 	cp -r release_notes $(TMPDIR)
 	cp -r install $(TMPDIR)
 	cp -r troubleshoot $(TMPDIR)