From 83b38e9e01b24f91b3f92ea14ecb59d6cf5c6863 Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Wed, 2 Jul 2025 17:00:51 +0200 Subject: [PATCH 1/3] docs: add emojis to getting-started --- docs/mkdocs.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index c40d39159..89ed12540 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -48,13 +48,13 @@ nav: - Home: index.md - Guides: - Getting Started: - - Creating Your First Clan: guides/getting-started/index.md - - Create USB Installer (optional): guides/getting-started/installer.md - - Add Machines: guides/getting-started/add-machines.md - - Add Services: guides/getting-started/add-services.md - - Secrets & Facts: guides/getting-started/secrets.md - - Deploy Machine: guides/getting-started/deploy.md - - Continuous Integration: guides/getting-started/check.md + - πŸš€ Creating Your First Clan: guides/getting-started/index.md + - πŸ“€ Create USB Installer (optional): guides/getting-started/installer.md + - βš™οΈ Add Machines: guides/getting-started/add-machines.md + - βš™οΈ Add Services: guides/getting-started/add-services.md + - πŸ” Secrets & Facts: guides/getting-started/secrets.md + - 🚒 Deploy Machine: guides/getting-started/deploy.md + - πŸ§ͺ Continuous Integration: guides/getting-started/check.md - clanServices: guides/clanServices.md - Disk Encryption: guides/disk-encryption.md - Mesh VPN: guides/mesh-vpn.md From bcebfc7b8ebb9b69ee128349a8465dc6d3190783 Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Wed, 2 Jul 2025 17:01:40 +0200 Subject: [PATCH 2/3] docs: rephrase add machines for planned dynamic templates --- .../guides/getting-started/add-machines.md | 32 ++++++++++++------- 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/docs/site/guides/getting-started/add-machines.md b/docs/site/guides/getting-started/add-machines.md index 4f8bb3614..1f0726fb8 100644 --- a/docs/site/guides/getting-started/add-machines.md +++ b/docs/site/guides/getting-started/add-machines.md @@ -119,26 +119,34 @@ clan = { 1. It is required to define a *targetHost* for each machine before deploying. Best practice has been, to use the zerotier ip/hostname or the ip from the from overlay network you decided to use. 2. Add your *ssh key* here - That will ensure you can always login to your machine via *ssh* in case something goes wrong. -### (Optional): Renaming Machine +### (Optional) Renaming a Machine -For renaming jon to your own machine name, you can use the following command: +Older templates included static machine folders like `jon` and `sara`. +If your setup still uses such static machines, you can rename a machine folder to match your own machine name: -``` -git mv ./machines/jon ./machines/newname +```bash +git mv ./machines/jon ./machines/ ``` -Note that our clan lives inside a git repository. -Only files that have been added with `git add` are recognized by `nix`. -So for every file that you add or rename you also need to run: +Since your Clan configuration lives inside a Git repository, remember: -``` -git add ./path/to/my/file +* Only files tracked by Git (`git add`) are recognized. +* Whenever you add, rename, or remove files, run: + +```bash +git add ./machines/ ``` -### (Optional): Removing a Machine +to stage the changes. -If you only want to setup a single machine at this point, you can delete `sara` from `flake.nix` as well as from the machines directory: +--- -``` +### (Optional) Removing a Machine + +If you want to work with a single machine for now, you can remove other machine entries both from your `flake.nix` and from the `machines` directory. For example, to remove the machine `sara`: + +```bash git rm -rf ./machines/sara ``` + +Make sure to also remove or update any references to that machine in your `nix files` or `inventory.json` if you have any of that From 54396e8744da1cf64e63212c3a9e98442ab4d499 Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Wed, 2 Jul 2025 17:02:16 +0200 Subject: [PATCH 3/3] docs/index: add progress tracker, encourage non-linear flow --- docs/site/guides/getting-started/index.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/site/guides/getting-started/index.md b/docs/site/guides/getting-started/index.md index ec9456e6e..8e7713021 100644 --- a/docs/site/guides/getting-started/index.md +++ b/docs/site/guides/getting-started/index.md @@ -108,5 +108,17 @@ clan machines list If you see no output yet, that’s expected β€” [add machines](./add-machines.md) to populate it. -!!! success - You just successfully bootstrapped your first Clan. +--- + +## Next Steps + +You can continue with **any** of the following steps at your own pace: + +- [x] [Install Nix & Clan CLI](./index.md) +- [x] [Initialize Clan](./index.md#initialize-your-project) +- [ ] [Create USB Installer (optional)](./installer.md) +- [ ] [Add Machines](./add-machines.md) +- [ ] [Add Services](./add-services.md) +- [ ] [Configure Secrets](./secrets.md) +- [ ] [Deploy](./deploy.md) - Requires configured secrets +- [ ] [Setup CI (optional)](./check.md)