From 172de18e748804b76b773f083bf312916e05cd39 Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Fri, 29 Nov 2024 21:49:57 +0100 Subject: [PATCH] Docs: add/improve autloaded machine files section --- docs/site/getting-started/configure.md | 7 ++----- docs/site/manual/adding-machines.md | 11 +++++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/site/getting-started/configure.md b/docs/site/getting-started/configure.md index 34ad33b84..cec179f65 100644 --- a/docs/site/getting-started/configure.md +++ b/docs/site/getting-started/configure.md @@ -16,16 +16,13 @@ Clan currently offers the following methods to configure machines: - machines/`machine_name`/configuration.nix (`autoincluded` if it exists) + See the complete [list](../manual/adding-machines.md#automatic-register) of auto-loaded files. + ???+ Note "Used by CLI & UI" - inventory.json - - machines/`machine_name`/hardware-configuration.nix (`autoincluded` if it exists) -!!! Warning "Deprecated" - - machines/`machine_name`/settings.json - ## Global configuration In the `flake.nix` file: diff --git a/docs/site/manual/adding-machines.md b/docs/site/manual/adding-machines.md index 994329fe6..12bb3af47 100644 --- a/docs/site/manual/adding-machines.md +++ b/docs/site/manual/adding-machines.md @@ -9,11 +9,14 @@ Clan has two general methods of adding machines Every machine of the form `machines/{machineName}` will be registered automatically. -Automatically imported: +!!! info "Automatically loaded files" -- [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/) + Some files are loaded by a clan machine automatically. This decision was made for convinience and allows easier automation. + + - [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