Commit Graph

438 Commits

Author SHA1 Message Date
DavHau
7a4eeb5b16 docs: explain about simplified way of specifying instances 2025-06-30 10:27:37 +00:00
Jörg Thalheim
97e52a6946 markdown: ignore trailing whitespace 2025-06-27 16:26:39 +02:00
Johannes Kirschbauer
731de62876 docs: rename all references from 'buildClan' to 'lib.clan' 2025-06-27 09:54:23 +02: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
a-kenji
17f0d9b6d3 docs/testing: Improve testing documentation 2025-06-18 11:12:30 +02:00
DavHau
d37c7c4c05 buildClan function: export all machines via nixosModules/darwinModules
We want each machine not only to be exposed via nixosConfigurations but also as a module.
This allows re-importing the machine in tests and override the architecture for example.
2025-06-09 12:51:22 +00:00
lassulus
8ce860f0d3 Revert "clan-cli: Use Remote class in DeployInfo, add tests for qrcode parser and json parser"
This reverts commit b1ef5f00bf.
2025-06-09 11:28:15 +02:00
Qubasa
b1ef5f00bf clan-cli: Use Remote class in DeployInfo, add tests for qrcode parser and json parser 2025-06-07 00:51:24 +02:00
Luis Hebendanz
e4b7462551 Merge pull request 'fix the infoboxes not rendering correctly' (#3885) from RuboGubo/clan-core:main into main
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3885
2025-06-06 21:34:08 +00:00
RuboGubo
7d930d15fd fix the infoboxes not rendering correctly 2025-06-06 20:54:14 +01:00
Jeremy Fleischman
d2b8307e77 Add a note about giving the Zerotier network a better name
It's *very* easy to miss the "default" in the following code snippet.

It's quite useful to have a non-"default" Zerotier network name, for
example, when configuring data-mesher, you need to specify the
`network.interface` setting.
2025-06-05 13:21:48 -07:00
Johannes Kirschbauer
6e7b2f94e5 docs: expose clan service authoring interface 2025-06-04 12:43:03 +02:00
Mic92
7050db796a Merge pull request 'Add warning note for users on cloud machines' (#3806) from RuboGubo/clan-core:main into main
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3806
2025-06-04 10:09:19 +00:00
Johannes Kirschbauer
13ab73873f Fix(docs): fix broken link to decision 2025-06-04 09:11:02 +02:00
RuboGubo
0046af127b remove unnecessary note and re-work requirements 2025-06-03 14:31:34 +01:00
RuboGubo
8fcb4b202e Add warning note for users on cloud machines 2025-05-31 20:10:10 +01:00
DavHau
f58a729c43 vars: fix spelling in docs 2025-05-31 11:13:17 +07:00
Michael Hoang
04185a168f docs: clarify when to override the nixpkgs input of clan-core
To match 9643548fff/docs/site/guides/migrations/migration-guide.md (L54-L55)
2025-05-27 22:48:08 +10:00
Michael Hoang
b6d20a63f5 docs: point users towards passing in self to buildClan 2025-05-27 13:49:14 +10:00
Guilhem Saurel
2a67fd8935 typo 2025-05-25 17:36:14 +02:00
Michael Hoang
faba92206d docs: format code blocks in migration guide 2025-05-22 14:12:40 +10:00
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
d5c3b45404 Fix(docs): rename reference to clan.core 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
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
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