Docs: create migrations subfolder in guides

This commit is contained in:
Johannes Kirschbauer
2025-05-18 18:46:36 +02:00
parent b35c1c2e46
commit f387ab0882
5 changed files with 11 additions and 10 deletions

View File

@@ -75,8 +75,9 @@ nav:
- Debugging: guides/contributing/debugging.md
- Testing: guides/contributing/testing.md
- Repo Layout: manual/repo-layout.md
- Migrations:
- Migrate existing Flakes: manual/migration-guide.md
- Migrate inventory Services: guides/migrate-inventory-services.md
- Migrate inventory Services: guides/migrations/migrate-inventory-services.md
- Reference:
- Overview: reference/index.md
- Clan Services:

View File

@@ -457,7 +457,7 @@ Each `clanService`:
!!! Note
`clanServices` are part of Clan's next-generation service model and are intended to replace `clanModules`.
See [Migration Guide](../../guides/migrate-inventory-services.md) for help on migrating.
See [Migration Guide](../../guides/migrations/migrate-inventory-services.md) for help on migrating.
Learn how to use `clanServices` in practice in the [Using clanServices guide](../../guides/clanServices.md).
"""

View File

@@ -125,5 +125,5 @@ You might expose your service module from your flake — this makes it easy for
## Whats Next?
* [Author your own clanService →](../guides/authoring/clanServices/index.md)
* [Migrate from clanModules →](../guides/migrate-inventory-services.md)
* [Migrate from clanModules →](../guides/migrations/migrate-inventory-services.md)
<!-- TODO: * [Understand the architecture →](../explanation/clan-architecture.md) -->

View File

@@ -54,7 +54,7 @@ clan --help
### Step 2: Initialize Your Project
If you want to migrate an existing project, follow this [guide](https://docs.clan.lol/manual/migration-guide/).
If you want to migrate an existing project, follow this [guide](../../manual/migration-guide.md).
Set the foundation of your Clan project by initializing it as follows:

View File

@@ -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](../guides/authoring/clanServices/index.md)
If you are a **module author** and need to migrate your modules please consult our **new** [clanServices authoring guide](../authoring/clanServices/index.md)
## What's Changing?
@@ -78,7 +78,7 @@ instances = {
### 1. Move `services` entries to `instances`
Check if a service that you use has been migrated [In our reference](../reference/clanServices/index.md)
Check if a service that you use has been migrated [In our reference](../../reference/clanServices/index.md)
In your inventory, move it from:
@@ -142,6 +142,6 @@ roles.default.machines."test-inventory-machine".settings = {
## Further reference
* [Authoring a 'clan.service' module](../guides/authoring/clanServices/index.md)
* [ClanServices](../guides/clanServices.md)
* [Inventory Reference](../reference/nix-api/inventory.md)
* [Authoring a 'clan.service' module](../authoring/clanServices/index.md)
* [ClanServices](../clanServices.md)
* [Inventory Reference](../../reference/nix-api/inventory.md)