updated docs
This commit is contained in:
parent
ce8c543e84
commit
73d2f44d74
14 changed files with 940 additions and 913 deletions
|
|
@ -2,8 +2,8 @@
|
|||
|
||||
> Auto-generated documentation for the homelab deployment
|
||||
>
|
||||
> Generated on: tir 29 jul 16:25:52 CEST 2025
|
||||
> Source: /home/plasmagoat/homelab
|
||||
> Generated on: $(date)
|
||||
> Source: $(pwd)
|
||||
|
||||
## 📚 Documentation Files
|
||||
|
||||
|
|
@ -20,7 +20,7 @@ This documentation is automatically generated from your colmena flake configurat
|
|||
## 🚀 Quick Actions
|
||||
|
||||
### View Current Status
|
||||
```bash
|
||||
\`\`\`bash
|
||||
# Service status across fleet (if homelab CLI is available)
|
||||
homelab services --global
|
||||
|
||||
|
|
@ -29,22 +29,22 @@ homelab backups --global
|
|||
|
||||
# Overall status
|
||||
homelab status
|
||||
```
|
||||
\`\`\`
|
||||
|
||||
### Update Documentation
|
||||
```bash
|
||||
\`\`\`bash
|
||||
# Regenerate all documentation
|
||||
homelab-generate-docs ./docs
|
||||
|
||||
# Generate in different directory
|
||||
homelab-generate-docs /path/to/output
|
||||
```
|
||||
\`\`\`
|
||||
|
||||
## 📋 Quick Stats
|
||||
|
||||
- **Total Nodes**: 2
|
||||
- **Homelab-Enabled Nodes**: 2
|
||||
- **Generated**: tir 29 jul 16:25:55 CEST 2025
|
||||
- **Generated**: tir 29 jul 16:57:16 CEST 2025
|
||||
|
||||
## 🛠️ Management Tools
|
||||
|
||||
|
|
@ -60,6 +60,40 @@ homelab-generate-docs /path/to/output
|
|||
- `colmena apply` - Deploy configuration changes
|
||||
- `colmena build` - Build configurations without deploying
|
||||
|
||||
## 🎯 Integration with CI/CD
|
||||
|
||||
### 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"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
*This documentation reflects the live state of your homelab deployment as evaluated by colmena.*
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue