improve documentation (#392)

Co-authored-by: ibizaman <ibizapeanut@gmail.com>

.github/workflows/build.yaml

@@ -20,22 +20,28 @@ jobs:
   path-filter:
     runs-on: ubuntu-latest
     outputs:
-      changed: ${{ steps.filter.outputs.changed }}
+      changed: ${{ steps.filter.outputs.any_changed }}
 
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - uses: dorny/paths-filter@v3
+      - uses: tj-actions/changed-files@v45
         id: filter
         with:
-          filters: |
+          files: |
-            changed:
+            lib/**
-              - 'lib/**'
+            modules/**
-              - 'modules/**'
+            !modules/**/docs/**
-              - '!modules/**/docs/**'
+            test/**
-              - 'test/**'
+            .github/workflows/build.yaml
-              - '.github/workflows/build.yaml'
+          separator: "\n"
+
+      - env:
+          ALL_CHANGED_FILES: ${{ steps.filter.outputs.all_changed_files }}
+        run: |
+          echo $ALL_CHANGED_FILES
+
 
   build-matrix:
     needs: [ "path-filter" ]

README.md

@@ -41,8 +41,10 @@ that is not like the other server management tools.
 > production server, this is really just a one person effort for now and there are most certainly
 > bugs that I didn't discover yet.
 
+### Flake Module
+
 Self Host Blocks is available as a flake.
-To use it in your project, add the following flake input:
+To use it in your existing project, add the following flake input:
 
 ```nix
 inputs.selfhostblocks.url = "github:ibizaman/selfhostblocks";
@@ -70,6 +72,25 @@ Then, to actually configure services, you can choose which one interests you in
 Head over to the [matrix channel](https://matrix.to/#/#selfhostblocks:matrix.org)
 for any remaining question, or just to say hi :)
 
+### Installation From Scratch
+
+I do recommend for this my sibling project [Skarabox][]
+which bootstraps a new server and sets up a few tools:
+
+- Creating a bootable ISO, installable on an USB key.
+- [nixos-anywhere](https://github.com/nix-community/nixos-anywhere) to install NixOS headlessly.
+- [disko](https://github.com/nix-community/disko) to format the drives using native ZFS encryption with remote unlocking through ssh.
+- [sops-nix](https://github.com/Mic92/sops-nix) to handle secrets.
+- [deploy-rs](https://github.com/serokell/deploy-rs) to deploy updates.
+
+[Skarabox]:  https://github.com/ibizaman/skarabox
+
+### Full Example
+
+See [full example][] in the manual.
+
+[full example]: https://shb.skarabox.com/usage.html#usage-complete-example
+
 ## Server Management
 
 Self Host Blocks provides a standardized configuration for [some services](https://shb.skarabox.com/services.html) provided by nixpkgs.

docs/redirects.json

@@ -1673,9 +1673,15 @@
   "usage": [
     "usage.html#usage"
   ],
+  "usage-complete-example": [
+    "usage.html#usage-complete-example"
+  ],
   "usage-example-colmena": [
     "usage.html#usage-example-colmena"
   ],
+  "usage-example-deployrs": [
+    "usage.html#usage-example-deployrs"
+  ],
   "usage-example-nixosrebuild": [
     "usage.html#usage-example-nixosrebuild"
   ],