yay
This commit is contained in:
parent
f9e276282a
commit
6ba25b90a9
6 changed files with 42 additions and 18 deletions
|
|
@ -2,8 +2,8 @@
|
||||||
|
|
||||||
> Auto-generated documentation for the homelab deployment
|
> Auto-generated documentation for the homelab deployment
|
||||||
>
|
>
|
||||||
> Generated on: $(date -R)
|
> Generated on: Wed, 30 Jul 2025 02:13:08 +0200
|
||||||
> Source: $(pwd)
|
> Source: /home/plasmagoat/homelab
|
||||||
|
|
||||||
## 📚 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 01:56:04 CEST 2025
|
- **Generated**: Wed, 30 Jul 2025 02:13:11 +0200
|
||||||
|
|
||||||
## 🛠️ Management Tools
|
## 🛠️ Management Tools
|
||||||
|
|
||||||
|
|
@ -64,11 +64,35 @@ 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,7 +2,7 @@
|
||||||
|
|
||||||
> Current homelab deployment configuration
|
> Current homelab deployment configuration
|
||||||
>
|
>
|
||||||
> Generated on: Wed, 30 Jul 2025 01:55:52 +0200
|
> Generated on: Wed, 30 Jul 2025 02:13:01 +0200
|
||||||
> Working directory: /home/plasmagoat/homelab
|
> Working directory: /home/plasmagoat/homelab
|
||||||
|
|
||||||
## Deployment Summary
|
## Deployment Summary
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
> Auto-generated fleet overview
|
> Auto-generated fleet overview
|
||||||
>
|
>
|
||||||
> Generated on: Wed, 30 Jul 2025 01:55:28 +0200
|
> Generated on: Wed, 30 Jul 2025 02:12:41 +0200
|
||||||
> Source: /home/plasmagoat/homelab
|
> Source: /home/plasmagoat/homelab
|
||||||
|
|
||||||
## Fleet Statistics
|
## Fleet Statistics
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
> Detailed per-node configuration
|
> Detailed per-node configuration
|
||||||
>
|
>
|
||||||
> Generated on: Wed, 30 Jul 2025 01:55:38 +0200
|
> Generated on: Wed, 30 Jul 2025 02:12:50 +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: Wed, 30 Jul 2025 01:55:42 +0200
|
> Generated on: Wed, 30 Jul 2025 02:12:53 +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
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,7 @@ writeShellScriptBin "homelab-docs-readme" ''
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
cat << 'EOF'
|
cat << EOF
|
||||||
# Homelab Documentation
|
# Homelab Documentation
|
||||||
|
|
||||||
> Auto-generated documentation for the homelab deployment
|
> Auto-generated documentation for the homelab deployment
|
||||||
|
|
@ -30,7 +30,7 @@ writeShellScriptBin "homelab-docs-readme" ''
|
||||||
## 🚀 Quick Actions
|
## 🚀 Quick Actions
|
||||||
|
|
||||||
### View Current Status
|
### View Current Status
|
||||||
```bash
|
\`\`\`bash
|
||||||
# Service status across fleet (if homelab CLI is available)
|
# Service status across fleet (if homelab CLI is available)
|
||||||
homelab services --global
|
homelab services --global
|
||||||
|
|
||||||
|
|
@ -39,16 +39,16 @@ writeShellScriptBin "homelab-docs-readme" ''
|
||||||
|
|
||||||
# Overall status
|
# Overall status
|
||||||
homelab status
|
homelab status
|
||||||
```
|
\`\`\`
|
||||||
|
|
||||||
### Update Documentation
|
### Update Documentation
|
||||||
```bash
|
\`\`\`bash
|
||||||
# Regenerate all documentation
|
# Regenerate all documentation
|
||||||
homelab-generate-docs ./docs
|
homelab-generate-docs ./docs
|
||||||
|
|
||||||
# Generate in different directory
|
# Generate in different directory
|
||||||
homelab-generate-docs /path/to/output
|
homelab-generate-docs /path/to/output
|
||||||
```
|
\`\`\`
|
||||||
|
|
||||||
## 📋 Quick Stats
|
## 📋 Quick Stats
|
||||||
|
|
||||||
|
|
@ -68,7 +68,7 @@ writeShellScriptBin "homelab-docs-readme" ''
|
||||||
|
|
||||||
echo "- **Total Nodes**: $total_nodes"
|
echo "- **Total Nodes**: $total_nodes"
|
||||||
echo "- **Homelab-Enabled Nodes**: $homelab_nodes"
|
echo "- **Homelab-Enabled Nodes**: $homelab_nodes"
|
||||||
echo "- **Generated**: $(date)"
|
echo "- **Generated**: $(date -R)"
|
||||||
echo
|
echo
|
||||||
echo "## 🛠️ Management Tools"
|
echo "## 🛠️ Management Tools"
|
||||||
echo
|
echo
|
||||||
|
|
@ -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
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue