Commit Graph

58 Commits

Author SHA1 Message Date
DavHau
969b7606a6 reverting 4c2bb0791d 2025-07-04 10:35:30 +07:00
Johannes Kirschbauer
e0993559db docs: add zerotier debugging commands 2025-07-03 16:25:10 +02:00
Johannes Kirschbauer
b27ed51284 docs: update vpn setup instructions 2025-07-03 12:04:56 +02:00
Johannes Kirschbauer
a81701b59a docs: fix wrong roles assignment syntax 2025-07-03 11:42:26 +02:00
hsjobeki
b2e8b8bf59 Merge pull request 'clan.deployment: unify deprecated options' (#4184) from cli-fix into main
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4184
2025-07-02 16:48:19 +00:00
Johannes Kirschbauer
4c2bb0791d clan.deployment: unify deprecated option 2025-07-02 18:37:29 +02:00
Johannes Kirschbauer
fb5dca567e docs/secrets: setup move plugins section to the bottom. Normal users don't have that, smart people read from bottom up 2025-07-02 18:23:48 +02:00
Johannes Kirschbauer
58c9c929ba docs/index: add progress tracker, encourage non-linear flow 2025-07-02 17:02:16 +02:00
Johannes Kirschbauer
58862215ab docs: rephrase add machines for planned dynamic templates 2025-07-02 17:01:40 +02:00
Johannes Kirschbauer
0bd4074927 docs: clarify project structure exploration in Getting Started 2025-07-02 16:32:30 +02:00
Johannes Kirschbauer
faf6ac82eb docs: remove api reference build command 2025-07-02 15:53:48 +02:00
Johannes Kirschbauer
6c7beb7aaa docs: remove step numbers
Numerating steps is not informative and considered bad style
People tend to follow documentation non-linearly
leaving of at one point, starting over from the middle
Documentation should be written in a way that allow for that
2025-07-02 15:53:24 +02:00
hsjobeki
847f8363f3 Merge pull request 'Docs: getting started add services' (#4156) from doc into main
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4156
2025-06-30 14:16:00 +00:00
Johannes Kirschbauer
22778b1864 Docs: getting started add services 2025-06-30 15:14:47 +02:00
DavHau
ee5fa8fe74 checks: rename attributes for better discoverability
- all eval checks prefixed with `eval-`
- all service checks prefixed with `service-`
2025-06-30 19:04:21 +07:00
Johannes Kirschbauer
4f55af9026 Docs: rename installer to usb installer 2025-06-30 13:03:07 +02:00
Johannes Kirschbauer
2fbfda504a docs: move deployment docs from add machine to deploy 2025-06-30 13:02:57 +02:00
Johannes Kirschbauer
642b300ce8 docs: mark getting-started/flash installer as optional" 2025-06-30 13:02:46 +02:00
DavHau
f12b62d8b4 docs: explain about simplified way of specifying instances 2025-06-30 10:27:37 +00:00
Jörg Thalheim
bc3ba8eeff markdown: ignore trailing whitespace 2025-06-27 16:26:39 +02:00
Johannes Kirschbauer
d011b1ab02 docs: rename all references from 'buildClan' to 'lib.clan' 2025-06-27 09:54:23 +02:00
a-kenji
688aad716d docs/testing: Improve testing documentation 2025-06-18 11:12:30 +02:00
DavHau
7cf065ae8c 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
2460ac970f Revert "clan-cli: Use Remote class in DeployInfo, add tests for qrcode parser and json parser"
This reverts commit 2ca3b5d698.
2025-06-09 11:28:15 +02:00
Qubasa
2ca3b5d698 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
d38fc3cb35 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
691f35739d fix the infoboxes not rendering correctly 2025-06-06 20:54:14 +01:00
Jeremy Fleischman
afefac3ac1 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
f6c5113394 docs: expose clan service authoring interface 2025-06-04 12:43:03 +02:00
Mic92
2219b9e8a6 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
f3a8a6454b Fix(docs): fix broken link to decision 2025-06-04 09:11:02 +02:00
RuboGubo
2f0714770a remove unnecessary note and re-work requirements 2025-06-03 14:31:34 +01:00
RuboGubo
d4b36d9d90 Add warning note for users on cloud machines 2025-05-31 20:10:10 +01:00
Michael Hoang
e0c1cb47e7 docs: clarify when to override the nixpkgs input of clan-core
To match 30987ee5b2/docs/site/guides/migrations/migration-guide.md (L54-L55)
2025-05-27 22:48:08 +10:00
Michael Hoang
eadd59ff21 docs: point users towards passing in self to buildClan 2025-05-27 13:49:14 +10:00
Guilhem Saurel
df12613ad8 typo 2025-05-25 17:36:14 +02:00
Michael Hoang
dc108cc27d docs: format code blocks in migration guide 2025-05-22 14:12:40 +10:00
Michael Hoang
dcb9358e51 docs: clean up flake-parts guide 2025-05-22 14:12:40 +10:00
Michael Hoang
5bc6126873 docs: misc clean up 2025-05-22 00:01:01 +10:00
hsjobeki
15f0ea616c 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
a9ed972834 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
6dab14c9d4 docs/macos: replace duplicate section 2025-05-20 18:48:36 +02:00
Jörg Thalheim
4f4c44c7d4 add documentation on how to use macOS 2025-05-20 12:56:02 +02:00
Johannes Kirschbauer
88f7b3410e 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
b36d641e71 Docs: move {flake, facts-vars} migration guides into 'migrations' folder 2025-05-18 18:56:03 +02:00
Johannes Kirschbauer
df5010084f Docs: create migrations subfolder in guides 2025-05-18 18:46:36 +02:00
Johannes Kirschbauer
0261a954de Docs: move 'getting-started' into guides section 2025-05-18 18:35:11 +02:00
Johannes Kirschbauer
ad5bbdbee0 Docs: move {contributing, disk, mesh, backups} into guides 2025-05-18 18:22:32 +02:00
Johannes Kirschbauer
9221231e89 docs: move authoring guides into guides subfolder 2025-05-16 16:33:39 +02:00
Johannes Kirschbauer
868db1e6f3 Docs: init migration guide for clanServices 2025-05-16 16:15:51 +02:00