hsjobeki
56f3fd0a45
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
21f87f169a
Docs: improve clanService docs
2025-05-16 14:58:46 +02:00
pinpox
8220c32142
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
cc20e0bf35
clan-ui: remove intermediate app directory
2025-05-15 14:56:04 +02:00
Jörg Thalheim
2561e3e4d1
rename ui to clan-app and move clan-app one layer up
2025-05-15 14:15:59 +02:00
Brian McGee
c26cc9503c
feat: group ui related packages under a ui directory
2025-05-15 12:00:24 +01:00
Jörg Thalheim
028a401931
docs/devshell: make sure we are in the right directory before symlinking files
2025-05-13 12:24:20 +02:00
Jonathan Thiessen
839f8fb347
Avoid a few cases of chmod-after-creation
2025-04-28 17:11:21 -07:00
Johannes Kirschbauer
acbe619883
Refactor(clan_lib): move clan_cli.api into clan_lib.api
2025-04-26 19:51:35 +02:00
Johannes Kirschbauer
a6a79e83a0
treewide(clanLib): rename all occurences of {clan-core,self}.lib to 'clanLib'
2025-04-09 11:32:46 +02:00
Sam Lehman
e0a6ed3d49
devshells: name shells for clarity
2025-04-08 19:31:30 +00:00
Johannes Kirschbauer
ce84c4cddb
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
c25574bebd
fix(lib/evalClan): evalClan is an explizit lib attribute
2025-03-30 17:07:11 +02:00
Jörg Thalheim
873f650678
remove directory = self from our documentation
2025-02-15 01:48:17 +00:00
DavHau
3ec028d672
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
e2aa66d86f
reformat after update
2025-01-14 15:30:29 +01:00
Johannes Kirschbauer
01adae4f3d
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
00064ee98b
wifi: init as experimental module
2024-11-28 15:49:23 +07:00
Johannes Kirschbauer
200cffe4ee
Docs/modules: add missing heading for empty role options
2024-11-20 12:25:04 +01:00
Johannes Kirschbauer
25e2307ecc
Docs/modules: add usage example
2024-11-20 11:42:02 +01:00
Johannes Kirschbauer
6e61db7f83
Docs/modules: seperate out inventory,role specific interface
2024-11-20 11:01:28 +01:00
Johannes Kirschbauer
8544387d65
Docs/frontmatter: init automatic reference for frontmatter
2024-11-19 10:35:13 +01:00
Qubasa
09e0d8add3
docs: Remove old blog, remove empty concepts rider
2024-11-18 17:25:47 +01:00
Johannes Kirschbauer
417db1e1e8
Docs: fix missing icons & favicon
2024-11-06 13:56:20 +01:00
Jörg Thalheim
4cc9fcfc77
deploy-docs: use checksum for rsync
2024-10-22 17:41:54 +02:00
Jörg Thalheim
76cdd4cc93
deploy-docs: improve tempdir handling for ssh key
2024-10-22 15:37:01 +00:00
a-kenji
db1cf8ec15
docs: fix typos
2024-10-16 22:55:31 +02:00
Jörg Thalheim
aad4032626
use evalClanModules in get-module-docs
2024-10-09 14:48:41 +02:00
Johannes Kirschbauer
c965032a6f
Docs: minor improvements
2024-10-09 09:38:31 +02:00
Johannes Kirschbauer
1b77b118e2
docs: improve flake-parts reference
2024-10-01 11:21:30 +02:00
Johannes Kirschbauer
da5bda4c82
Docs: autogenerate inventory & buildClan model
2024-09-25 13:38:10 +02:00
Johannes Kirschbauer
8e7e346b28
Docs: add top-level index, refactor according to diataxis
2024-09-22 18:39:13 +02:00
Qubasa
3d1f97f2a4
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
cfa1fca76e
Inventory: docs fixup
2024-09-18 08:31:00 +02:00
Johannes Kirschbauer
18fa2cc8a4
Inventory: fix doc typo
2024-09-16 22:52:40 +02:00
Johannes Kirschbauer
56b76f9827
Inventory: docs improvements
2024-09-16 22:52:40 +02:00
Johannes Kirschbauer
7c0d87c5b1
ClanModules: make all module available to inventory
2024-09-13 17:18:20 +02:00
Jörg Thalheim
f18771364c
get rid of ValueError
2024-09-03 18:14:31 +02:00
Jörg Thalheim
0de5dea92a
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
Jörg Thalheim
af0a1dd3f2
use pathlib
2024-09-02 17:40:05 +02:00
Jörg Thalheim
15ff74f7c2
enable ASYNC, DTZ, YTT and EM lints
2024-09-02 14:07:06 +02:00
Johannes Kirschbauer
b015f1f123
PropagatedBuild inputs workaround
2024-07-26 15:23:25 +02:00
Johannes Kirschbauer
67b76c8ced
Docs: generate api docs for inventory
2024-07-19 11:07:47 +02:00
Valentin Gagarin
13b8b949f9
docs: add reference index pages
...
- add index pages for each reference documentation category
- move concepts pages into the reference hierarchy
- render clanModules overview page in the style of the CLI overview
2024-07-19 10:27:04 +02:00
Jörg Thalheim
29616a8b5d
fix mkdocs-rss-plugin deps
2024-07-08 16:24:34 +02:00
Jörg Thalheim
bd8515fa59
treefmt: upgrade nixfmt options
2024-07-08 16:24:34 +02:00
DavHau
802f047341
devShells: make all shells inherit from default shell
...
Currently, important tools from the default shell are lost as soon as select-shell is used to switch to another shell. select-shell itself, for example is missing, which makes it impossible to switch back to another shell.
2024-07-05 15:01:25 +07:00
DavHau
208021ee1c
reference docs: add missing description fields and enforce it from now on
2024-07-04 13:34:55 +07:00
DavHau
85a9d82132
vars: import by default & fix option rendering
2024-07-04 13:12:29 +07:00
Johannes Kirschbauer
74dd48320e
ClanModules: Add docs and api to retrieve metadata
2024-06-25 21:17:42 +02:00
