Michael Hoang
5bc6126873
docs: misc clean up
2025-05-22 00:01:01 +10:00
hsjobeki
15f0ea616c
Merge pull request 'Refactor(docs): consistent structure across references & fix broken cli links' ( #3724 ) from hsjobeki/clan-core:docs-3 into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3724
2025-05-21 07:23:16 +00:00
Johannes Kirschbauer
b1054e2ad2
Fix(docs): rename reference to clan.core
2025-05-20 18:49:35 +02:00
Johannes Kirschbauer
a9ed972834
docs: fix clan-core should be called clan.core
...
Consistent with the module name
2025-05-20 18:49:35 +02:00
Jörg Thalheim
6dab14c9d4
docs/macos: replace duplicate section
2025-05-20 18:48:36 +02:00
lassulus
e5f38db60f
ADR: init 05-deployment-parameters
2025-05-20 16:22:52 +02:00
lassulus
131c7ea263
Merge pull request 'ADR: add decision for nix-select' ( #3452 ) from select-adr into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3452
Reviewed-by: hsjobeki <hsjobeki@gmail.com >
2025-05-20 13:43:31 +00:00
lassulus
6b3509c3b1
ADR: add decision for nix-select
2025-05-20 15:26:53 +02:00
Jörg Thalheim
4f4c44c7d4
add documentation on how to use macOS
2025-05-20 12:56:02 +02:00
pinpox
6525b591e2
docs: add glossary
2025-05-19 11:41:00 +02:00
Johannes Kirschbauer
88f7b3410e
Docs: unify 'manual' with 'guides' folder
...
This is one of the final steps towards strictly following
https://diataxis.fr/
2025-05-18 20:40:40 +02:00
Johannes Kirschbauer
b36d641e71
Docs: move {flake, facts-vars} migration guides into 'migrations' folder
2025-05-18 18:56:03 +02:00
Johannes Kirschbauer
04146eeac9
Docs: remove useless repo-layout file
2025-05-18 18:49:29 +02:00
Johannes Kirschbauer
3051763cbf
Docs: remove dafts folder
2025-05-18 18:48:23 +02:00
Johannes Kirschbauer
df5010084f
Docs: create migrations subfolder in guides
2025-05-18 18:46:36 +02:00
Johannes Kirschbauer
e9278ceaba
Docs: place reference to new ClanModules on index page
2025-05-18 18:40:10 +02:00
Johannes Kirschbauer
0261a954de
Docs: move 'getting-started' into guides section
2025-05-18 18:35:11 +02:00
Johannes Kirschbauer
ad5bbdbee0
Docs: move {contributing, disk, mesh, backups} into guides
2025-05-18 18:22:32 +02:00
hsjobeki
1bcf5a82a6
Merge pull request 'refactor: move clan_cli.error to clan_lib.error' ( #3677 ) from hsjobeki/clan-core:chores-1 into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3677
2025-05-16 15:17:41 +00:00
Johannes Kirschbauer
9221231e89
docs: move authoring guides into guides subfolder
2025-05-16 16:33:39 +02:00
Johannes Kirschbauer
868db1e6f3
Docs: init migration guide for clanServices
2025-05-16 16:15:51 +02:00
Johannes Kirschbauer
f210b2f9a6
refactor: move clan_cli.error to clan_lib.error
2025-05-16 16:14:39 +02:00
Johannes Kirschbauer
21f87f169a
Docs: improve clanService docs
2025-05-16 14:58:46 +02:00
Johannes Kirschbauer
d825a3348b
docs(adrs): move decision folder into docs to make them publicly visible within docs
2025-05-14 10:06:24 +02:00
a-kenji
9f805b9e46
docs/index: Surface reference documentation
2025-05-13 10:51:22 +00:00
a-kenji
21aa95b139
docs/guides: Fix typos in migration guide
2025-05-13 10:33:23 +02:00
a-kenji
14969c5822
docs/guides: facts vars migration guide
...
Add a migration guide from facts to vars.
2025-05-13 08:10:32 +00:00
Johannes Kirschbauer
3c157c4a31
Docs: init empty migration guide with references
2025-05-12 16:13:08 +02:00
Jörg Thalheim
c0d2787dee
docs/testing: update to latest api
2025-05-12 13:03:06 +02:00
Johannes Kirschbauer
d5f90b2730
Docs: update 'clan.service' examples
2025-05-11 15:46:16 +02:00
a-kenji
4c1e346cf2
docs/reference: Improve wording of reference overview
...
There is no value in calling it "automatically extracted" - but it is
potentially misleading.
2025-04-30 10:19:12 +00:00
Brian McGee
a438fe77a7
feat: configure age plugins for SOPS in buildClan
2025-04-29 16:02:32 +10:00
Brian McGee
1694a977f1
feat: support age plugins
...
Extends how we parse the contents of `SOPS_AGE_KEY` / `SOPS_AGE_KEY_FILE` / `keys.txt`, allowing a user to prepend a comment before any `AGE-PLUGIN-` secret key entry to indicate its corresponding public key.
For example:
```
AGE-PLUGIN-FIDO2-HMAC-xxxxxxxxxxxxx
```
The comment can use any prefix (e.g. `# public key: age1xxxx`, `# recipient: age1xxx`) as we are looking directly for `age1xxxx` within the line.
This change is necessary to support `age` plugins as there is no unified mechanism to recover the public key from a plugin's secret key.
If a plugin secret key does not have a preceding public key comment, an error will be thrown when attempting to set a secret.
2025-04-29 15:47:54 +10:00
Jörg Thalheim
fe6fd41a4d
zerotier: migrate from facts to vars
2025-04-22 18:20:35 +02:00
Brian McGee
ed5fc20069
feat(clan-cli): support multiple keys for a user
2025-04-09 09:58:58 +00:00
Pablo Ovelleiro Corral
0d16ebf43e
Fix clan.service docs format
2025-04-09 08:29:19 +02:00
Johannes Kirschbauer
748cdb871e
docs(authoring/modules): add examples for dependency injection
2025-04-08 20:56:02 +00:00
Johannes Kirschbauer
b4f63b8835
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
1b3ce7ebd4
docs(inventory): improve extendSettings docs
2025-04-08 15:46:13 +02:00
Johannes Kirschbauer
97049d187c
doc(inventory): document experimental settings vendoring
2025-04-08 15:24:12 +02:00
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
