From a12afdb99f7a82b29260c23cbbcf1791f4f848ae Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Sun, 18 May 2025 18:56:03 +0200 Subject: [PATCH] Docs: move {flake, facts-vars} migration guides into 'migrations' folder --- docs/mkdocs.yml | 4 ++-- docs/site/guides/getting-started/index.md | 2 +- .../{manual => guides/migrations}/migration-facts-vars.md | 6 +++--- docs/site/{manual => guides/migrations}/migration-guide.md | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) rename docs/site/{manual => guides/migrations}/migration-facts-vars.md (93%) rename docs/site/{manual => guides/migrations}/migration-guide.md (97%) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index b7f64648f..0b8340268 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -60,7 +60,6 @@ nav: - Backup & Restore: guides/backups.md - Vars Backend: manual/vars-backend.md - Facts Backend: manual/secrets.md - - Facts Vars Migration: manual/migration-facts-vars.md - Autoincludes: manual/adding-machines.md - Inventory: - Inventory: manual/inventory.md @@ -75,8 +74,9 @@ nav: - Debugging: guides/contributing/debugging.md - Testing: guides/contributing/testing.md - Migrations: - - Migrate existing Flakes: manual/migration-guide.md + - Migrate existing Flakes: guides/migrations/migration-guide.md - Migrate inventory Services: guides/migrations/migrate-inventory-services.md + - Facts Vars Migration: guides/migrations/migration-facts-vars.md - Reference: - Overview: reference/index.md - Clan Services: diff --git a/docs/site/guides/getting-started/index.md b/docs/site/guides/getting-started/index.md index 25c647941..b2bbc17c8 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](../../manual/migration-guide.md). +If you want to migrate an existing project, follow this [guide](../migrations/migration-guide.md). Set the foundation of your Clan project by initializing it as follows: diff --git a/docs/site/manual/migration-facts-vars.md b/docs/site/guides/migrations/migration-facts-vars.md similarity index 93% rename from docs/site/manual/migration-facts-vars.md rename to docs/site/guides/migrations/migration-facts-vars.md index 866c6b82d..10fef6def 100644 --- a/docs/site/manual/migration-facts-vars.md +++ b/docs/site/guides/migrations/migration-facts-vars.md @@ -2,10 +2,10 @@ For a high level overview about `vars` see our [blog post](https://clan.lol/blog/vars/). -This guide will help you migrate your modules that still use our [`facts`](../manual/secrets.md) backend -to the [`vars`](../manual/vars-backend.md) backend. +This guide will help you migrate your modules that still use our [`facts`](../../manual/secrets.md) backend +to the [`vars`](../../manual/vars-backend.md) backend. -The `vars` [module](../reference/clan-core/vars.md) and the clan [command](../reference/cli/vars.md) work in tandem, they should ideally be kept in sync. +The `vars` [module](../../reference/clan-core/vars.md) and the clan [command](../../reference/cli/vars.md) work in tandem, they should ideally be kept in sync. ## Keep Existing Values diff --git a/docs/site/manual/migration-guide.md b/docs/site/guides/migrations/migration-guide.md similarity index 97% rename from docs/site/manual/migration-guide.md rename to docs/site/guides/migrations/migration-guide.md index c19c7b7dd..601cc852b 100644 --- a/docs/site/manual/migration-guide.md +++ b/docs/site/guides/migrations/migration-guide.md @@ -4,7 +4,7 @@ This guide will help you migrate your existing Nix configurations into Clan. !!! Warning Migrating instead of starting new can be trickier and might lead to bugs or - unexpected issues. We recommend following the [Getting Started](../guides/getting-started/index.md) guide first. Once you have a working setup, you can easily transfer your Nix configurations over. + unexpected issues. We recommend following the [Getting Started](../getting-started/index.md) guide first. Once you have a working setup, you can easily transfer your Nix configurations over. ## Back up your existing configuration! Before you start, it is strongly recommended to back up your existing