Commit Graph

42 Commits

Author SHA1 Message Date
Johannes Kirschbauer
a3f4a96c79 Docs: init empty migration guide with references 2025-05-12 16:13:08 +02:00
Johannes Kirschbauer
485b6ae5c4 docs(authoring): restructure authoring guides
Mainly because we have two module specs now and they will remain
valid for a while. We need to keep the older format documented for a while
2025-04-08 21:32:19 +02:00
Johannes Kirschbauer
e6312601a5 docs(inventory): improve extendSettings docs 2025-04-08 15:46:13 +02:00
Johannes Kirschbauer
d472f0a174 doc(inventory): document experimental settings vendoring 2025-04-08 15:24:12 +02:00
Brian McGee
d1f640b145 fix(docs): add the requirement to export clan.templates in flake outputs to migration guide 2025-04-08 10:44:36 +01:00
Brian McGee
8f290c08b7 fix(docs): correct flake sample in migration guide
diff --git a/docs/site/manual/migration-guide.md b/docs/site/manual/migration-guide.md
index 551a3ef0..38be9a0e 100644
--- a/docs/site/manual/migration-guide.md
+++ b/docs/site/manual/migration-guide.md
@@ -77,13 +77,18 @@ For the provide flake example, your flake should now look like this:
 ```nix
 {
   inputs.nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+
+  inputs.clan-core = {
+    url = "git+https://git.clan.lol/clan/clan-core";
+    inputs.nixpkgs.follows = "nixpkgs";
+  };

-  outputs = { self, nixpkgs, ... }:
+  outputs = { self, nixpkgs, clan-core, ... }:
   let
     clan = clan-core.lib.buildClan {
         self = self; # this needs to point at the repository root
         specialArgs = {};
-        inventory.meta.name = "NEEDS_TO_BE_UNIQUE"; # TODO: Changeme
+        meta.name = throw "Change me to something unique";

         machines = {
             berlin = {
2025-04-08 10:44:33 +01:00
hsjobeki
d15ac22d41 Merge pull request 'chore(lib/select): move into subfolder with a test file' (#3175) from hsjobeki/clan-core:lib-cleanup into main
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3175
2025-04-04 12:32:32 +00:00
Johannes Kirschbauer
64e444d4cf docs(inventory/instances): init guide for setting up the new service model 2025-04-04 14:22:35 +02:00
Jörg Thalheim
1fc2dd072b docs/secrets: mention defaultGroups option 2025-04-03 14:02:05 +02:00
DavHau
188c5dfb17 docs: move contributing+debugging to section contributing 2025-03-11 15:19:46 +07:00
a-kenji
db2530e0cd docs/repo-layout: Remove infra section
Remove the public infra section, as it uses a bit of unfortunate
wording. It suggests we would add anyone to our infrastructure as an
admin.
2025-03-03 11:34:45 +00:00
Jörg Thalheim
5d42aa2f42 remove directory = self from our documentation 2025-02-15 01:48:17 +00:00
Qubasa
ca946408f4 clan-cli: Fix garbled clan vms run output. docs: Improve debugging guide 2025-02-13 16:17:55 +07:00
a-kenji
673935785d Fix various typos 2025-01-22 13:26:58 +01:00
Qubasa
593f49abcc clan: revert imports.nix and wait till tuesday 2025-01-18 20:21:49 +07:00
Qubasa
3e4770add6 docs: Rename mentions of inventory module to clanModule with inventory support 2025-01-18 10:17:20 +07:00
Qubasa
030b046552 Reapply "docs: Document imports dir. Remove What's next sections everywhere. Merge guide overview and hompage view."
This reverts commit ba517f56b3.
2025-01-18 10:00:56 +07:00
Jörg Thalheim
ba517f56b3 Revert "docs: Document imports dir. Remove What's next sections everywhere. Merge guide overview and hompage view."
This reverts commit 257e1893ee.
2025-01-17 15:44:44 +01:00
Qubasa
257e1893ee docs: Document imports dir. Remove What's next sections everywhere. Merge guide overview and hompage view. 2025-01-17 21:03:25 +07:00
Kierán Meinhardt
1e8620017d docs: fix dev shell in migration guide 2025-01-15 10:35:30 +00:00
DavHau
628e893f36 docs/vars: fix syntax error 2025-01-15 13:21:50 +07:00
Pablo Ovelleiro Corral
74c1ac7664 minor fixes 2025-01-13 21:37:01 +01:00
pinpox
7ccc9f52b6 migration-guide (#2717)
This PR adds a migration guide for existing NixOS configurations.

Co-authored-by: Pablo Ovelleiro Corral <mail@pablo.tools>
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/2717
Co-authored-by: pinpox <clan@pablo.tools>
Co-committed-by: pinpox <clan@pablo.tools>
2025-01-11 20:38:08 +00:00
DavHau
54535a0da0 vars: fix formatting in guide 2025-01-11 20:17:16 +07:00
DavHau
aa175d9682 vars: add guide for using vars to manage shared passwords
This could be extended forther to cover more features, but it is a start
2025-01-11 20:01:47 +07:00
Johannes Kirschbauer
0066eb2b45 Docs: add inventory concept introduction 2025-01-10 13:15:58 +01:00
Qubasa
3d0b2948f3 docs: Add debugging.md and repo-layout.md guides 2025-01-09 13:01:49 +00:00
Johannes Kirschbauer
a87d0fcf92 Docs: add permanent footer with prev/next buttons 2024-12-20 19:13:55 +01:00
lassulus
70ff7fcc2f vars: allow setting files as needed for activation 2024-12-19 13:05:05 +01:00
Michael Hoang
4a05f8dd6c docs: update Adding Machines guide 2024-12-11 14:35:44 +11:00
Johannes Kirschbauer
d1f624ad1f api/disk-templates: adopt directory structure from clan modules 2024-12-03 12:01:35 +01:00
Johannes Kirschbauer
4462005fda Docs: add/improve autloaded machine files section 2024-11-29 21:49:57 +01:00
Qubasa
9aa4a81a91 docs: Remove old blog, remove empty concepts rider 2024-11-18 17:25:47 +01:00
Johannes Kirschbauer
08d26b9463 Inventory/schemas: move all schemas to legacyPackages 2024-10-09 13:27:09 +02:00
Johannes Kirschbauer
47b9a1cb7f docs: improve flake-parts reference 2024-10-01 11:21:30 +02:00
Johannes Kirschbauer
026481f9d7 Docs: harmonize titles 2024-09-25 14:06:55 +02:00
Johannes Kirschbauer
a67fb750cf Docs: fixup links 2024-09-25 13:46:12 +02:00
Johannes Kirschbauer
60ddd3369e Docs: restructure apply diataxis 2024-09-25 13:37:35 +02:00
Jörg Thalheim
cd67a5dc53 docs: renaming "Include Machines" to "Adding Machines" 2024-09-24 12:52:53 +02:00
Johannes Kirschbauer
30711a3d6d Docs: clarify inventory statement 2024-09-22 18:46:39 +02:00
Johannes Kirschbauer
55526b1fdb Docs: add top-level index, refactor according to diataxis 2024-09-22 18:39:13 +02:00
Qubasa
036cd710e1 docs: Rename guides to manual, Rename reference to options, add secure boot chapter to manual. Add secrets chapter to manual. 2024-09-20 16:52:52 +02:00