Michael Hoang
4641bb8e94
docs: clean up flake-parts guide
2025-05-22 14:12:40 +10:00
Michael Hoang
508bb14809
docs: misc clean up
2025-05-22 00:01:01 +10:00
hsjobeki
f470ebce1a
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
2ba110d354
docs: exclude options that are not modules from clan.core submodule index
2025-05-21 09:11:18 +02:00
Johannes Kirschbauer
464e3c33cf
Docs: add links to submodules
2025-05-20 18:49:35 +02:00
Johannes Kirschbauer
d5c3b45404
Fix(docs): rename reference to clan.core
2025-05-20 18:49:35 +02:00
Johannes Kirschbauer
7d88389390
Refactor(docs): consistent structure across references
2025-05-20 18:49:35 +02:00
Johannes Kirschbauer
8ad35c1bee
docs: fix clan-core should be called clan.core
...
Consistent with the module name
2025-05-20 18:49:35 +02:00
Johannes Kirschbauer
3c56ae1755
docs: consistent clan-core overview
2025-05-20 18:49:35 +02:00
Jörg Thalheim
46ef84a33e
docs/macos: replace duplicate section
2025-05-20 18:48:36 +02:00
lassulus
19f8da397c
ADR: init 05-deployment-parameters
2025-05-20 16:22:52 +02:00
lassulus
7175fb74b4
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
348a7d24f5
ADR: add decision for nix-select
2025-05-20 15:26:53 +02:00
Jörg Thalheim
575f5b6626
add documentation on how to use macOS
2025-05-20 12:56:02 +02:00
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
hsjobeki
aaafde59cf
Merge pull request 'Docs: init migration guide for clanServices' ( #3679 ) from service-docs into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3679
2025-05-16 14:39:22 +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
hsjobeki
f1c028649d
Merge pull request 'Docs for clan service options' ( #3670 ) from service-docs into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3670
2025-05-16 13:02:28 +00:00
Johannes Kirschbauer
62d2c08dd5
Docs: improve clanService docs
2025-05-16 14:58:46 +02:00
pinpox
da3c1ceea3
Add clanServices to docs
...
Renders the documentation for clanServices. Options for the modules are
extracted and rendered the same way as for the existing clanModules.
Additionally tweaks the typography for the documentation of options
slightly
2025-05-16 11:29:50 +02:00
Jörg Thalheim
de0f78b0d2
clan-ui: remove intermediate app directory
2025-05-15 14:56:04 +02:00
Jörg Thalheim
57dcd47992
rename ui to clan-app and move clan-app one layer up
2025-05-15 14:15:59 +02:00
Brian McGee
faf8689ab1
feat: group ui related packages under a ui directory
2025-05-15 12:00:24 +01:00
pinpox
857950d373
add back old module for compatibility
2025-05-14 16:19:55 +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
Jörg Thalheim
6abfd87858
docs/devshell: make sure we are in the right directory before symlinking files
2025-05-13 12:24:20 +02: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
Johannes Kirschbauer
e2ab2fcfb3
Fix: update test and docs
2025-05-12 15:54:50 +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
Mic92
655c7e4eed
Merge pull request 'Avoid a few cases of chmod-after-creation' ( #3438 ) from tangential/clan-core:it-s_a_race into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3438
2025-05-04 07:08:43 +00: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
Jonathan Thiessen
9f745ff637
Avoid a few cases of chmod-after-creation
2025-04-28 17:11:21 -07:00
Johannes Kirschbauer
f6628ec1a9
Refactor(clan_lib): move clan_cli.api into clan_lib.api
2025-04-26 19:51:35 +02:00