yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: remove step numbers

Browse Source 
Numerating steps is not informative and considered bad style
People tend to follow documentation non-linearly
leaving of at one point, starting over from the middle
Documentation should be written in a way that allow for that
This commit is contained in:
Johannes Kirschbauer
2025-07-02 15:53:24 +02:00
parent d7dcb55001
commit 6c7beb7aaa
8 changed files with 55 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/site/guides/disk-encryption.md
View File

@@ -63,8 +63,7 @@ Replace `kernelModules` with the ethernet module loaded one on your target machi
}
```
### Step 1: Copying SSH Public Key
## Copying SSH Public Key
Before starting the installation process, ensure that the SSH public key is copied to the NixOS installer.
@@ -74,7 +73,7 @@ Before starting the installation process, ensure that the SSH public key is copi
ssh-copy-id -o PreferredAuthentications=password -o PubkeyAuthentication=no root@nixos-installer.local
```
### Step 1.5: Prepare Secret Key and Partition Disks
## Prepare Secret Key and Partition Disks
1. Access the installer using SSH:
@@ -100,7 +99,7 @@ blkdiscard /dev/disk/by-id/<installdisk>
clan machines install gchq-local --target-host root@nixos-installer --phases kexec,disko
```
### Step 2: ZFS Pool Import and System Installation
## ZFS Pool Import and System Installation
1. SSH into the installer once again:
@@ -151,7 +150,7 @@ zpool export zroot
8. Perform a reboot of the machine and remove the USB installer.
### Step 3: Accessing the Initial Ramdisk (initrd) Environment
## Accessing the Initial Ramdisk (initrd) Environment
1. SSH into the initrd environment using the `initrd_rsa_key` and provided port: