docs: move authoring guides into guides subfolder
This commit is contained in:
@@ -67,9 +67,9 @@ nav:
|
||||
- Secure Boot: manual/secure-boot.md
|
||||
- Flake-parts: manual/flake-parts.md
|
||||
- Authoring:
|
||||
- clan.service: authoring/clanServices/index.md
|
||||
- Disk Templates: authoring/templates/disk/disko-templates.md
|
||||
- clanModules: authoring/legacyModules/index.md
|
||||
- clanService: guides/authoring/clanServices/index.md
|
||||
- Disk Template: guides/authoring/templates/disk/disko-templates.md
|
||||
- clanModule: guides/authoring/clanModules/index.md
|
||||
- Contributing:
|
||||
- Contribute: contributing/contribute.md
|
||||
- Debugging: contributing/debugging.md
|
||||
|
||||
@@ -9,11 +9,11 @@ This site will guide you through authoring your first module. Explaining which c
|
||||
|
||||
|
||||
!!! Tip
|
||||
External ClanModules can be ad-hoc loaded via [`clan.inventory.modules`](../../reference/nix-api/inventory.md#inventory.modules)
|
||||
External ClanModules can be ad-hoc loaded via [`clan.inventory.modules`](../../../reference/nix-api/inventory.md#inventory.modules)
|
||||
|
||||
## 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](../../../manual/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.
|
||||
@@ -48,7 +48,7 @@ clanModules/borgbackup
|
||||
=== "User module"
|
||||
|
||||
If the module should be ad-hoc loaded.
|
||||
It can be made available in any project via the [`clan.inventory.modules`](../../reference/nix-api/inventory.md#inventory.modules) attribute.
|
||||
It can be made available in any project via the [`clan.inventory.modules`](../../../reference/nix-api/inventory.md#inventory.modules) attribute.
|
||||
|
||||
```nix title="flake.nix"
|
||||
# ...
|
||||
@@ -89,7 +89,7 @@ description = "Module A"
|
||||
This is the example module that does xyz.
|
||||
```
|
||||
|
||||
See the [Full Frontmatter reference](../../reference/clanModules/frontmatter/index.md) further details and all supported attributes.
|
||||
See the [Full Frontmatter reference](../../../reference/clanModules/frontmatter/index.md) further details and all supported attributes.
|
||||
|
||||
## Roles
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Authoring a 'clan.service' module
|
||||
|
||||
!!! Tip
|
||||
This is the successor format to the older [clanModules](../legacyModules/index.md)
|
||||
This is the successor format to the older [clanModules](../clanModules/index.md)
|
||||
|
||||
While some features might still be missing we recommend to adapt this format early and give feedback.
|
||||
|
||||
@@ -108,7 +108,7 @@ You can use services exposed by Clan’s core module library, `clan-core`.
|
||||
|
||||
You can also author your own `clanService` modules.
|
||||
|
||||
🔗 Learn how to write your own service: [Authoring a clanService](../authoring/clanServices/index.md)
|
||||
🔗 Learn how to write your own service: [Authoring a clanService](../guides/authoring/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.
|
||||
|
||||
@@ -124,6 +124,6 @@ You might expose your service module from your flake — this makes it easy for
|
||||
|
||||
## What’s Next?
|
||||
|
||||
* [Author your own clanService →](../authoring/clanServices/index.md)
|
||||
* [Author your own clanService →](../guides/authoring/clanServices/index.md)
|
||||
* [Migrate from clanModules →](../guides/migrate-inventory-services.md)
|
||||
<!-- TODO: * [Understand the architecture →](../explanation/clan-architecture.md) -->
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Migrating from using `clanModules` to `clanServices`
|
||||
|
||||
**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](../guides/authoring/clanServices/index.md)
|
||||
|
||||
## What's Changing?
|
||||
|
||||
@@ -142,6 +142,6 @@ roles.default.machines."test-inventory-machine".settings = {
|
||||
|
||||
## Further reference
|
||||
|
||||
* [Authoring a 'clan.service' module](../authoring/clanServices/index.md)
|
||||
* [Authoring a 'clan.service' module](../guides/authoring/clanServices/index.md)
|
||||
* [ClanServices](../guides/clanServices.md)
|
||||
* [Inventory Reference](../reference/nix-api/inventory.md)
|
||||
@@ -29,7 +29,7 @@ hide:
|
||||
|
||||
Create ressources that can be reused by the community.
|
||||
|
||||
[:octicons-arrow-right-24: Authoring guides](./authoring/legacyModules/index.md)
|
||||
[:octicons-arrow-right-24: Authoring guides](./guides/authoring/clanModules/index.md)
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@@ -126,7 +126,7 @@ in
|
||||
- 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.
|
||||
|
||||
For further information see: [Module Authoring Guide](../../authoring/clanServices/index.md).
|
||||
For further information see: [Module Authoring Guide](../../guides/authoring/clanServices/index.md).
|
||||
|
||||
???+ example
|
||||
```nix
|
||||
|
||||
Reference in New Issue
Block a user