diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index e028052d6..68b5f0b8a 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -75,8 +75,9 @@ nav: - Debugging: guides/contributing/debugging.md - Testing: guides/contributing/testing.md - Repo Layout: manual/repo-layout.md - - Migrate existing Flakes: manual/migration-guide.md - - Migrate inventory Services: guides/migrate-inventory-services.md + - Migrations: + - Migrate existing Flakes: manual/migration-guide.md + - Migrate inventory Services: guides/migrations/migrate-inventory-services.md - Reference: - Overview: reference/index.md - Clan Services: diff --git a/docs/nix/render_options/__init__.py b/docs/nix/render_options/__init__.py index 88a313f7e..c0843e106 100644 --- a/docs/nix/render_options/__init__.py +++ b/docs/nix/render_options/__init__.py @@ -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). """ diff --git a/docs/site/guides/clanServices.md b/docs/site/guides/clanServices.md index b7ebf187b..c34a5191a 100644 --- a/docs/site/guides/clanServices.md +++ b/docs/site/guides/clanServices.md @@ -125,5 +125,5 @@ You might expose your service module from your flake — this makes it easy for ## What’s 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) diff --git a/docs/site/guides/getting-started/index.md b/docs/site/guides/getting-started/index.md index a3072e737..25c647941 100644 --- a/docs/site/guides/getting-started/index.md +++ b/docs/site/guides/getting-started/index.md @@ -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: diff --git a/docs/site/guides/migrate-inventory-services.md b/docs/site/guides/migrations/migrate-inventory-services.md similarity index 91% rename from docs/site/guides/migrate-inventory-services.md rename to docs/site/guides/migrations/migrate-inventory-services.md index 89e6e12f6..f7100dbb8 100644 --- a/docs/site/guides/migrate-inventory-services.md +++ b/docs/site/guides/migrations/migrate-inventory-services.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](../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) \ No newline at end of file +* [Authoring a 'clan.service' module](../authoring/clanServices/index.md) +* [ClanServices](../clanServices.md) +* [Inventory Reference](../../reference/nix-api/inventory.md) \ No newline at end of file