Docs: unify 'manual' with 'guides' folder

This is one of the final steps towards strictly following
https://diataxis.fr/
This commit is contained in:
Johannes Kirschbauer
2025-05-18 20:40:40 +02:00
parent cd808f6c0f
commit af58c32238
20 changed files with 31 additions and 31 deletions

View File

@@ -4,7 +4,7 @@ description = "Statically configure borgbackup with sane defaults."
!!! Danger "Deprecated" !!! Danger "Deprecated"
Use [borgbackup](borgbackup.md) instead. Use [borgbackup](borgbackup.md) instead.
Don't use borgbackup-static through [inventory](../../manual/inventory.md). Don't use borgbackup-static through [inventory](../../guides/inventory.md).
This module implements the `borgbackup` backend and implements sane defaults This module implements the `borgbackup` backend and implements sane defaults
for backup management through `borgbackup` for members of the clan. for backup management through `borgbackup` for members of the clan.

View File

@@ -10,7 +10,7 @@ After the system was installed/deployed the following command can be used to dis
clan vars get [machine_name] root-password/root-password clan vars get [machine_name] root-password/root-password
``` ```
See also: [Vars](../../manual/vars-backend.md) See also: [Vars](../../guides/vars-backend.md)
To regenerate the password run: To regenerate the password run:
``` ```

View File

@@ -16,7 +16,7 @@ After the system was installed/deployed the following command can be used to dis
clan vars get [machine_name] root-password/root-password clan vars get [machine_name] root-password/root-password
``` ```
See also: [Vars](../../manual/vars-backend.md) See also: [Vars](../../guides/vars-backend.md)
To regenerate the password run: To regenerate the password run:
``` ```

View File

@@ -58,13 +58,13 @@ nav:
- Disk Encryption: guides/disk-encryption.md - Disk Encryption: guides/disk-encryption.md
- Mesh VPN: guides/mesh-vpn.md - Mesh VPN: guides/mesh-vpn.md
- Backup & Restore: guides/backups.md - Backup & Restore: guides/backups.md
- Vars Backend: manual/vars-backend.md - Vars Backend: guides/vars-backend.md
- Facts Backend: manual/secrets.md - Facts Backend: guides/secrets.md
- Autoincludes: manual/adding-machines.md - Autoincludes: guides/adding-machines.md
- Inventory: - Inventory:
- Inventory: manual/inventory.md - Inventory: guides/inventory.md
- Secure Boot: manual/secure-boot.md - Secure Boot: guides/secure-boot.md
- Flake-parts: manual/flake-parts.md - Flake-parts: guides/flake-parts.md
- Authoring: - Authoring:
- clanService: guides/authoring/clanServices/index.md - clanService: guides/authoring/clanServices/index.md
- Disk Template: guides/authoring/templates/disk/disko-templates.md - Disk Template: guides/authoring/templates/disk/disko-templates.md

View File

@@ -356,7 +356,7 @@ This module can be used via predefined roles
""" """
Every role has its own configuration options, which are each listed below. Every role has its own configuration options, which are each listed below.
For more information, see the [inventory guide](../../manual/inventory.md). For more information, see the [inventory guide](../../guides/inventory.md).
??? Example ??? Example
For example the `admin` module adds the following options globally to all machines where it is used. For example the `admin` module adds the following options globally to all machines where it is used.
@@ -405,7 +405,7 @@ certain option types restricted to enable configuration through a graphical
interface. interface.
!!! note "🔹" !!! note "🔹"
Modules with this indicator support the [inventory](../../manual/inventory.md) feature. Modules with this indicator support the [inventory](../../guides/inventory.md) feature.
""" """
@@ -705,7 +705,7 @@ Each attribute is documented below
}; };
``` ```
- **flake-parts**: Each attribute can be defined via `clan.<attribute name>`. See our [flake-parts](../../manual/flake-parts.md) guide. - **flake-parts**: Each attribute can be defined via `clan.<attribute name>`. See our [flake-parts](../../guides/flake-parts.md) guide.
??? example "flake-parts Example" ??? example "flake-parts Example"

View File

