docs
This commit is contained in:
parent
e276c47686
commit
f9e276282a
12 changed files with 26 additions and 50 deletions
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
> Auto-generated documentation for the homelab deployment
|
> Auto-generated documentation for the homelab deployment
|
||||||
>
|
>
|
||||||
> Generated on: $(date)
|
> Generated on: $(date -R)
|
||||||
> Source: $(pwd)
|
> Source: $(pwd)
|
||||||
|
|
||||||
## 📚 Documentation Files
|
## 📚 Documentation Files
|
||||||
|
|
@ -44,7 +44,7 @@ homelab-generate-docs /path/to/output
|
||||||
|
|
||||||
- **Total Nodes**: 2
|
- **Total Nodes**: 2
|
||||||
- **Homelab-Enabled 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
|
## 🛠️ Management Tools
|
||||||
|
|
||||||
|
|
@ -64,35 +64,11 @@ homelab-generate-docs /path/to/output
|
||||||
|
|
||||||
### GitHub Actions Example
|
### 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
|
### Manual Generation
|
||||||
|
|
||||||
```bash
|
|
||||||
# From your homelab directory
|
|
||||||
nix develop
|
|
||||||
homelab-generate-docs ./docs
|
|
||||||
git add docs/ && git commit -m "Update docs"
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,8 @@
|
||||||
|
|
||||||
> Current homelab deployment configuration
|
> Current homelab deployment configuration
|
||||||
>
|
>
|
||||||
> Generated on: $(date)
|
> Generated on: Wed, 30 Jul 2025 01:55:52 +0200
|
||||||
> Working directory: $(pwd)
|
> Working directory: /home/plasmagoat/homelab
|
||||||
|
|
||||||
## Deployment Summary
|
## Deployment Summary
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,8 @@
|
||||||
|
|
||||||
> Auto-generated fleet overview
|
> Auto-generated fleet overview
|
||||||
>
|
>
|
||||||
> Generated on: $(date)
|
> Generated on: Wed, 30 Jul 2025 01:55:28 +0200
|
||||||
> Source: $(pwd)
|
> Source: /home/plasmagoat/homelab
|
||||||
|
|
||||||
## Fleet Statistics
|
## Fleet Statistics
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
> Detailed per-node configuration
|
> Detailed per-node configuration
|
||||||
>
|
>
|
||||||
> Generated on: $(date)
|
> Generated on: Wed, 30 Jul 2025 01:55:38 +0200
|
||||||
|
|
||||||
## Node: photos
|
## Node: photos
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
> Complete service documentation with core options, feature integrations, and smart defaults
|
> 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:
|
This document provides comprehensive documentation for homelab services, organized by:
|
||||||
- **Core Service Options**: The main service configuration
|
- **Core Service Options**: The main service configuration
|
||||||
|
|
|
||||||
6
flake.lock
generated
6
flake.lock
generated
|
|
@ -156,11 +156,11 @@
|
||||||
},
|
},
|
||||||
"nixpkgs": {
|
"nixpkgs": {
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1750134718,
|
"lastModified": 1753694789,
|
||||||
"narHash": "sha256-v263g4GbxXv87hMXMCpjkIxd/viIF7p3JpJrwgKdNiI=",
|
"narHash": "sha256-cKgvtz6fKuK1Xr5LQW/zOUiAC0oSQoA9nOISB0pJZqM=",
|
||||||
"owner": "NixOS",
|
"owner": "NixOS",
|
||||||
"repo": "nixpkgs",
|
"repo": "nixpkgs",
|
||||||
"rev": "9e83b64f727c88a7711a2c463a7b16eedb69a84c",
|
"rev": "dc9637876d0dcc8c9e5e22986b857632effeb727",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
|
|
|
||||||
|
|
@ -78,7 +78,7 @@
|
||||||
echo "🏠 Homelab Development Environment"
|
echo "🏠 Homelab Development Environment"
|
||||||
echo "Available commands:"
|
echo "Available commands:"
|
||||||
echo " colmena apply - Deploy all hosts"
|
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 " sops secrets/secrets.yaml - Edit secrets"
|
||||||
echo ""
|
echo ""
|
||||||
'';
|
'';
|
||||||
|
|
|
||||||
|
|
@ -7,12 +7,12 @@ writeShellScriptBin "homelab-docs-deployment" ''
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
cat << 'EOF'
|
cat << EOF
|
||||||
# Current Deployment State
|
# Current Deployment State
|
||||||
|
|
||||||
> Current homelab deployment configuration
|
> Current homelab deployment configuration
|
||||||
>
|
>
|
||||||
> Generated on: $(date)
|
> Generated on: $(date -R)
|
||||||
> Working directory: $(pwd)
|
> Working directory: $(pwd)
|
||||||
|
|
||||||
## Deployment Summary
|
## Deployment Summary
|
||||||
|
|
|
||||||
|
|
@ -6,12 +6,12 @@ writeShellScriptBin "homelab-docs-fleet" ''
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
cat << 'EOF'
|
cat << EOF
|
||||||
# Homelab Fleet Overview
|
# Homelab Fleet Overview
|
||||||
|
|
||||||
> Auto-generated fleet overview
|
> Auto-generated fleet overview
|
||||||
>
|
>
|
||||||
> Generated on: $(date)
|
> Generated on: $(date -R)
|
||||||
> Source: $(pwd)
|
> Source: $(pwd)
|
||||||
|
|
||||||
## Fleet Statistics
|
## Fleet Statistics
|
||||||
|
|
|
||||||
|
|
@ -6,12 +6,12 @@ writeShellScriptBin "homelab-docs-nodes" ''
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
cat << 'EOF'
|
cat << EOF
|
||||||
# Node Configurations
|
# Node Configurations
|
||||||
|
|
||||||
> Detailed per-node configuration
|
> Detailed per-node configuration
|
||||||
>
|
>
|
||||||
> Generated on: $(date)
|
> Generated on: $(date -R)
|
||||||
|
|
||||||
EOF
|
EOF
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@ writeShellScriptBin "homelab-docs-readme" ''
|
||||||
|
|
||||||
> Auto-generated documentation for the homelab deployment
|
> Auto-generated documentation for the homelab deployment
|
||||||
>
|
>
|
||||||
> Generated on: $(date)
|
> Generated on: $(date -R)
|
||||||
> Source: $(pwd)
|
> Source: $(pwd)
|
||||||
|
|
||||||
## 📚 Documentation Files
|
## 📚 Documentation Files
|
||||||
|
|
@ -88,7 +88,7 @@ writeShellScriptBin "homelab-docs-readme" ''
|
||||||
echo
|
echo
|
||||||
echo "### GitHub Actions Example"
|
echo "### GitHub Actions Example"
|
||||||
echo
|
echo
|
||||||
echo "\`\`\`yaml"
|
echo "```yaml"
|
||||||
echo "name: Generate Documentation"
|
echo "name: Generate Documentation"
|
||||||
echo "on:"
|
echo "on:"
|
||||||
echo " push:"
|
echo " push:"
|
||||||
|
|
@ -107,16 +107,16 @@ writeShellScriptBin "homelab-docs-readme" ''
|
||||||
echo " git add docs/"
|
echo " git add docs/"
|
||||||
echo " git commit -m \"docs: update homelab documentation\" || exit 0"
|
echo " git commit -m \"docs: update homelab documentation\" || exit 0"
|
||||||
echo " git push"
|
echo " git push"
|
||||||
echo "\`\`\`"
|
echo "```"
|
||||||
echo
|
echo
|
||||||
echo "### Manual Generation"
|
echo "### Manual Generation"
|
||||||
echo
|
echo
|
||||||
echo "\`\`\`bash"
|
echo "```bash"
|
||||||
echo "# From your homelab directory"
|
echo "# From your homelab directory"
|
||||||
echo "nix develop"
|
echo "nix develop"
|
||||||
echo "homelab-generate-docs ./docs"
|
echo "homelab-generate-docs ./docs"
|
||||||
echo "git add docs/ && git commit -m \"Update docs\""
|
echo "git add docs/ && git commit -m \"Update docs\""
|
||||||
echo "\`\`\`"
|
echo "```"
|
||||||
echo
|
echo
|
||||||
echo "---"
|
echo "---"
|
||||||
echo
|
echo
|
||||||
|
|
|
||||||
|
|
@ -6,12 +6,12 @@ writeShellScriptBin "homelab-docs-services" ''
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
cat << 'EOF'
|
cat << EOF
|
||||||
# Service Catalog
|
# Service Catalog
|
||||||
|
|
||||||
> Complete service documentation with core options, feature integrations, and smart defaults
|
> 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:
|
This document provides comprehensive documentation for homelab services, organized by:
|
||||||
- **Core Service Options**: The main service configuration
|
- **Core Service Options**: The main service configuration
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue