From 996a98fe404efbf4c94db33c720bf6364db8b121 Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Sat, 13 Apr 2024 13:59:48 +0200 Subject: [PATCH] docs: move hardware / cloud computers behind tab selection --- docs/docs/getting-started/machines.md | 17 ++++++++++++++--- docs/mkdocs.yml | 8 +++++++- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/docs/docs/getting-started/machines.md b/docs/docs/getting-started/machines.md index 1d4a2691f..684ddb6a6 100644 --- a/docs/docs/getting-started/machines.md +++ b/docs/docs/getting-started/machines.md @@ -12,9 +12,21 @@ This process involves preparing a suitable hardware and disk partitioning config ### Step 0. Prerequisites -Boot the target machine using our [Clan Installer](installer.md). Which is recommended for ensuring most efficient workflows. +- [x] **Two Computers**: You need one computer that you're getting ready (we'll call this the Target Computer) and another one to set it up from (we'll call this the Setup Computer). Make sure both can talk to each other over the network using SSH. -Alternatively you can use any linux machine if it is reachable via SSH and supports `kexec`. +=== "**Physical Hardware**" + + !!! How + + 1. Create a NixOS installer image and transfer it to a bootable USB drive as described in the [installer](./installer.md). + + 2. Boot the target machine and connect it to a network that makes it reachable from your setup computer. + +=== "**Cloud Machines**" + + !!! How + + Use any linux machine if it is reachable via SSH and supports `kexec`. Confirm the machine is reachable via SSH from your setup computer. @@ -22,7 +34,6 @@ Confirm the machine is reachable via SSH from your setup computer. ssh root@ ``` -- [x] **Two Computers**: You need one computer that you're getting ready (we'll call this the Target Computer) and another one to set it up from (we'll call this the Setup Computer). Make sure both can talk to each other over the network using SSH. - [x] **Machine configuration**: You want to deploy. [Check out our templates](../templates/index.md) - [x] Initialized secrets: See [secrets](secrets.md) for how to initialize your secrets. - [x] (Optional) USB Flash Drive with the [Clan Installer](installer.md) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 33d6e65a6..1dc338448 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -10,13 +10,19 @@ validation: unrecognized_links: warn markdown_extensions: + +markdown_extensions: + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.superfences + - pymdownx.tabbed: + alternate_style: true - footnotes - meta - admonition - pymdownx.details - pymdownx.highlight: use_pygments: true - - pymdownx.superfences - toc: title: On this page