Merge pull request #963 from Dasharo/fix-hw-link

docs/dasharo-tools-suite/overview.md: fix supported hw link
Dasharo · Dec 13, 2024 · 75403b4 · 75403b4
2 parents e7179d9 + 330c04f
commit 75403b4
Show file tree

Hide file tree

Showing 14 changed files with 49 additions and 34 deletions.
diff --git a/docs/common-coreboot-docs/dumping_logs.md b/docs/common-coreboot-docs/dumping_logs.md
@@ -7,12 +7,14 @@ a running system.
 
 ## System information
 
-One may use [Dasharo Tools Suite HCL report](https://docs.dasharo.com/dasharo-tools-suite/documentation#hcl-report)
-or [fwdump-docker image](https://github.com/3mdeb/fwdump-docker) to
-gather all the hardware configuration information from a running system. The
-usage of the tools should result in an archive containing various logs from the
-running system. Submit them via email to [[email protected]](mailto:[email protected])
-or use [Dasharo pastebin](https://paste.dasharo.com/).
+One may use [Dasharo Tools Suite HCL
+report](https://docs.dasharo.com/dasharo-tools-suite/documentation/features/#hcl-report)
+or [fwdump-docker image](https://github.com/3mdeb/fwdump-docker) to gather all
+the hardware configuration information from a running system. The usage of the
+tools should result in an archive containing various logs from the running
+system. Submit them via email to
+[[email protected]](mailto:[email protected]) or use [Dasharo
+pastebin](https://paste.dasharo.com/).
 
 ## `cbmem` utility
 

diff --git a/docs/dasharo-tools-suite/overview.md b/docs/dasharo-tools-suite/overview.md
@@ -17,9 +17,10 @@ the initial deployment, even when no OS is currently installed.
 
 * [Building](documentation/building.md) - describes how to build DTS.
 * [Running](documentation/running.md) - describes how to run DTS.
-* [Supported Hardware](documentation/running.md) - lists which hardware is
-  supported by DTS.
-* [Features](documentation/features.md) - provides more details about DTS features.
+* [Supported Hardware](documentation/supported-hardware.md) - lists which
+  hardware is supported by DTS.
+* [Features](documentation/features.md) - provides more details about DTS
+  features.
 
 ## Reporting issues
 

diff --git a/docs/osf-trivia-list/dasharo.md b/docs/osf-trivia-list/dasharo.md
@@ -268,9 +268,8 @@ process, which reduces user frustration and improves satisfaction.
 Use of DTS largely improves firmware adoption, hardware compatibility reporting
 and binary blobs transmission, as well as recovery.
 
-For more details about zero-touch initial deployment please read relevant
-DTS
-[documentation](https://docs.dasharo.com/dasharo-tools-suite/documentation/#dasharo-zero-touch-initial-deployment).
+For more details about zero-touch initial deployment please read relevant DTS
+[documentation](https://docs.dasharo.com/dasharo-tools-suite/documentation/features/#dasharo-zero-touch-initial-deployment).
 
 ### Dasharo Clean and Simple Code
 

diff --git a/docs/osf-trivia-list/deployment.md b/docs/osf-trivia-list/deployment.md
@@ -197,7 +197,8 @@ tools that can simplify the operation for the user -->
 It is always a good idea to backup the original BIOS of your hardware, before
 switching to open-source firmware.
 
-* Boot [Dasharo Tools Suite](https://docs.dasharo.com/dasharo-tools-suite/documentation#bootable-usb-stick)
+* Boot [Dasharo Tools
+  Suite](https://docs.dasharo.com/dasharo-tools-suite/documentation/running/#bootable-usb-stick)
 * Choose option 9) Shell.
 * Read content of SPI NOR flash:
 

diff --git a/docs/osf-trivia-list/dts.md b/docs/osf-trivia-list/dts.md
@@ -65,7 +65,7 @@ spread the word about it. There are multiple ways to do that:
   spreading the word about Dasharo.
 * [Contribute](../ways-you-can-help-us.md#contribute-through-github)
   documentation, test results, [Dasharo Hardware Compatibility List
-  Reports](https://docs.dasharo.com/dasharo-tools-suite/documentation/#hcl-report)
+  Reports](https://docs.dasharo.com/dasharo-tools-suite/documentation/features/#hcl-report)
 
 To get access to DTS SE you should [contact 3mdeb](mailto:[email protected]) or
 [Dasharo Team](mailto:[email protected]) and prove your contribution

diff --git a/docs/unified-test-documentation/dasharo-compatibility/315-network-boot.md b/docs/unified-test-documentation/dasharo-compatibility/315-network-boot.md
@@ -120,8 +120,8 @@ This test aims to verify that the `Dasharo Tools Suite` option in
 
 1. Proceed with the
     [Test cases common documentation](#test-cases-common-documentation) section.
-1. Proceed with the
-    [Requirements for DTS](https://docs.dasharo.com/dasharo-tools-suite/documentation#running).
+1. Proceed with the [Requirements for
+    DTS](https://docs.dasharo.com/dasharo-tools-suite/documentation/running/).
 
 **Test steps**
 

diff --git a/docs/unified-test-documentation/dasharo-compatibility/326-dasharo-tools-suite.md b/docs/unified-test-documentation/dasharo-compatibility/326-dasharo-tools-suite.md
@@ -8,7 +8,8 @@
     [Generic test setup: firmware](../generic-test-setup.md#firmware).
 1. Wired network connection.
 1. Disable Secure Boot.
-1. Prepare the [bootable USB stick](https://docs.dasharo.com/dasharo-tools-suite/documentation#bootable-usb-stick)
+1. Prepare the [bootable USB
+   stick](https://docs.dasharo.com/dasharo-tools-suite/documentation/running/#bootable-usb-stick)
 1. Make yourself familiar with
     [Dasharo Tools Suite](https://docs.dasharo.com/dasharo-tools-suite/overview).
 
@@ -324,14 +325,15 @@ firmware by using the built-in script in DTS.
 1. Hold the `BOOT_MENU_KEY` to enter the UEFI Boot Menu.
 1. Select the USB stick with DTS using the arrow keys and press `Enter`.
 1. Wait for `Enter an option:`.
-1. Proceed with
-    [Dasharo EC Transition](https://docs.dasharo.com/dasharo-tools-suite/documentation#ec-transition).
+1. Proceed with [Dasharo EC
+    Transition](https://docs.dasharo.com/dasharo-tools-suite/documentation/features/#ec-transition).
 
 **Expected result**
 
 1. After the flashing procedure itself, the DUT should be able to boot.
 1. The EC firmware version, after checking the method described in the
-    above-mentioned [documentation](https://docs.dasharo.com/dasharo-tools-suite/documentation#ec-transition),
+    above-mentioned
+    [documentation](https://docs.dasharo.com/dasharo-tools-suite/documentation/features/#ec-transition),
     should correspond to the latest version.
 
 ## DTS009.001 Update device EC firmware by using DTS works correctly
@@ -358,14 +360,15 @@ firmware by using dasharo_ectool in DTS.
 1. Select the USB stick with DTS using the arrow keys and press `Enter`.
 1. Wait for `Enter an option:`.
 1. Type in `9` and press `Enter`.
-1. Proceed with
-    [Dasharo EC Update](https://docs.dasharo.com/dasharo-tools-suite/documentation#ec-update).
+1. Proceed with [Dasharo EC
+    Update](https://docs.dasharo.com/dasharo-tools-suite/documentation/features/#ec-update).
 
 **Expected result**
 
 1. After the updating firmware procedure itself, the DUT should be able to boot.
 1. The EC firmware version, after checking the method described in the
-    above-mentioned [documentation](https://docs.dasharo.com/dasharo-tools-suite/documentation#ec-update),
+    above-mentioned
+    [documentation](https://docs.dasharo.com/dasharo-tools-suite/documentation/features/#ec-update),
     should correspond to the binary version used.
 
 ## DTS010.001 Test firmware update in pre-release DTS over iPXE

diff --git a/docs/unified/msi/recovery.md b/docs/unified/msi/recovery.md
@@ -205,8 +205,9 @@ number called UUID (Universally Unique IDentifier). UUID is specified by
 provides the system UUID in the SMBIOS system information structure.
 
 The problem with UUID is that it cannot be recovered if the backup binary or
-SMBIOS logs are lost. You can backup the SMBIOS information with our
-[Dasharo Tools Suite bootablestick](https://docs.dasharo.com/dasharo-tools-suite/documentation#bootable-usb-stick).
+SMBIOS logs are lost. You can backup the SMBIOS information with our [Dasharo
+Tools Suite
+bootablestick](https://docs.dasharo.com/dasharo-tools-suite/documentation/running/#bootable-usb-stick).
 The `dmidecode.log` will have all the necessary information. Things we know
 about MSI system UUID:
 

diff --git a/docs/unified/novacustom/firmware-transition.md b/docs/unified/novacustom/firmware-transition.md
@@ -26,11 +26,13 @@ firmware installation:
     For a more detailed guide on the UEFI Setup Menu options, check out the
     [Dasharo menu documentation](https://docs.dasharo.com/dasharo-menu-docs/).
 
-- [Boot into Dasharo Tools Suite](https://docs.dasharo.com/dasharo-tools-suite/documentation/#running)
+- [Boot into Dasharo Tools
+  Suite](https://docs.dasharo.com/dasharo-tools-suite/documentation/running/)
 - Enter your DPP subscription credentials
 - Select `Update Dasharo firmware` to check for updates
 - When asked to switch to Heads firmware, press `Y`
-- Proceed with [DTS firmware update](https://docs.dasharo.com/dasharo-tools-suite/documentation/#firmware-update)
+- Proceed with [DTS firmware
+  update](https://docs.dasharo.com/dasharo-tools-suite/documentation/features/#firmware-update)
   as usual
 
 When the update is finished, your laptop will shut down automatically. Power it
@@ -59,12 +61,14 @@ back on to boot into your new Heads installation!
 
 To revert back to UEFI, you will need to boot into DTS from a USB stick.
 
-- Follow the [Dasharo Tools Suite documentation](https://docs.dasharo.com/dasharo-tools-suite/documentation/#running)
+- Follow the [Dasharo Tools Suite
+  documentation](https://docs.dasharo.com/dasharo-tools-suite/documentation/running/)
   to boot DTS from a USB stick
 - In the DTS main menu, select `Update Dasharo firmware` to check for available
   updates.
 - When prompted to revert back to UEFI, press `Y`
-- Proceed with [DTS firmware update](https://docs.dasharo.com/dasharo-tools-suite/documentation/#firmware-update)
+- Proceed with [DTS firmware
+  update](https://docs.dasharo.com/dasharo-tools-suite/documentation/features/#firmware-update)
   as usual
 
 Once finished, your laptop will shut down automatically. Power it back on to

diff --git a/docs/variants/novacustom_ns5x_adl/releases.md b/docs/variants/novacustom_ns5x_adl/releases.md
@@ -276,7 +276,8 @@ Test results for this release can be found
 - [Vboot recovery mode information popup](https://docs.dasharo.com/unified-test-documentation/dasharo-security/201-verified-boot/#vbo009001-recovery-boot-popup-firmware)
 - [Dasharo setup menu full screen mode support](https://github.com/Dasharo/dasharo-issues/issues/118)
 - [Support for RGB backlit keyboard](https://docs.dasharo.com/unified/novacustom/features/)
-- [Support for open-source EC firmware](https://docs.dasharo.com/dasharo-tools-suite/documentation#ec-transition)
+- [Support for open-source EC
+  firmware](https://docs.dasharo.com/dasharo-tools-suite/documentation/features/#ec-transition)
 
 ### Known issues
 

diff --git a/docs/variants/novacustom_ns5x_tgl/releases.md b/docs/variants/novacustom_ns5x_tgl/releases.md
@@ -262,7 +262,8 @@ section for more details on upgrading your firmware.
 
 - Rebased on upstream coreboot revision 1a8eb6c0
 
-- [Support for Open EC Firmware](https://docs.dasharo.com/dasharo-tools-suite/documentation#ec-transition)
+- [Support for Open EC
+  Firmware](https://docs.dasharo.com/dasharo-tools-suite/documentation/features/#ec-transition)
 
 - [Disabled UEFI Secure Boot by default](https://docs.dasharo.com/unified-test-documentation/dasharo-security/206-secure-boot/)
 

diff --git a/docs/variants/novacustom_nv4x_tgl/releases.md b/docs/variants/novacustom_nv4x_tgl/releases.md
@@ -268,7 +268,8 @@ section for more details on upgrading your firmware.
 ### Changed
 
 - [Rebased on upstream coreboot revision from 18 Aug 2022](https://github.com/Dasharo/coreboot/commits/1a8eb6c0)
-- [Support for open-source EC firmware (transition procedure is required)](https://docs.dasharo.com/dasharo-tools-suite/documentation#ec-transition)
+- [Support for open-source EC firmware (transition procedure is
+  required)](https://docs.dasharo.com/dasharo-tools-suite/documentation/features/#ec-transition)
 - [Disabled UEFI Secure Boot by default](https://docs.dasharo.com/unified-test-documentation/dasharo-security/206-secure-boot/)
 
 ### Fixed

diff --git a/docs/variants/pc_engines/initial-deployment.md b/docs/variants/pc_engines/initial-deployment.md
@@ -33,7 +33,8 @@ seamlessly.
 
 - Ensure [Firmware Write Protection](https://github.com/pcengines/sortbootorder?tab=readme-ov-file#bios-wp-option)
   is disabled in sortbootorder
-- [Boot into Dasharo Tools Suite](https://docs.dasharo.com/dasharo-tools-suite/documentation/#running)
+- [Boot into Dasharo Tools
+  Suite](https://docs.dasharo.com/dasharo-tools-suite/documentation/running/)
 - Enter your DPP subscription credentials
 - Select `Install Dasharo firmware` to check for updates
 - When asked to select your firmware branch, select DPP

diff --git a/docs/variants/supermicro_x11_lga1151_series/initial-deployment.md b/docs/variants/supermicro_x11_lga1151_series/initial-deployment.md
@@ -79,7 +79,7 @@ iPXE Shell
 ## Vendor BIOS backup
 
 Please follow [DTS backup
-guide](https://docs.dasharo.com/dasharo-tools-suite/documentation/#bios-backup).
+guide](https://docs.dasharo.com/dasharo-tools-suite/documentation/features/#bios-backup).
 
 ## Installing Dasharo with DTS