Johannes Kirschbauer
caaf9dc4f3
docs: unify documentation
...
Strictly enforce diataxis
Use resource driven approach
Can extend later to add 'developer' link index page
2025-07-24 16:51:57 +02:00
Qubasa
5c7e6b3830
docs: Move developer guides into the Developer section
...
nix fmt
address davhau review
2025-07-23 18:31:19 +07:00
Jörg Thalheim
377056e80c
clan flakes create: initialize keys automatically ( #4435 )
...
fixes https://git.clan.lol/clan/clan-core/issues/2665
fixes https://git.clan.lol/clan/clan-core/issues/4407
Co-authored-by: DavHau <d.hauer.it@gmail.com >
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4435
Co-authored-by: Jörg Thalheim <joerg@thalheim.io >
Co-committed-by: Jörg Thalheim <joerg@thalheim.io >
2025-07-23 04:44:55 +00:00
a-kenji
19ca7d9a77
docs: Fix typo
2025-07-22 13:26:06 +02:00
a-kenji
7fc527b649
docs: Fix typos in getting-started guide
2025-07-21 20:47:41 +02:00
Johannes Kirschbauer
8f5bf1ff2a
deploy: add warning about disko.nix
2025-07-13 21:26:07 +02:00
Johannes Kirschbauer
6f13a8ec85
docs/users: add explanation for groups
2025-07-13 11:33:22 +02:00
Johannes Kirschbauer
77736090fd
docs/getting-started: seperate step to add a user
2025-07-13 11:31:14 +02:00
Johannes Kirschbauer
ae47f49343
docs/deploy: remove unneeded --update-hardware-config nixos-facter
2025-07-12 17:48:13 +02:00
Johannes Kirschbauer
9ece8c6d10
Templates/cli: improve ux and docs
2025-07-12 17:21:23 +02:00
Johannes Kirschbauer
0ec26ff0ab
Docs: fix code annotations
2025-07-12 16:40:02 +02:00
Johannes Kirschbauer
582cbff138
Docs: fix typos
2025-07-12 16:39:20 +02:00
Johannes Kirschbauer
6d24117d0c
Docs: align workflow, remove targetHost before deployment
2025-07-12 16:35:43 +02:00
Johannes Kirschbauer
821f5c2bc2
Docs: rewrite deployment instructions
2025-07-12 16:35:43 +02:00
Johannes Kirschbauer
0dc867c0b6
docs: add guide how to create configuration.nix
2025-07-12 16:35:43 +02:00
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
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
DavHau
67a37a9d2c
reverting b1f71fe4fb
2025-07-04 10:35:30 +07: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
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
Johannes Kirschbauer
eab918324b
Docs: getting started add services
2025-06-30 15:14:47 +02: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
Johannes Kirschbauer
731de62876
docs: rename all references from 'buildClan' to 'lib.clan'
2025-06-27 09:54:23 +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
RuboGubo
7d930d15fd
fix the infoboxes not rendering correctly
2025-06-06 20:54:14 +01: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
Michael Hoang
b6d20a63f5
docs: point users towards passing in self to buildClan
2025-05-27 13:49:14 +10:00
Michael Hoang
508bb14809
docs: misc clean up
2025-05-22 00:01:01 +10: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
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
f387ab0882
Docs: create migrations subfolder in guides
2025-05-18 18:46:36 +02:00
Johannes Kirschbauer
1806c6c16e
Docs: move 'getting-started' into guides section
2025-05-18 18:35:11 +02:00
