Luis Hebendanz
d4e601586d
Merge pull request 'docs: init new structure' ( #5157 ) from improve_vars_docs2 into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/5157
2025-09-16 14:48:15 +00:00
Johannes Kirschbauer
3d680bcc5f
docs: remove references to buildClan
2025-09-16 16:02:05 +02:00
Qubasa
31ff7b903c
docs: add next step button to physical machine
2025-09-16 16:01:03 +02:00
Qubasa
d25818580d
docs: Fixup stale references
2025-09-16 16:01:03 +02:00
Johannes Kirschbauer
13eba4d7c5
docs: changes from johannes
...
WIP
2025-09-16 16:01:03 +02:00
Qubasa
186a760529
docs: fixup links to networking guide, improve introduction.
2025-08-27 17:37:15 +02:00
Johannes Kirschbauer
c7786a59fd
docs/update: refactor machine update guide
...
Restructured page: core workflow first, advanced usage after.
Improved grammar, phrasing, and capitalization (Clan CLI, apostrophes).
Added warnings/notes for buildHost and CPU architecture.
Polished code snippets and CLI examples for clarity.
2025-08-27 10:26:53 +02:00
Jörg Thalheim
23c152541a
docs/getting-started: remove duplicate nixosConfigurations
2025-08-25 15:22:30 +02:00
Johannes Kirschbauer
4470bb886e
docs: move 'migrate-flake' to 'convert existing nixos'
2025-08-25 14:11:31 +02:00
Johannes Kirschbauer
1b12882e29
docs: change wording, update links
2025-08-25 12:42:03 +02:00
scriptogre
6b6da7b897
docs: Revamp and simplify Getting Started guide
2025-08-15 13:19:39 +03:00
DavHau
caae6c7a55
docs: improve wording on getting-started
...
I found the header text to be confusing at places:
- `at least one machine to push to`: Pushing what? Where? DO I ned a git server? Do you mean installing?
-> I re-phrased the text
Also removed the tree command, as this is not available on most systems by default
2025-08-12 11:33:28 +07:00
Mic92
e1062ed97c
Merge pull request 'docs/update: mention build-host local and uploading flake inputs' ( #4614 ) from local-build into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4614
2025-08-06 10:18:28 +00:00
Jörg Thalheim
2eb1a56d8f
update.md: mention build-host local and uploading flake inputs
2025-08-06 12:14:35 +02:00
Jörg Thalheim
d51d656391
consistently use tarball urls in documentation
...
otherwise users not using our templates will find themselves missing
git.
2025-08-04 11:20:14 +02:00
Qubasa
0b05b0b1ec
docs: review fixups
...
docs: review fixups
docs: review fixups
docs: fixup links in cli
docs: fixup links in cli
2025-08-01 14:53:31 +07:00
Qubasa
d2529704d5
docs: Split up getting-started guide in a Physical and Virtual installation, and properly document how to install on non-NixOS machines
...
docs: git add docs
2025-07-31 17:06:44 +07:00
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