@@ -21,7 +21,7 @@ Every folder `machines/{machineName}` will be registered automatically as a Clan
## Manual declaration ## Manual declaration
Machines can also be added manually under `buildClan`, `clan.*` in flake-parts or via [`inventory`](../manual/inventory.md). Machines can also be added manually under `buildClan`, `clan.*` in flake-parts or via [`inventory`](../guides/inventory.md).
!!! Note !!! Note
It is possible to use `inventory` and `buildClan` together at the same time. It is possible to use `inventory` and `buildClan` together at the same time.

View File

@@ -13,7 +13,7 @@ This site will guide you through authoring your first module. Explaining which c
## Bootstrapping the `clanModule` ## Bootstrapping the `clanModule`
A ClanModule is a specific subset of a [NixOS Module](https://nix.dev/tutorials/module-system/index.html), but it has some constraints and might be used via the [Inventory](../../../manual/inventory.md) interface. A ClanModule is a specific subset of a [NixOS Module](https://nix.dev/tutorials/module-system/index.html), but it has some constraints and might be used via the [Inventory](../../../guides/inventory.md) interface.
In fact a `ClanModule` can be thought of as a layer of abstraction on-top of NixOS and/or other ClanModules. It may configure sane defaults and provide an ergonomic interface that is easy to use and can also be used via a UI that is under development currently. In fact a `ClanModule` can be thought of as a layer of abstraction on-top of NixOS and/or other ClanModules. It may configure sane defaults and provide an ergonomic interface that is easy to use and can also be used via a UI that is under development currently.
Because ClanModules should be configurable via `json`/`API` all of its interface (`options`) must be serializable. Because ClanModules should be configurable via `json`/`API` all of its interface (`options`) must be serializable.

View File

@@ -14,7 +14,7 @@ Clan currently offers the following methods to configure machines:
- machines/`machine_name`/configuration.nix (`autoincluded` if it exists) - machines/`machine_name`/configuration.nix (`autoincluded` if it exists)
See the complete [list](../../manual/adding-machines.md#automatic-registration) of auto-loaded files. See the complete [list](../../guides/adding-machines.md#automatic-registration) of auto-loaded files.
???+ Note "Used by CLI & UI" ???+ Note "Used by CLI & UI"
@@ -40,7 +40,7 @@ In the `flake.nix` file:
=== "**template using flake-parts**" === "**template using flake-parts**"
!!! info "See [Clan with flake-parts](../../manual/flake-parts.md) for help migrating to flake-parts." !!! info "See [Clan with flake-parts](../../guides/flake-parts.md) for help migrating to flake-parts."
```nix title="flake.nix" hl_lines="3" ```nix title="flake.nix" hl_lines="3"
clan = { clan = {

View File

@@ -151,7 +151,7 @@ sudo umount /dev/sdb1
### Step 3: Boot From USB Stick ### Step 3: Boot From USB Stick
- To use, boot from the Clan USB drive with **secure boot turned off**. For step by step instructions go to [Disabling Secure Boot](../../manual/secure-boot.md) - To use, boot from the Clan USB drive with **secure boot turned off**. For step by step instructions go to [Disabling Secure Boot](../../guides/secure-boot.md)
## (Optional) Connect to Wifi Manually ## (Optional) Connect to Wifi Manually

View File

@@ -2,8 +2,8 @@
For a high level overview about `vars` see our [blog post](https://clan.lol/blog/vars/). For a high level overview about `vars` see our [blog post](https://clan.lol/blog/vars/).
This guide will help you migrate your modules that still use our [`facts`](../../manual/secrets.md) backend This guide will help you migrate your modules that still use our [`facts`](../../guides/secrets.md) backend
to the [`vars`](../../manual/vars-backend.md) backend. to the [`vars`](../../guides/vars-backend.md) backend.
The `vars` [module](../../reference/clan-core/vars.md) and the clan [command](../../reference/cli/vars.md) work in tandem, they should ideally be kept in sync. The `vars` [module](../../reference/clan-core/vars.md) and the clan [command](../../reference/cli/vars.md) work in tandem, they should ideally be kept in sync.

View File

@@ -14,25 +14,25 @@ hide:
<div class="grid cards" markdown> <div class="grid cards" markdown>
- [Autoincludes](./manual/adding-machines.md) - [Autoincludes](./guides/adding-machines.md)
--- ---
Learn how Clan automatically includes machines and Nix files. Learn how Clan automatically includes machines and Nix files.
- [Vars Backend](./manual/vars-backend.md) - [Vars Backend](./guides/vars-backend.md)
--- ---
Learn how to manage secrets with facts. Learn how to manage secrets with facts.
- [Inventory](./manual/inventory.md) - [Inventory](./guides/inventory.md)
--- ---
Clan's declaration format for running **services** on one or multiple **machines**. Clan's declaration format for running **services** on one or multiple **machines**.
- [Flake-parts](./manual/flake-parts.md) - [Flake-parts](./guides/flake-parts.md)
--- ---

View File

@@ -114,7 +114,7 @@ let
warnings = [ warnings = [
'' ''
The '${serviceName}' module has been migrated from `inventory.services` to `inventory.instances` The '${serviceName}' module has been migrated from `inventory.services` to `inventory.instances`
See https://docs.clan.lol/manual/distributed-services/ for usage. See https://docs.clan.lol/guides/clanServices/ for usage.
'' ''
]; ];
}; };

View File

@@ -163,8 +163,8 @@ in
map (m: "'${m}'") (lib.attrNames (lib.filterAttrs (n: _v: !builtins.elem n allowedNames) moduleSet)) map (m: "'${m}'") (lib.attrNames (lib.filterAttrs (n: _v: !builtins.elem n allowedNames) moduleSet))
)} )}
See: https://docs.clan.lol/manual/distributed-services/ See: https://docs.clan.lol/guides/clanServices/
And: https://docs.clan.lol/authoring/clanServices/ And: https://docs.clan.lol/guides/authoring/clanServices/
'' moduleSet; '' moduleSet;
}; };

