diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cf2920b6f..76f3acb60 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ # Contributing to Clan -Go to the Contributing guide at https://docs.clan.lol/manual/contribute/ \ No newline at end of file +Go to the Contributing guide at https://docs.clan.lol/guides/contributing/CONTRIBUTING \ No newline at end of file diff --git a/clanModules/borgbackup-static/README.md b/clanModules/borgbackup-static/README.md index 1bdf32a69..a0dda99da 100644 --- a/clanModules/borgbackup-static/README.md +++ b/clanModules/borgbackup-static/README.md @@ -4,7 +4,7 @@ description = "Statically configure borgbackup with sane defaults." !!! Danger "Deprecated" 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 for backup management through `borgbackup` for members of the clan. diff --git a/clanModules/root-password/README.md b/clanModules/root-password/README.md index b76443ef9..42f56ff41 100644 --- a/clanModules/root-password/README.md +++ b/clanModules/root-password/README.md @@ -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 ``` -See also: [Vars](../../manual/vars-backend.md) +See also: [Vars](../../guides/vars-backend.md) To regenerate the password run: ``` diff --git a/clanModules/user-password/README.md b/clanModules/user-password/README.md index e2e23f7c0..fa75a6331 100644 --- a/clanModules/user-password/README.md +++ b/clanModules/user-password/README.md @@ -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 ``` -See also: [Vars](../../manual/vars-backend.md) +See also: [Vars](../../guides/vars-backend.md) To regenerate the password run: ``` diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 0b8340268..fccd5e826 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -58,13 +58,13 @@ nav: - Disk Encryption: guides/disk-encryption.md - Mesh VPN: guides/mesh-vpn.md - Backup & Restore: guides/backups.md - - Vars Backend: manual/vars-backend.md - - Facts Backend: manual/secrets.md - - Autoincludes: manual/adding-machines.md + - Vars Backend: guides/vars-backend.md + - Facts Backend: guides/secrets.md + - Autoincludes: guides/adding-machines.md - Inventory: - - Inventory: manual/inventory.md - - Secure Boot: manual/secure-boot.md - - Flake-parts: manual/flake-parts.md + - Inventory: guides/inventory.md + - Secure Boot: guides/secure-boot.md + - Flake-parts: guides/flake-parts.md - Authoring: - clanService: guides/authoring/clanServices/index.md - Disk Template: guides/authoring/templates/disk/disko-templates.md diff --git a/docs/nix/render_options/__init__.py b/docs/nix/render_options/__init__.py index c0843e106..db8b54cae 100644 --- a/docs/nix/render_options/__init__.py +++ b/docs/nix/render_options/__init__.py @@ -356,7 +356,7 @@ This module can be used via predefined roles """ 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 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. !!! 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.`. See our [flake-parts](../../manual/flake-parts.md) guide. +- **flake-parts**: Each attribute can be defined via `clan.`. See our [flake-parts](../../guides/flake-parts.md) guide. ??? example "flake-parts Example" diff --git a/docs/site/manual/adding-machines.md b/docs/site/guides/adding-machines.md similarity index 96% rename from docs/site/manual/adding-machines.md rename to docs/site/guides/adding-machines.md index 008a73f7f..4cf7054cd 100644 --- a/docs/site/manual/adding-machines.md +++ b/docs/site/guides/adding-machines.md @@ -21,7 +21,7 @@ Every folder `machines/{machineName}` will be registered automatically as a Clan ## 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 It is possible to use `inventory` and `buildClan` together at the same time. diff --git a/docs/site/guides/authoring/clanModules/index.md b/docs/site/guides/authoring/clanModules/index.md index a2a273693..2b8e4898e 100644 --- a/docs/site/guides/authoring/clanModules/index.md +++ b/docs/site/guides/authoring/clanModules/index.md @@ -13,7 +13,7 @@ This site will guide you through authoring your first module. Explaining which c ## 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. Because ClanModules should be configurable via `json`/`API` all of its interface (`options`) must be serializable. diff --git a/docs/site/manual/flake-parts.md b/docs/site/guides/flake-parts.md similarity index 100% rename from docs/site/manual/flake-parts.md rename to docs/site/guides/flake-parts.md diff --git a/docs/site/guides/getting-started/configure.md b/docs/site/guides/getting-started/configure.md index 4c54eb754..c09c3b1a0 100644 --- a/docs/site/guides/getting-started/configure.md +++ b/docs/site/guides/getting-started/configure.md @@ -14,7 +14,7 @@ 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-registration) of auto-loaded files. + See the complete [list](../../guides/adding-machines.md#automatic-registration) of auto-loaded files. ???+ Note "Used by CLI & UI" @@ -40,7 +40,7 @@ In the `flake.nix` file: === "**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" clan = { diff --git a/docs/site/guides/getting-started/installer.md b/docs/site/guides/getting-started/installer.md index c1dfd7fb8..bfee48a66 100644 --- a/docs/site/guides/getting-started/installer.md +++ b/docs/site/guides/getting-started/installer.md @@ -151,7 +151,7 @@ sudo umount /dev/sdb1 ### 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 diff --git a/docs/site/manual/inventory.md b/docs/site/guides/inventory.md similarity index 100% rename from docs/site/manual/inventory.md rename to docs/site/guides/inventory.md diff --git a/docs/site/guides/migrations/migration-facts-vars.md b/docs/site/guides/migrations/migration-facts-vars.md index 10fef6def..708b722f4 100644 --- a/docs/site/guides/migrations/migration-facts-vars.md +++ b/docs/site/guides/migrations/migration-facts-vars.md @@ -2,8 +2,8 @@ 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 -to the [`vars`](../../manual/vars-backend.md) backend. +This guide will help you migrate your modules that still use our [`facts`](../../guides/secrets.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. diff --git a/docs/site/manual/secrets.md b/docs/site/guides/secrets.md similarity index 100% rename from docs/site/manual/secrets.md rename to docs/site/guides/secrets.md diff --git a/docs/site/manual/secure-boot.md b/docs/site/guides/secure-boot.md similarity index 100% rename from docs/site/manual/secure-boot.md rename to docs/site/guides/secure-boot.md diff --git a/docs/site/manual/vars-backend.md b/docs/site/guides/vars-backend.md similarity index 100% rename from docs/site/manual/vars-backend.md rename to docs/site/guides/vars-backend.md diff --git a/docs/site/index.md b/docs/site/index.md index e869a5975..32cf4bc8e 100644 --- a/docs/site/index.md +++ b/docs/site/index.md @@ -14,25 +14,25 @@ hide:
-- [Autoincludes](./manual/adding-machines.md) +- [Autoincludes](./guides/adding-machines.md) --- 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. -- [Inventory](./manual/inventory.md) +- [Inventory](./guides/inventory.md) --- Clan's declaration format for running **services** on one or multiple **machines**. -- [Flake-parts](./manual/flake-parts.md) +- [Flake-parts](./guides/flake-parts.md) --- diff --git a/formatter.nix b/formatter.nix index 60caffe0c..cb4b458ad 100644 --- a/formatter.nix +++ b/formatter.nix @@ -29,7 +29,7 @@ "*.list" "*.desktop" # ignore symlink - "docs/site/manual/contribute.md" + "docs/site/guides/contributing/CONTRIBUTING.md" "*_test_cert" "*_test_key" "*/gnupg-home/*" diff --git a/lib/inventory/build-inventory/builder/default.nix b/lib/inventory/build-inventory/builder/default.nix index 36177e917..e4648354d 100644 --- a/lib/inventory/build-inventory/builder/default.nix +++ b/lib/inventory/build-inventory/builder/default.nix @@ -114,7 +114,7 @@ let warnings = [ '' 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. '' ]; }; diff --git a/lib/inventory/build-inventory/interface.nix b/lib/inventory/build-inventory/interface.nix index 63bebb21c..6c9d2a4c7 100644 --- a/lib/inventory/build-inventory/interface.nix +++ b/lib/inventory/build-inventory/interface.nix @@ -163,8 +163,8 @@ in map (m: "'${m}'") (lib.attrNames (lib.filterAttrs (n: _v: !builtins.elem n allowedNames) moduleSet)) )} - See: https://docs.clan.lol/manual/distributed-services/ - And: https://docs.clan.lol/authoring/clanServices/ + See: https://docs.clan.lol/guides/clanServices/ + And: https://docs.clan.lol/guides/authoring/clanServices/ '' moduleSet; }; diff --git a/lib/inventory/frontmatter/default.nix b/lib/inventory/frontmatter/default.nix index a340486ed..83fda98e3 100644 --- a/lib/inventory/frontmatter/default.nix +++ b/lib/inventory/frontmatter/default.nix @@ -73,7 +73,7 @@ let (Legacy) ClanModule not found: '${serviceName}'. 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 '' diff --git a/pkgs/clan-cli/clan_cli/vars/cli.py b/pkgs/clan-cli/clan_cli/vars/cli.py index 2ebafe9e0..ae0303ea9 100644 --- a/pkgs/clan-cli/clan_cli/vars/cli.py +++ b/pkgs/clan-cli/clan_cli/vars/cli.py @@ -95,7 +95,7 @@ Examples: 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, @@ -114,7 +114,7 @@ Examples: $ clan vars get my-server zerotier/vpn-ip 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, @@ -133,7 +133,7 @@ Examples: $ clan vars set my-server zerotier/vpn-ip 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, @@ -173,7 +173,7 @@ Examples: This is especially useful for resetting certain passwords while leaving the rest 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,