Commit Graph

370 Commits

Author SHA1 Message Date
Johannes Kirschbauer
83278097f6 docs: add service update instructions 2025-07-12 16:35:43 +02:00
Johannes Kirschbauer
fb60ae8082 docs: add machines update instructions 2025-07-12 16:35:43 +02:00
Johannes Kirschbauer
4b8f83de9e docs: create clan update cli instructions 2025-07-12 16:35:41 +02:00
a-kenji
f97bbc946e pkgs/clan: Fix command typos 2025-07-12 13:54:37 +02:00
Johannes Kirschbauer
4800fec13c diskId: add migration docs and a big fat warning 2025-07-11 20:47:53 +02:00
Johannes Kirschbauer
a9e50154d0 Docs: mention clan.nix file, which is present in the default template now 2025-07-08 14:58:24 +02:00
Johannes Kirschbauer
8d5740fd16 Docs: execute 'clan show' as first step 2025-07-08 10:24:01 +02:00
Johannes Kirschbauer
5d6a0c9883 templates: rename 'new_clan' to default 2025-07-07 15:50:00 +00:00
hsjobeki
5750f4bbe7 Merge pull request 'machine/host: degrade into info and add docs' (#4238) from host-info into main
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4238
Reviewed-by: Luis Hebendanz <consulting@qube.email>
2025-07-07 11:10:05 +00:00
Johannes Kirschbauer
eaae9b0025 machine/host: degrade into info and add docs 2025-07-07 11:52:46 +02:00
Michael Hoang
ea1df1e9f4 treewide: don't generate SSH keys with builder hostname 2025-07-07 14:39:57 +10:00
Michael Hoang
a91756d54a docs: remove colon from headings 2025-07-07 13:54:26 +10:00
hsjobeki
5b61c4253a Merge pull request 'clan_lib/openapi: add openapi rendering' (#4200) from lib-openapi into main
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4200
2025-07-04 11:54:13 +00:00
Johannes Kirschbauer
38b8722e2e Docs: init redoc internal rest inspired docs 2025-07-04 12:45:39 +02:00
DavHau
67a37a9d2c reverting b1f71fe4fb 2025-07-04 10:35:30 +07:00
Johannes Kirschbauer
0f6f0a6237 docs: add zerotier debugging commands 2025-07-03 16:25:10 +02:00
Johannes Kirschbauer
62ada9e1c2 docs: update vpn setup instructions 2025-07-03 12:04:56 +02:00
Johannes Kirschbauer
fe47157a7c docs: fix wrong roles assignment syntax 2025-07-03 11:42:26 +02:00
hsjobeki
93fc836e6b 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
b1f71fe4fb clan.deployment: unify deprecated option 2025-07-02 18:37:29 +02:00
Johannes Kirschbauer
35b426f943 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
54396e8744 docs/index: add progress tracker, encourage non-linear flow 2025-07-02 17:02:16 +02:00
Johannes Kirschbauer
bcebfc7b8e docs: rephrase add machines for planned dynamic templates 2025-07-02 17:01:40 +02:00
Johannes Kirschbauer
2079fe06be docs: clarify project structure exploration in Getting Started 2025-07-02 16:32:30 +02:00
Johannes Kirschbauer
454e68615c docs: remove api reference build command 2025-07-02 15:53:48 +02:00
Johannes Kirschbauer
8097d491cd 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
abbf2c1083 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
eab918324b Docs: getting started add services 2025-06-30 15:14:47 +02:00
DavHau
73b298d0b2 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
ff52f38f87 Docs: rename installer to usb installer 2025-06-30 13:03:07 +02:00
Johannes Kirschbauer
e55220ed47 docs: move deployment docs from add machine to deploy 2025-06-30 13:02:57 +02:00
Johannes Kirschbauer
a7bca56487 docs: mark getting-started/flash installer as optional" 2025-06-30 13:02:46 +02:00
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