From 4a05f8dd6cf428bf74395204ee1e7b81d1ea2c60 Mon Sep 17 00:00:00 2001 From: Michael Hoang Date: Wed, 11 Dec 2024 13:54:18 +1100 Subject: [PATCH] docs: update `Adding Machines` guide --- docs/site/manual/adding-machines.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/site/manual/adding-machines.md b/docs/site/manual/adding-machines.md index 12bb3af47..07c16db9b 100644 --- a/docs/site/manual/adding-machines.md +++ b/docs/site/manual/adding-machines.md @@ -1,22 +1,22 @@ # Adding Machines -Clan has two general methods of adding machines +Clan has two general methods of adding machines: - **Automatic**: Detects every folder in the `machines` folder. -- **Declarative**: Explicit declarations in nix. +- **Declarative**: Explicit declarations in Nix. -## Automatic register +## Automatic registration -Every machine of the form `machines/{machineName}` will be registered automatically. +Every folder `machines/{machineName}` will be registered automatically as a Clan machine. !!! info "Automatically loaded files" - Some files are loaded by a clan machine automatically. This decision was made for convinience and allows easier automation. + The following files are loaded automatically for each Clan machine: - - [x] ``machines/{machineName}/configuration.nix` - - [x] ``machines/{machineName}/hardware-configuration.nix` - - [x] ``machines/{machineName}/facter.json` Automatically configured, for further information see [nixos-facter](https://clan.lol/blog/nixos-facter/) - - [x] ``machines/{machineName}/disko.nix` Automatically loaded, for further information see the [disko docs](https://github.com/nix-community/disko/blob/master/docs/quickstart.md). + - [x] `machines/{machineName}/configuration.nix` + - [x] `machines/{machineName}/hardware-configuration.nix` + - [x] `machines/{machineName}/facter.json` Automatically configured, for further information see [nixos-facter](https://clan.lol/blog/nixos-facter/) + - [x] `machines/{machineName}/disko.nix` Automatically loaded, for further information see the [disko docs](https://github.com/nix-community/disko/blob/master/docs/quickstart.md). ## Manual declaration