View File

@@ -73,7 +73,7 @@ let
(Legacy) ClanModule not found: '${serviceName}'. (Legacy) ClanModule not found: '${serviceName}'.
Please update your configuration to use this module via 'inventory.instances' Please update your configuration to use this module via 'inventory.instances'
See: https://docs.clan.lol/manual/distributed-services/ See: https://docs.clan.lol/guides/clanServices/
'' ''
else else
'' ''

View File

@@ -95,7 +95,7 @@ Examples:
This will print secret as well as public vars directly. This will print secret as well as public vars directly.
For more detailed information, visit: {help_hyperlink("vars", "https://docs.clan.lol/manual/vars-backend/")} For more detailed information, visit: {help_hyperlink("vars", "https://docs.clan.lol/guides/vars-backend/")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,
@@ -114,7 +114,7 @@ Examples:
$ clan vars get my-server zerotier/vpn-ip $ clan vars get my-server zerotier/vpn-ip
Will get the var for the specified machine. Will get the var for the specified machine.
For more detailed information, visit: {help_hyperlink("vars", "https://docs.clan.lol/manual/vars-backend/")} For more detailed information, visit: {help_hyperlink("vars", "https://docs.clan.lol/guides/vars-backend/")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,
@@ -133,7 +133,7 @@ Examples:
$ clan vars set my-server zerotier/vpn-ip $ clan vars set my-server zerotier/vpn-ip
Will set the var for the specified machine. Will set the var for the specified machine.
For more detailed information, visit: {help_hyperlink("vars", "https://docs.clan.lol/manual/vars-backend/")} For more detailed information, visit: {help_hyperlink("vars", "https://docs.clan.lol/guides/vars-backend/")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,
@@ -173,7 +173,7 @@ Examples:
This is especially useful for resetting certain passwords while leaving the rest This is especially useful for resetting certain passwords while leaving the rest
of the vars for a machine in place. of the vars for a machine in place.
For more detailed information, visit: {help_hyperlink("vars", "https://docs.clan.lol/manual/vars-backend/")} For more detailed information, visit: {help_hyperlink("vars", "https://docs.clan.lol/guides/vars-backend/")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,