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

Docs: move {flake, facts-vars} migration guides into 'migrations' folder

Browse Source
This commit is contained in:
Johannes Kirschbauer
2025-05-18 18:56:03 +02:00
parent 73d12e5aa3
commit a12afdb99f
4 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/mkdocs.yml
View File

@@ -60,7 +60,6 @@ nav:
- Backup & Restore: guides/backups.md - Backup & Restore: guides/backups.md
- Vars Backend: manual/vars-backend.md - Vars Backend: manual/vars-backend.md
- Facts Backend: manual/secrets.md - Facts Backend: manual/secrets.md
- Facts Vars Migration: manual/migration-facts-vars.md
- Autoincludes: manual/adding-machines.md - Autoincludes: manual/adding-machines.md
- Inventory: - Inventory:
- Inventory: manual/inventory.md - Inventory: manual/inventory.md
@@ -75,8 +74,9 @@ nav:
- Debugging: guides/contributing/debugging.md - Debugging: guides/contributing/debugging.md
- Testing: guides/contributing/testing.md - Testing: guides/contributing/testing.md
- Migrations: - 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 - Migrate inventory Services: guides/migrations/migrate-inventory-services.md
- Facts Vars Migration: guides/migrations/migration-facts-vars.md
- Reference: - Reference:
- Overview: reference/index.md - Overview: reference/index.md
- Clan Services: - Clan Services:

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

@@ -54,7 +54,7 @@ clan --help
### Step 2: Initialize Your Project ### 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: Set the foundation of your Clan project by initializing it as follows:

6
docs/site/manual/migration-facts-vars.md → docs/site/guides/migrations/migration-facts-vars.md
View File

@@ -2,10 +2,10 @@
For a high level overview about `vars` see our [blog post](https://clan.lol/blog/vars/). 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 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. 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 ## Keep Existing Values

2
docs/site/manual/migration-guide.md → docs/site/guides/migrations/migration-guide.md
View File

@@ -4,7 +4,7 @@ This guide will help you migrate your existing Nix configurations into Clan.
!!! Warning !!! Warning
Migrating instead of starting new can be trickier and might lead to bugs or 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! ## Back up your existing configuration!
Before you start, it is strongly recommended to back up your existing Before you start, it is strongly recommended to back up your existing