Brian McGee
9d6dfbd3e9
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
7493ab3e59
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
b0d8d1f195
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
6c8d2d3cb5
docs(inventory/instances): init guide for setting up the new service model
2025-04-04 14:22:35 +02:00
Jörg Thalheim
f1cd85f281
docs/secrets: mention defaultGroups option
2025-04-03 14:02:05 +02:00
hsjobeki
1d60f94cc5
Merge pull request 'docs/configure: Remove reference to unfinished feature' ( #3097 ) from kenji/clan-core:docs-remove-upcoming into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3097
2025-03-25 18:12:09 +00:00
Mic92
ccb5af9565
Merge pull request 'docs/index: Clear up API Reference description' ( #3098 ) from kenji/clan-core:docs-overview into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3098
2025-03-25 09:34:18 +00:00
a-kenji
709d773768
docs/configure: Fix erroneous option attribute
...
Fixes: 3094
2025-03-22 13:05:55 -07:00
a-kenji
845abd1356
docs/index: Clear up API Reference description
...
The term "auto generated" gives leeway to the incorrect assumption
that this is not a curated reference that contains written documentation
especially for the rendered reference.
This is not the case.
2025-03-22 12:56:51 -07:00
a-kenji
2b4a4f2422
docs/configure: Remove reference to unfinished feature
2025-03-22 12:53:59 -07:00
DavHau
33abb7ecd7
docs: add guide for testing
2025-03-19 09:43:05 +00:00
DavHau
30d19d088f
docs: move contributing+debugging to section contributing
2025-03-11 15:19:46 +07:00
a-kenji
91a19d9ea9
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
a-kenji
4222f9788c
docs/site: Fix flake-parts link
2025-03-03 03:53:49 +00:00
a-kenji
bc239e104c
docs/guide: Mention alternative secret store backends
2025-02-27 09:58:00 +00:00
a-kenji
3e0cd4bdfb
docs/guide: Deduplicate machine instructions
2025-02-27 09:56:52 +00:00
a-kenji
dfb5e5123f
docs/guide: Add devshell recommendation to getting started
...
Fixes : #2218
2025-02-25 18:16:50 +00:00
Jörg Thalheim
b0760bc2b9
recommend vars over facts
2025-02-22 03:34:40 +00:00
Qubasa
8ac286bcaf
docs: Fix install documentation
2025-02-19 14:23:45 +07:00
Qubasa
6c8137d30b
docs: Fix multiple issues with the clan installation guide
2025-02-18 17:40:27 +07:00
a-kenji
c3013c1a02
docs/mesh-vpn: Document inventory usage
2025-02-16 13:32:42 +07:00
a-kenji
3cff6577da
docs: Extend backups guide
...
Closes #2792
2025-02-16 13:04:53 +07:00
Jörg Thalheim
873f650678
remove directory = self from our documentation
2025-02-15 01:48:17 +00:00
Qubasa
35aedddf65
docs: Add --refresh flag to nix shell command to mitigate caching issues
2025-02-14 13:28:21 +07:00
Qubasa
de3153259d
clan-cli: Fix garbled clan vms run output. docs: Improve debugging guide
2025-02-13 16:17:55 +07:00
Sacha Korban
c0f07afb98
docs: disc-encryption: change guide to use phases option and misc improvements
2025-02-13 17:10:07 +11:00
OliverNChalk
50924ad7ff
docs: fix git rm step in Add Machines
2025-02-11 09:41:25 +11:00
Michael Hoang
5314eb4cfa
blog: actually remove asciicinema player
2025-02-04 15:48:12 +07:00
a-kenji
dfdcad7fc5
Fix various typos
2025-01-22 13:26:58 +01:00
Qubasa
3ffefc3064
clan: revert imports.nix and wait till tuesday
2025-01-18 20:21:49 +07:00
Qubasa
65bd3a9ac6
docs: Rename mentions of inventory module to clanModule with inventory support
2025-01-18 10:17:20 +07:00
Qubasa
0d2ee39746
Reapply "docs: Document imports dir. Remove What's next sections everywhere. Merge guide overview and hompage view."
...
This reverts commit b19beb8913
2025-01-18 10:00:56 +07:00
Jörg Thalheim
b19beb8913
Revert "docs: Document imports dir. Remove What's next sections everywhere. Merge guide overview and hompage view."
...
This reverts commit d4305f8b3c
2025-01-17 15:44:44 +01:00
Qubasa
d4305f8b3c
docs: Document imports dir. Remove What's next sections everywhere. Merge guide overview and hompage view.
2025-01-17 21:03:25 +07:00
Jörg Thalheim
c4a1e3ec95
switch to nixos-facter for hardware-config
2025-01-15 13:59:49 +00:00
Kierán Meinhardt
ca2d7e9afc
docs: fix dev shell in migration guide
2025-01-15 10:35:30 +00:00
DavHau
2dfff1b314
docs/vars: fix syntax error
2025-01-15 13:21:50 +07:00
Pablo Ovelleiro Corral
af3f652011
docs: set sidebar headers to accent color
...
Fixes #2749
2025-01-14 23:24:49 +01:00
a-kenji
16e6b0d406
docs(installer): Fix typography and align headers
2025-01-14 16:42:36 +00:00
Jörg Thalheim
479d89f9f0
link to migration guide
2025-01-14 15:18:11 +01:00
Johannes Kirschbauer
819e66c2da
Docs: change navigation to use sidebar sections only
2025-01-14 12:31:45 +00:00
Pablo Ovelleiro Corral
ae7e9e75a9
minor fixes
2025-01-13 21:37:01 +01:00
pinpox
26d286a234
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
9df9e97970
vars: fix formatting in guide
2025-01-11 20:17:16 +07:00
DavHau
afa03bc8d7
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
baeb31c228
Docs: add inventory concept introduction
2025-01-10 13:15:58 +01:00
Qubasa
5b51950e6d
docs: Add debugging.md and repo-layout.md guides
2025-01-09 13:01:49 +00:00
Johannes Kirschbauer
60d7941475
Docs/drafts: remove unused drafts, {HardwareInstallation,SecretCLI}
2025-01-07 09:14:03 +01:00
Johannes Kirschbauer
807ab37c2e
Docs: fix all broken anchor references
2024-12-31 15:43:20 +01:00
Johannes Kirschbauer
318a4f2d86
Chore: init settings submdule, move clanDir into settings submodule
2024-12-31 14:18:09 +01:00
