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

documentation: improve legibility of command output

Browse Source 
Improve legibility of command output.
This commit is contained in:
a-kenji
2024-05-24 12:37:27 +02:00
parent 35be09feaa
commit 2284b060be
4 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/site/getting-started/configure.md
View File

@@ -59,7 +59,7 @@ Adding or configuring a new machine requires two simple steps:
Which should show something like: Which should show something like:
```bash hl_lines="6" ```{.shellSession hl_lines="6" .no-copy}
NAME ID-LINK FSTYPE SIZE MOUNTPOINT NAME ID-LINK FSTYPE SIZE MOUNTPOINT
sda usb-ST_16GB_AA6271026J1000000509-0:0 14.9G sda usb-ST_16GB_AA6271026J1000000509-0:0 14.9G
├─sda1 usb-ST_16GB_AA6271026J1000000509-0:0-part1 1M ├─sda1 usb-ST_16GB_AA6271026J1000000509-0:0-part1 1M

8
docs/site/getting-started/deploy.md
View File

@@ -52,7 +52,7 @@ This process involves preparing a suitable hardware and disk partitioning config
This is an example of the booted installer. This is an example of the booted installer.
```{ .bash .annotate .no-copy } ```{ .bash .annotate .no-copy .nohighlight}
┌─────────────────────────────────────────────────────────────────────────────────────┐ ┌─────────────────────────────────────────────────────────────────────────────────────┐
│ ┌───────────────────────────┐ │ │ ┌───────────────────────────┐ │
│ │███████████████████████████│ # This is the QR Code (1) │ │ │███████████████████████████│ # This is the QR Code (1) │
@@ -151,7 +151,7 @@ Clan CLI enables you to remotely update your machines over SSH. This requires se
### Setting the Target Host ### Setting the Target Host
Replace `root@jon` with the actual hostname or IP address of your target machine: Replace `root@jon` with the actual hostname or IP address of your target machine:
```nix hl_lines="9" ```{.nix hl_lines="9" .no-copy}
buildClan { buildClan {
# ... # ...
machines = { machines = {
@@ -192,7 +192,7 @@ it is also possible to specify a build host instead.
During an update, the cli will ssh into the build host and run `nixos-rebuild` from there. During an update, the cli will ssh into the build host and run `nixos-rebuild` from there.
```nix hl_lines="5" ```{.nix hl_lines="5" .no-copy}
buildClan { buildClan {
# ... # ...
machines = { machines = {
@@ -208,7 +208,7 @@ buildClan {
To exclude machines from being updated when running `clan machines update` without any machines specified, To exclude machines from being updated when running `clan machines update` without any machines specified,
one can set the `clan.deployment.requireExplicitUpdate` option to true: one can set the `clan.deployment.requireExplicitUpdate` option to true:
```nix hl_lines="5" ```{.nix hl_lines="5" .no-copy}
buildClan { buildClan {
# ... # ...
machines = { machines = {

4
docs/site/getting-started/installer.md
View File

@@ -22,7 +22,7 @@ Follow our step-by-step guide to create and transfer this image onto a bootable
lsblk lsblk
``` ```
```shellSession hl_lines="2" ```{.shellSession hl_lines="2" .no-copy}
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINTS NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINTS
sdb 8:0 1 117,2G 0 disk sdb 8:0 1 117,2G 0 disk
└─sdb1 8:1 1 117,2G 0 part /run/media/qubasa/INTENSO └─sdb1 8:1 1 117,2G 0 part /run/media/qubasa/INTENSO
@@ -123,7 +123,7 @@ This will enter `iwd`
Now run the following command to connect to your Wifi: Now run the following command to connect to your Wifi:
```shellSession ```{.shellSession .no-copy}
# Identify your network device. # Identify your network device.
device list device list

4
docs/site/getting-started/mesh-vpn.md
View File

@@ -9,7 +9,7 @@ include a new machine into the VPN.
By default all machines within one clan are connected via a chosen network technology. By default all machines within one clan are connected via a chosen network technology.
``` ```{.no-copy}
Clan Clan
Node A Node A
<-> (zerotier / mycelium / ...) <-> (zerotier / mycelium / ...)
@@ -36,7 +36,7 @@ peers. Once addresses are allocated, the controller's continuous operation is no
``` ```
3. **Update the Controller Machine**: Execute the following: 3. **Update the Controller Machine**: Execute the following:
```bash ```bash
$ clan machines update <CONTROLLER> clan machines update <CONTROLLER>
``` ```
Your machine is now operational as the VPN controller. Your machine is now operational as the VPN controller.