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

Merge pull request 'Move developer guides to the "Developer" section' (#4462) from Qubasa/clan-core:dev_docs into main

Browse Source 
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4462
This commit is contained in:
Luis Hebendanz
2025-07-23 12:10:45 +00:00
parent 1e51439414 5c7e6b3830
commit 329047e865
16 changed files with 110 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
docs/mkdocs.yml
View File

@@ -48,34 +48,25 @@ nav:
- Home: index.md - Home: index.md
- Guides: - Guides:
- Getting Started: - Getting Started:
- 🚀 Creating Your First Clan: guides/getting-started/index.md - Creating Your First Clan: guides/getting-started/index.md
- 📀 Create USB Installer (optional): guides/getting-started/installer.md - Create USB Installer: guides/getting-started/installer.md
- ⚙️ Add Machines: guides/getting-started/add-machines.md - Add Machines: guides/getting-started/add-machines.md
- ⚙️ Add User: guides/getting-started/add-user.md - Add User: guides/getting-started/add-user.md
- ⚙️ Add Services: guides/getting-started/add-services.md - Add Services: guides/getting-started/add-services.md
- 🚢 Deploy Machine: guides/getting-started/deploy.md - Deploy Machine: guides/getting-started/deploy.md
- 🧪 Continuous Integration: guides/getting-started/check.md - Continuous Integration: guides/getting-started/check.md
- clanServices: guides/clanServices.md - Inventory: guides/inventory.md
- Disk Encryption: guides/disk-encryption.md - Using Services: guides/clanServices.md
- Mesh VPN: guides/mesh-vpn.md
- Backup & Restore: guides/backups.md - Backup & Restore: guides/backups.md
- Disk Encryption: guides/disk-encryption.md
- Vars: guides/vars-backend.md - Vars: guides/vars-backend.md
- Age Plugins: guides/age-plugins.md - Age Plugins: guides/age-plugins.md
- Secrets (Advanced Usage): guides/secrets.md - Advanced Secrets: guides/secrets.md
- Adding more machines: guides/more-machines.md - Machine Autoincludes: guides/more-machines.md
- Target Host: guides/target-host.md - Target Host: guides/target-host.md
- Inventory: - Zerotier VPN: guides/mesh-vpn.md
- Inventory: guides/inventory.md
- Secure Boot: guides/secure-boot.md - Secure Boot: guides/secure-boot.md
- Flake-parts: guides/flake-parts.md - Flake-parts: guides/flake-parts.md
- Authoring:
- clanService: guides/authoring/clanServices/index.md
- Disk Template: guides/authoring/templates/disk/disko-templates.md
- clanModule: guides/authoring/clanModules/index.md
- Contributing:
- Contribute: guides/contributing/CONTRIBUTING.md
- Debugging: guides/contributing/debugging.md
- Testing: guides/contributing/testing.md
- Migrations: - Migrations:
- Migrate existing Flakes: guides/migrations/migration-guide.md - Migrate existing Flakes: guides/migrations/migration-guide.md
- Migrate inventory Services: guides/migrations/migrate-inventory-services.md - Migrate inventory Services: guides/migrations/migrate-inventory-services.md
@@ -85,6 +76,7 @@ nav:
- Reference: - Reference:
- Overview: reference/index.md - Overview: reference/index.md
- Services: - Services:
- List:
- Overview: reference/clanServices/index.md - Overview: reference/clanServices/index.md
- reference/clanServices/admin.md - reference/clanServices/admin.md
- reference/clanServices/borgbackup.md - reference/clanServices/borgbackup.md
@@ -101,8 +93,10 @@ nav:
- reference/clanServices/users.md - reference/clanServices/users.md
- reference/clanServices/wifi.md - reference/clanServices/wifi.md
- reference/clanServices/zerotier.md - reference/clanServices/zerotier.md
- Interface for making Services: reference/clanServices/clan-service-author-interface.md - API: reference/clanServices/clan-service-author-interface.md
- Writing a Service Module: developer/extensions/clanServices/index.md
- Modules: - Modules:
- List:
- Overview: reference/clanModules/index.md - Overview: reference/clanModules/index.md
- reference/clanModules/frontmatter/index.md - reference/clanModules/frontmatter/index.md
# TODO: display the docs of the clan.service modules # TODO: display the docs of the clan.service modules
@@ -145,6 +139,21 @@ nav:
- reference/clanModules/zerotier-static-peers.md - reference/clanModules/zerotier-static-peers.md
- reference/clanModules/zerotier.md - reference/clanModules/zerotier.md
- reference/clanModules/zt-tcp-relay.md - reference/clanModules/zt-tcp-relay.md
- Writing a Clan Module: developer/extensions/clanModules/index.md
- Nix API:
- inputs.clan-core.lib.clan: reference/nix-api/clan.md
- config.clan.core:
- Overview: reference/clan.core/index.md
- reference/clan.core/backups.md
- reference/clan.core/deployment.md
- reference/clan.core/facts.md
- reference/clan.core/networking.md
- reference/clan.core/settings.md
- reference/clan.core/sops.md
- reference/clan.core/state.md
- reference/clan.core/vars.md
- Inventory: reference/nix-api/inventory.md
- CLI: - CLI:
- Overview: reference/cli/index.md - Overview: reference/cli/index.md
@@ -161,21 +170,7 @@ nav:
- reference/cli/templates.md - reference/cli/templates.md
- reference/cli/vars.md - reference/cli/vars.md
- reference/cli/vms.md - reference/cli/vms.md
- NixOS Modules:
- clan.core:
- Overview: reference/clan.core/index.md
- reference/clan.core/backups.md
- reference/clan.core/deployment.md
- reference/clan.core/facts.md
- reference/clan.core/networking.md
- reference/clan.core/settings.md
- reference/clan.core/sops.md
- reference/clan.core/state.md
- reference/clan.core/vars.md
- Nix API:
- clan: reference/nix-api/clan.md
- Inventory: reference/nix-api/inventory.md
- Glossary: reference/glossary.md - Glossary: reference/glossary.md
- Decisions: - Decisions:
- Architecture Decisions: decisions/README.md - Architecture Decisions: decisions/README.md
@@ -187,8 +182,14 @@ nav:
- Template: decisions/_template.md - Template: decisions/_template.md
- Options: options.md - Options: options.md
- Developer: - Developer:
- Introduction: intern/index.md - Introduction: developer/index.md
- API: intern/api.md - Dev Setup: developer/contributing/CONTRIBUTING.md
- Writing a Service Module: developer/extensions/clanServices/index.md
- Writing a Clan Module: developer/extensions/clanModules/index.md
- Writing a Disko Template: developer/extensions/templates/disk/disko-templates.md
- Debugging: developer/contributing/debugging.md
- Testing: developer/contributing/testing.md
- Python API: developer/api.md
docs_dir: site docs_dir: site
site_dir: out site_dir: out

2
docs/nix/render_options/__init__.py
View File

@@ -805,7 +805,7 @@ Typically needed by module authors to define roles, behavior and metadata for di
!!! Note !!! Note
This is not a user-facing documentation, but rather meant as a reference for *module authors* This is not a user-facing documentation, but rather meant as a reference for *module authors*
See: [clanService Authoring Guide](../../guides/authoring/clanServices/index.md) See: [clanService Authoring Guide](../../developer/extensions/clanServices/index.md)
""" """
# Inventory options are already included under the clan attribute # Inventory options are already included under the clan attribute
# We just omitted them in the clan docs, because we want a separate output for the inventory model # We just omitted them in the clan docs, because we want a separate output for the inventory model

0
docs/site/intern/api.md → docs/site/developer/api.md
View File

0
docs/site/guides/contributing/CONTRIBUTING.md → docs/site/developer/contributing/CONTRIBUTING.md
View File

0
docs/site/guides/contributing/debugging.md → docs/site/developer/contributing/debugging.md
View File

0
docs/site/guides/contributing/testing.md → docs/site/developer/contributing/testing.md
View File

0
docs/site/guides/authoring/clanModules/index.md → docs/site/developer/extensions/clanModules/index.md
View File

2
docs/site/guides/authoring/clanServices/index.md → docs/site/developer/extensions/clanServices/index.md
View File

@@ -267,5 +267,5 @@ The benefit of this approach is that downstream users can override the value of
## Further ## Further
- [Reference Documentation for Service Authors](../../../reference/clanServices/clan-service-author-interface.md) - [Reference Documentation for Service Authors](../../../reference/clanServices/clan-service-author-interface.md)
- [Migration Guide from ClanModules to ClanServices](../../migrations/migrate-inventory-services.md) - [Migration Guide from ClanModules to ClanServices](../../../guides/migrations/migrate-inventory-services.md)
- [Decision that lead to ClanServices](../../../decisions/01-ClanModules.md) - [Decision that lead to ClanServices](../../../decisions/01-ClanModules.md)

0
docs/site/guides/authoring/templates/disk/disko-templates.md → docs/site/developer/extensions/templates/disk/disko-templates.md
View File

0
docs/site/intern/index.md → docs/site/developer/index.md
View File

4
docs/site/guides/clanServices.md
View File

@@ -138,7 +138,7 @@ You can use services exposed by Clan’s core module library, `clan-core`.
You can also author your own `clanService` modules. You can also author your own `clanService` modules.
🔗 Learn how to write your own service: [Authoring a clanService](../guides/authoring/clanServices/index.md) 🔗 Learn how to write your own service: [Authoring a clanService](../developer/extensions/clanServices/index.md)
You might expose your service module from your flake — this makes it easy for other people to also use your module in their clan. You might expose your service module from your flake — this makes it easy for other people to also use your module in their clan.
@@ -154,6 +154,6 @@ You might expose your service module from your flake — this makes it easy for
## What’s Next? ## What’s Next?
* [Author your own clanService →](../guides/authoring/clanServices/index.md) * [Author your own clanService →](../developer/extensions/clanServices/index.md)
* [Migrate from clanModules →](../guides/migrations/migrate-inventory-services.md) * [Migrate from clanModules →](../guides/migrations/migrate-inventory-services.md)
<!-- TODO: * [Understand the architecture →](../explanation/clan-architecture.md) --> <!-- TODO: * [Understand the architecture →](../explanation/clan-architecture.md) -->

2
docs/site/guides/getting-started/add-services.md
View File

@@ -41,7 +41,7 @@ To learn more: [Guide about clanService](../clanServices.md)
``` ```
1. See [reference/clanServices](../../reference/clanServices/index.md) for all available services and how to configure them. 1. See [reference/clanServices](../../reference/clanServices/index.md) for all available services and how to configure them.
Or read [authoring/clanServices](../authoring/clanServices/index.md) if you want to bring your own Or read [authoring/clanServices](../../developer/extensions/clanServices/index.md) if you want to bring your own
2. Replace `__YOUR_CONTROLLER_` with the *name* of your machine. 2. Replace `__YOUR_CONTROLLER_` with the *name* of your machine.

2
docs/site/guides/getting-started/index.md
View File

@@ -125,7 +125,7 @@ To change the name of your clan edit `meta.name` in the `clan.nix` or `flake.nix
You can continue with **any** of the following steps at your own pace: You can continue with **any** of the following steps at your own pace:
- [x] [Install Nix & Clan CLI](./index.md) - [x] [Install Nix & Clan CLI](./index.md)
- [x] [Initialize Clan](./index.md#initialize-your-project) - [x] [Initialize Clan](./index.md#add-clan-cli-to-your-shell)
- [ ] [Create USB Installer (optional)](./installer.md) - [ ] [Create USB Installer (optional)](./installer.md)
- [ ] [Add Machines](./add-machines.md) - [ ] [Add Machines](./add-machines.md)
- [ ] [Add a User](./add-user.md) - [ ] [Add a User](./add-user.md)

4
docs/site/guides/migrations/migrate-inventory-services.md
View File

@@ -1,7 +1,7 @@
# Migrating from using `clanModules` to `clanServices` # Migrating from using `clanModules` to `clanServices`
**Audience**: This is a guide for **people using `clanModules`**. **Audience**: This is a guide for **people using `clanModules`**.
If you are a **module author** and need to migrate your modules please consult our **new** [clanServices authoring guide](../authoring/clanServices/index.md) If you are a **module author** and need to migrate your modules please consult our **new** [clanServices authoring guide](../../developer/extensions/clanServices/index.md)
## What's Changing? ## What's Changing?
@@ -329,6 +329,6 @@ instances = {
## Further reference ## Further reference
* [Authoring a 'clan.service' module](../authoring/clanServices/index.md) * [Authoring a 'clan.service' module](../../developer/extensions/clanServices/index.md)
* [ClanServices](../clanServices.md) * [ClanServices](../clanServices.md)
* [Inventory Reference](../../reference/nix-api/inventory.md) * [Inventory Reference](../../reference/nix-api/inventory.md)

2
docs/site/index.md
View File

@@ -38,7 +38,7 @@ hide:
Use Clan with [https://flake.parts/]() Use Clan with [https://flake.parts/]()
- [Contribute](./guides/contributing/CONTRIBUTING.md) - [Contribute](./developer/contributing/CONTRIBUTING.md)
--- ---

6
lib/modules/inventoryClass/interface.nix
View File

@@ -142,7 +142,7 @@ in
- The module MUST have at least `features = [ "inventory" ]` in the frontmatter section. - The module MUST have at least `features = [ "inventory" ]` in the frontmatter section.
- The module MUST have a subfolder `roles` with at least one `{roleName}.nix` file. - The module MUST have a subfolder `roles` with at least one `{roleName}.nix` file.
For further information see: [Module Authoring Guide](../../guides/authoring/clanServices/index.md). For further information see: [Module Authoring Guide](../../developer/extensions/clanServices/index.md).
???+ example ???+ example
```nix ```nix
@@ -179,8 +179,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/guides/clanServices/ See: https://docs.clan.lol/developer/extensions/clanServices/
And: https://docs.clan.lol/guides/authoring/clanServices/ And: https://docs.clan.lol/developer/extensions/clanServices/
'' moduleSet; '' moduleSet;
}; };