Commit Graph

33 Commits

Author SHA1 Message Date
Johannes Kirschbauer
6e7b2f94e5 docs: expose clan service authoring interface 2025-06-04 12:43:03 +02:00
Johannes Kirschbauer
58a75e7f17 Fix(docs): dont link to assumed successor 2025-06-03 18:35:00 +02:00
pinpox
64c339dafe modules/borgbackup: migrate to clanServices
Migrates the borgbackup module to clanServices, preserving it's original
configuration syntax and functionality
2025-06-02 16:12:37 +02:00
Michael Hoang
508bb14809 docs: misc clean up 2025-05-22 00:01:01 +10: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
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
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
f387ab0882 Docs: create migrations subfolder in guides 2025-05-18 18:46:36 +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
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
Johannes Kirschbauer
f6628ec1a9 Refactor(clan_lib): move clan_cli.api into clan_lib.api 2025-04-26 19:51:35 +02:00
Jörg Thalheim
5d42aa2f42 remove directory = self from our documentation 2025-02-15 01:48:17 +00:00
Jörg Thalheim
3bcbc8fa3d reformat after update 2025-01-14 15:30:29 +01:00
Johannes Kirschbauer
d7c0ad40a2 Docs: refactor all option documentation to use tree representations
Using a tree instead of a list leads to better representation of options
In the future this could also enable better disvocerability by applying tree-specific filters and views
The OptionList should only be used as an exchange format between nix and rendering tools
2024-12-31 13:34:32 +01:00
DavHau
32332e8460 wifi: init as experimental module 2024-11-28 15:49:23 +07:00
Johannes Kirschbauer
d5c1d07556 Docs/modules: add missing heading for empty role options 2024-11-20 12:25:04 +01:00
Johannes Kirschbauer
d259da1a7b Docs/modules: add usage example 2024-11-20 11:42:02 +01:00
Johannes Kirschbauer
b3164076d5 Docs/modules: seperate out inventory,role specific interface 2024-11-20 11:01:28 +01:00
Johannes Kirschbauer
cfe9dbf117 Docs/frontmatter: init automatic reference for frontmatter 2024-11-19 10:35:13 +01:00
a-kenji
c2992daef1 docs: fix typos 2024-10-16 22:55:31 +02:00
Johannes Kirschbauer
47b9a1cb7f docs: improve flake-parts reference 2024-10-01 11:21:30 +02:00
Johannes Kirschbauer
aa30b17201 Docs: autogenerate inventory & buildClan model 2024-09-25 13:38:10 +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
Johannes Kirschbauer
9a24b1ee16 Inventory: docs fixup 2024-09-18 08:31:00 +02:00
Johannes Kirschbauer
3721fc4340 Inventory: fix doc typo 2024-09-16 22:52:40 +02:00
Johannes Kirschbauer
72f79dee37 Inventory: docs improvements 2024-09-16 22:52:40 +02:00
Johannes Kirschbauer
e889528ca0 ClanModules: make all module available to inventory 2024-09-13 17:18:20 +02:00
Jörg Thalheim
5ac3ac63c2 get rid of ValueError 2024-09-03 18:14:31 +02:00
Jörg Thalheim
9de48de991 put render-options not in the toplevel nix store path
on start python will do a listdir on the hole nix store otherwise
2024-09-02 17:47:00 +02:00