Commit Graph

90 Commits

Author SHA1 Message Date
Johannes Kirschbauer
0c8f23ed3e Chore: add _file for internals error tracing 2025-06-25 15:47:18 +02:00
Johannes Kirschbauer
0bb621f0f7 inventory/interface: reduce apply arguments chain by adding it to _module.args 2025-06-25 15:15:22 +02:00
DavHau
d9d1ab97a9 docs/devshell: unbreak - add options-page
Create the options-page subpage when the docs dev shell is loaded.

Also simplify the dev shell definition by just utilizing what's in configurePhase of the docs derivation
2025-06-25 13:48:50 +07:00
DavHau
12682b608c docs: add clan options search page
This provides a simpler and more intuitive search over a flat list of possible options.

Styling still to be improved
2025-06-25 12:55:25 +07:00
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
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
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
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
Johannes Kirschbauer
e37f16f47a treewide(clanLib): rename all occurences of {clan-core,self}.lib to 'clanLib' 2025-04-09 11:32:46 +02:00
Sam Lehman
4fe822b340 devshells: name shells for clarity 2025-04-08 19:31:30 +00:00
Johannes Kirschbauer
29fbf361a7 chore(lib/modulesDocs): move dependency on clan-core and pkgs into function args
This is a good idea, to make lib agnostic from clan-core
The next step could be to rename the clan-core argument name
Or to explizitly pass the actual dependencies, instead of everything in
clan-core
2025-04-08 15:30:49 +02:00
Johannes Kirschbauer
ec086c3323 fix(lib/evalClan): evalClan is an explizit lib attribute 2025-03-30 17:07:11 +02:00
Jörg Thalheim
5d42aa2f42 remove directory = self from our documentation 2025-02-15 01:48:17 +00:00
DavHau
5ce72dd261 tests: reduce unnecessary rebuilds of several tests
Some test were referring to the whole source code via ${self} which amde them rebuild on every single commit.

This is not mitigated by introduceing `self.filter { include = [...]; }` allowin to a content addressed subset of the source code in tests.
2025-01-17 17:00:18 +07: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
Qubasa
9aa4a81a91 docs: Remove old blog, remove empty concepts rider 2024-11-18 17:25:47 +01:00
Johannes Kirschbauer
571f36c345 Docs: fix missing icons & favicon 2024-11-06 13:56:20 +01:00
Jörg Thalheim
39d0c170c0 deploy-docs: use checksum for rsync 2024-10-22 17:41:54 +02:00
Jörg Thalheim
d1deed435c deploy-docs: improve tempdir handling for ssh key 2024-10-22 15:37:01 +00:00
a-kenji
c2992daef1 docs: fix typos 2024-10-16 22:55:31 +02:00
Jörg Thalheim
4ed264a8cb use evalClanModules in get-module-docs 2024-10-09 14:48:41 +02:00
Johannes Kirschbauer
3fe83eb9d8 Docs: minor improvements 2024-10-09 09:38: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