pinpox
dca118d057
docs: add glossary
2025-05-19 11:41:00 +02:00
Johannes Kirschbauer
af58c32238
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
a12afdb99f
Docs: move {flake, facts-vars} migration guides into 'migrations' folder
2025-05-18 18:56:03 +02:00
Johannes Kirschbauer
73d12e5aa3
Docs: remove useless repo-layout file
2025-05-18 18:49:29 +02:00
Johannes Kirschbauer
22f2f8ec6b
Docs: remove dafts folder
2025-05-18 18:48:23 +02:00
Johannes Kirschbauer
f387ab0882
Docs: create migrations subfolder in guides
2025-05-18 18:46:36 +02:00
Johannes Kirschbauer
b35c1c2e46
Docs: place reference to new ClanModules on index page
2025-05-18 18:40:10 +02:00
Johannes Kirschbauer
1806c6c16e
Docs: move 'getting-started' into guides section
2025-05-18 18:35:11 +02:00
Johannes Kirschbauer
7ff62958e6
Docs: move {contributing, disk, mesh, backups} into guides
2025-05-18 18:22:32 +02:00
hsjobeki
dce0ea4008
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
64bef5980f
docs: move authoring guides into guides subfolder
2025-05-16 16:33:39 +02:00
Johannes Kirschbauer
4ebdf021a3
Docs: init migration guide for clanServices
2025-05-16 16:15:51 +02:00
Johannes Kirschbauer
fe0507b47c
refactor: move clan_cli.error to clan_lib.error
2025-05-16 16:14:39 +02:00
Johannes Kirschbauer
62d2c08dd5
Docs: improve clanService docs
2025-05-16 14:58:46 +02:00
Johannes Kirschbauer
a1d2948914
docs(adrs): move decision folder into docs to make them publicly visible within docs
2025-05-14 10:06:24 +02:00
a-kenji
fb29d38883
docs/index: Surface reference documentation
2025-05-13 10:51:22 +00:00
a-kenji
3fc16c88f4
docs/guides: Fix typos in migration guide
2025-05-13 10:33:23 +02:00
a-kenji
35805204fb
docs/guides: facts vars migration guide
...
Add a migration guide from facts to vars.
2025-05-13 08:10:32 +00:00
Johannes Kirschbauer
a3f4a96c79
Docs: init empty migration guide with references
2025-05-12 16:13:08 +02:00
Jörg Thalheim
f30d57257a
docs/testing: update to latest api
2025-05-12 13:03:06 +02:00
Johannes Kirschbauer
abaa6d17f6
Docs: update 'clan.service' examples
2025-05-11 15:46:16 +02:00
a-kenji
e43ad8b217
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
651b277bb9
feat: configure age plugins for SOPS in buildClan
2025-04-29 16:02:32 +10:00
Brian McGee
1bfe318865
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
cbde58e1d8
zerotier: migrate from facts to vars
2025-04-22 18:20:35 +02:00
Brian McGee
aa4fe27e51
feat(clan-cli): support multiple keys for a user
2025-04-09 09:58:58 +00:00
Pablo Ovelleiro Corral
2987d7f504
Fix clan.service docs format
2025-04-09 08:29:19 +02:00
Johannes Kirschbauer
70ef74c8b7
docs(authoring/modules): add examples for dependency injection
2025-04-08 20:56:02 +00: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
hsjobeki
6da02e46b5
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
f136e8b945
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
a00377b7c1
docs/configure: Fix erroneous option attribute
...
Fixes: 3094
2025-03-22 13:05:55 -07:00
a-kenji
d7d8d55c45
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
9a9046c484
docs/configure: Remove reference to unfinished feature
2025-03-22 12:53:59 -07:00
DavHau
bc48a7a57c
docs: add guide for testing
2025-03-19 09:43:05 +00: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
a-kenji
d34f976057
docs/site: Fix flake-parts link
2025-03-03 03:53:49 +00:00
a-kenji
ea5f2ecce9
docs/guide: Mention alternative secret store backends
2025-02-27 09:58:00 +00:00
a-kenji
39ac630086
docs/guide: Deduplicate machine instructions
2025-02-27 09:56:52 +00:00
a-kenji
87d894c3ea
docs/guide: Add devshell recommendation to getting started
...
Fixes : #2218
2025-02-25 18:16:50 +00:00
Jörg Thalheim
5dc305a3f0
recommend vars over facts
2025-02-22 03:34:40 +00:00
Qubasa
f102e17633
docs: Fix install documentation
2025-02-19 14:23:45 +07:00
