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

docs: Rename mentions of inventory module to clanModule with inventory support

Browse Source
This commit is contained in:
Qubasa
2025-01-18 10:17:20 +07:00
parent 8d0a9762a2
commit 65bd3a9ac6
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/site/clanmodules/index.md
View File

@@ -53,7 +53,7 @@ clanModules/borgbackup
```nix title="flake.nix"
# ...
buildClan {
# 1. Add the module to the avilable inventory modules
# 1. Add the module to the avilable clanModules with inventory support
inventory.modules = {
custom-module = ./modules/my_module;
};
@@ -111,7 +111,7 @@ Adds the roles: `client` and `server`
Sometimes a `ClanModule` should be usable via both clan's `inventory` concept but also natively as a NixOS module.
> In the long term, we want most modules to implement support for the inventory,
> but we are also aware that there are certain low-level modules that always serve as a backend for other higher-level inventory modules.
> but we are also aware that there are certain low-level modules that always serve as a backend for other higher-level `clanModules` with inventory support.
> These modules may not want to implement inventory interfaces as they are always used directly by other modules.
This can be achieved by placing an additional `default.nix` into the root of the ClanModules directory as shown:

4
docs/site/manual/adding-machines.md
View File

@@ -20,9 +20,9 @@ Every folder `machines/{machineName}` will be registered automatically as a Clan
## Automatic Imports
The `buildClan` function will automatically import modules if a directory named `<CLAN_ROOT>/imports` exists within the Clan. Below are the conditions for importing inventory modules:
The `buildClan` function will automatically import modules if a directory named `<CLAN_ROOT>/imports` exists within the Clan. Below are the conditions for automatically importing `clanModules`:
- **Inventory Modules**: Modules located in `<CLAN_ROOT>/imports/inventory` will be automatically imported. Note that only inventory-compatible modules can be used in this location. To be compatible, a module must contain a `roles` folder.
- **Clan Modules**: Modules located in `<CLAN_ROOT>/imports/inventory` will be automatically imported. Note that only inventory-compatible modules can be used in this location. To be compatible, a module must contain a `roles` folder.
- **Adding a Module**: To add a module, such as `mymodule`, create a dedicated directory at `<CLAN_ROOT>/imports/inventory/mymodule`, ensuring that it includes a `roles` folder.