Upgrade instructions: Add tabs for Linux/macOS instructions

Introduce the use of content tabs in the docs, because it looks nice and fancy. In fact we already had tabs in the contribution guide for docs, but that one was likely a copy-paste from Mkdocs documentation. Link content tabs (although for now we only have one tab group): https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#linked-content-tabs Fix the case on “macOS”. Signed-off-by: Quentin Monnet <[email protected]>
githedgehog · Dec 19, 2024 · 70e8b65 · 70e8b65
1 parent b7ee6b4
commit 70e8b65
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 12 deletions.
diff --git a/docs/install-upgrade/install.md b/docs/install-upgrade/install.md
@@ -57,19 +57,20 @@ The installer for the fabric is generated in `$CWD/result/`. This installation i
 !!! warning ""
     This will erase data on the USB disk.
 
-### Steps for Linux
-1. Insert the USB to your machine
-1. Identify the path to your USB stick, for example: `/dev/sdc`
-1. Issue the command to write the image to the USB drive
-    - `sudo dd if=control-1-install-usb.img of=/dev/sdc bs=4k status=progress`
-
-### Steps for MacOS
-1. Plug the drive into the computer
-1. Open the terminal
-1. Identify the drive using `diskutil list`
-1. Unmount the disk `diskutil unmount disk5`, the disk is specific to your environment
-1. Write the image to the disk: `sudo dd if=./control-1-install-usb.img of=/dev/disk5 bs=4k status=progress`
+=== "Linux"
 
+    1. Insert the USB to your machine
+    1. Identify the path to your USB stick, for example: `/dev/sdc`
+    1. Issue the command to write the image to the USB drive
+        - `sudo dd if=control-1-install-usb.img of=/dev/sdc bs=4k status=progress`
+
+=== "macOS"
+
+    1. Plug the drive into the computer
+    1. Open the terminal
+    1. Identify the drive using `diskutil list`
+    1. Unmount the disk `diskutil unmount disk5`, the disk is specific to your environment
+    1. Write the image to the disk: `sudo dd if=./control-1-install-usb.img of=/dev/disk5 bs=4k status=progress`
 
 There are utilities that assist this process such as [etcher](https://etcher.balena.io/).
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -15,6 +15,7 @@ theme:
   features:
     - announce.dismiss
     - content.action.edit
+    - content.tabs.link
     - navigation.instant
     - navigation.instant.progress
     - navigation.tracking