From f9e276282a896c335157c843388c0beb73872eab Mon Sep 17 00:00:00 2001 From: plasmagoat Date: Wed, 30 Jul 2025 01:56:53 +0200 Subject: [PATCH] docs --- docs/README.md | 30 +++--------------------------- docs/current-deployment.md | 4 ++-- docs/fleet-overview.md | 4 ++-- docs/nodes.md | 2 +- docs/services.md | 2 +- flake.lock | 6 +++--- flake.nix | 2 +- pkgs/homelab-docs/deployment.nix | 4 ++-- pkgs/homelab-docs/fleet.nix | 4 ++-- pkgs/homelab-docs/nodes.nix | 4 ++-- pkgs/homelab-docs/readme.nix | 10 +++++----- pkgs/homelab-docs/services.nix | 4 ++-- 12 files changed, 26 insertions(+), 50 deletions(-) diff --git a/docs/README.md b/docs/README.md index 9984a6d..ce7e48e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ > Auto-generated documentation for the homelab deployment > -> Generated on: $(date) +> Generated on: $(date -R) > Source: $(pwd) ## 📚 Documentation Files @@ -44,7 +44,7 @@ homelab-generate-docs /path/to/output - **Total Nodes**: 2 - **Homelab-Enabled Nodes**: 2 -- **Generated**: ons 30 jul 00:20:46 CEST 2025 +- **Generated**: ons 30 jul 01:56:04 CEST 2025 ## 🛠️ Management Tools @@ -64,35 +64,11 @@ homelab-generate-docs /path/to/output ### GitHub Actions Example -```yaml -name: Generate Documentation -on: - push: - branches: [ main ] -jobs: - docs: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: cachix/install-nix-action@v24 - - name: Generate docs - run: nix develop --command homelab-generate-docs ./docs - - name: Commit docs - run: | - git add docs/ - git commit -m "docs: update homelab documentation" || exit 0 - git push -``` ### Manual Generation -```bash -# From your homelab directory -nix develop -homelab-generate-docs ./docs -git add docs/ && git commit -m "Update docs" -``` + --- diff --git a/docs/current-deployment.md b/docs/current-deployment.md index c43eccf..9fe7850 100644 --- a/docs/current-deployment.md +++ b/docs/current-deployment.md @@ -2,8 +2,8 @@ > Current homelab deployment configuration > -> Generated on: $(date) -> Working directory: $(pwd) +> Generated on: Wed, 30 Jul 2025 01:55:52 +0200 +> Working directory: /home/plasmagoat/homelab ## Deployment Summary diff --git a/docs/fleet-overview.md b/docs/fleet-overview.md index 866c8bd..b8b7c7e 100644 --- a/docs/fleet-overview.md +++ b/docs/fleet-overview.md @@ -2,8 +2,8 @@ > Auto-generated fleet overview > -> Generated on: $(date) -> Source: $(pwd) +> Generated on: Wed, 30 Jul 2025 01:55:28 +0200 +> Source: /home/plasmagoat/homelab ## Fleet Statistics diff --git a/docs/nodes.md b/docs/nodes.md index 90a635a..9ef180a 100644 --- a/docs/nodes.md +++ b/docs/nodes.md @@ -2,7 +2,7 @@ > Detailed per-node configuration > -> Generated on: $(date) +> Generated on: Wed, 30 Jul 2025 01:55:38 +0200 ## Node: photos diff --git a/docs/services.md b/docs/services.md index 7e3571b..7d60e4a 100644 --- a/docs/services.md +++ b/docs/services.md @@ -2,7 +2,7 @@ > Complete service documentation with core options, feature integrations, and smart defaults > -> Generated on: $(date) +> Generated on: Wed, 30 Jul 2025 01:55:42 +0200 This document provides comprehensive documentation for homelab services, organized by: - **Core Service Options**: The main service configuration diff --git a/flake.lock b/flake.lock index 66740fb..e46dbf1 100644 --- a/flake.lock +++ b/flake.lock @@ -156,11 +156,11 @@ }, "nixpkgs": { "locked": { - "lastModified": 1750134718, - "narHash": "sha256-v263g4GbxXv87hMXMCpjkIxd/viIF7p3JpJrwgKdNiI=", + "lastModified": 1753694789, + "narHash": "sha256-cKgvtz6fKuK1Xr5LQW/zOUiAC0oSQoA9nOISB0pJZqM=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "9e83b64f727c88a7711a2c463a7b16eedb69a84c", + "rev": "dc9637876d0dcc8c9e5e22986b857632effeb727", "type": "github" }, "original": { diff --git a/flake.nix b/flake.nix index c183ee9..961a270 100644 --- a/flake.nix +++ b/flake.nix @@ -78,7 +78,7 @@ echo "🏠 Homelab Development Environment" echo "Available commands:" echo " colmena apply - Deploy all hosts" - echo " colmena apply --on HOST - Deploy specific host" + echo " colmena apply --on @tag - Deploy specific tagged hosts" echo " sops secrets/secrets.yaml - Edit secrets" echo "" ''; diff --git a/pkgs/homelab-docs/deployment.nix b/pkgs/homelab-docs/deployment.nix index f9636a7..8d7e18a 100644 --- a/pkgs/homelab-docs/deployment.nix +++ b/pkgs/homelab-docs/deployment.nix @@ -7,12 +7,12 @@ writeShellScriptBin "homelab-docs-deployment" '' #!/usr/bin/env bash set -euo pipefail - cat << 'EOF' + cat << EOF # Current Deployment State > Current homelab deployment configuration > - > Generated on: $(date) + > Generated on: $(date -R) > Working directory: $(pwd) ## Deployment Summary diff --git a/pkgs/homelab-docs/fleet.nix b/pkgs/homelab-docs/fleet.nix index 8ca3066..fc14680 100644 --- a/pkgs/homelab-docs/fleet.nix +++ b/pkgs/homelab-docs/fleet.nix @@ -6,12 +6,12 @@ writeShellScriptBin "homelab-docs-fleet" '' #!/usr/bin/env bash set -euo pipefail - cat << 'EOF' + cat << EOF # Homelab Fleet Overview > Auto-generated fleet overview > - > Generated on: $(date) + > Generated on: $(date -R) > Source: $(pwd) ## Fleet Statistics diff --git a/pkgs/homelab-docs/nodes.nix b/pkgs/homelab-docs/nodes.nix index b47fd05..7ea32fd 100644 --- a/pkgs/homelab-docs/nodes.nix +++ b/pkgs/homelab-docs/nodes.nix @@ -6,12 +6,12 @@ writeShellScriptBin "homelab-docs-nodes" '' #!/usr/bin/env bash set -euo pipefail - cat << 'EOF' + cat << EOF # Node Configurations > Detailed per-node configuration > - > Generated on: $(date) + > Generated on: $(date -R) EOF diff --git a/pkgs/homelab-docs/readme.nix b/pkgs/homelab-docs/readme.nix index 505d465..68ac51b 100644 --- a/pkgs/homelab-docs/readme.nix +++ b/pkgs/homelab-docs/readme.nix @@ -12,7 +12,7 @@ writeShellScriptBin "homelab-docs-readme" '' > Auto-generated documentation for the homelab deployment > - > Generated on: $(date) + > Generated on: $(date -R) > Source: $(pwd) ## 📚 Documentation Files @@ -88,7 +88,7 @@ writeShellScriptBin "homelab-docs-readme" '' echo echo "### GitHub Actions Example" echo - echo "\`\`\`yaml" + echo "```yaml" echo "name: Generate Documentation" echo "on:" echo " push:" @@ -107,16 +107,16 @@ writeShellScriptBin "homelab-docs-readme" '' echo " git add docs/" echo " git commit -m \"docs: update homelab documentation\" || exit 0" echo " git push" - echo "\`\`\`" + echo "```" echo echo "### Manual Generation" echo - echo "\`\`\`bash" + echo "```bash" echo "# From your homelab directory" echo "nix develop" echo "homelab-generate-docs ./docs" echo "git add docs/ && git commit -m \"Update docs\"" - echo "\`\`\`" + echo "```" echo echo "---" echo diff --git a/pkgs/homelab-docs/services.nix b/pkgs/homelab-docs/services.nix index 808c746..2fed267 100644 --- a/pkgs/homelab-docs/services.nix +++ b/pkgs/homelab-docs/services.nix @@ -6,12 +6,12 @@ writeShellScriptBin "homelab-docs-services" '' #!/usr/bin/env bash set -euo pipefail - cat << 'EOF' + cat << EOF # Service Catalog > Complete service documentation with core options, feature integrations, and smart defaults > - > Generated on: $(date) + > Generated on: $(date -R) This document provides comprehensive documentation for homelab services, organized by: - **Core Service Options**: The main service configuration