yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: remove step numbers

Browse Source 
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
This commit is contained in:
Johannes Kirschbauer
2025-07-02 15:53:24 +02:00
parent fb3685d721
commit 8097d491cd
8 changed files with 55 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/site/guides/migrations/migrate-inventory-services.md
View File

@@ -74,9 +74,7 @@ instances = {
## Steps to Migrate
### 1. Move `services` entries to `instances`
### Move `services` entries to `instances`
Check if a service that you use has been migrated [In our reference](../../reference/clanServices/index.md)
@@ -96,7 +94,7 @@ Each nested service-instance-pair becomes a flat key, like `borgbackup.simple
---
### 2. Add `module.name` and `module.input`
### Add `module.name` and `module.input`
Each instance must declare the module name and flake input it comes from:
@@ -117,7 +115,7 @@ Then refer to it as `input = "clan-core"`.
---
### 3. Move role and machine config under `roles`
### Move role and machine config under `roles`
In the new system: