eblume/blumeops
1
1
Fork 0
Code Issues Pull requests Projects Releases 83 Packages Wiki Activity Actions

Phase 2: Add Reference section with 24 technical reference cards #88

Merged
eblume merged 12 commits from feature/docs-phase-2-reference into main 2026-02-03 14:27:38 -08:00
Conversation 0 Commits 12 Files changed 34 +1385 -6
eblume commented 2026-02-03 13:22:37 -08:00
Owner
Copy link

Summary

  • Create docs/reference/ section with 24 technical reference cards
  • Services (16): alloy, argocd, borgmatic, 1password, forgejo, grafana, jellyfin, kiwix, loki, miniflux, navidrome, postgresql, prometheus, teslamate, transmission, zot
  • Infrastructure (3): hosts, tailscale, routing
  • Kubernetes (2): cluster, apps
  • Storage (2): sifaka, backups
  • Update README to mark Phase 2 as complete
  • Add towncrier changelog fragment

Deployment and Testing

  • Build docs locally to verify wiki-links resolve
  • Deploy via ArgoCD and verify at docs.ops.eblu.me/reference/

🤖 Generated with Claude Code

## Summary - Create `docs/reference/` section with 24 technical reference cards - Services (16): alloy, argocd, borgmatic, 1password, forgejo, grafana, jellyfin, kiwix, loki, miniflux, navidrome, postgresql, prometheus, teslamate, transmission, zot - Infrastructure (3): hosts, tailscale, routing - Kubernetes (2): cluster, apps - Storage (2): sifaka, backups - Update README to mark Phase 2 as complete - Add towncrier changelog fragment ## Deployment and Testing - [ ] Build docs locally to verify wiki-links resolve - [ ] Deploy via ArgoCD and verify at docs.ops.eblu.me/reference/ 🤖 Generated with [Claude Code](https://claude.com/claude-code)
Move Reference from Phase 4 to Phase 2 so that tutorials, how-to guides,
and explanations can link to authoritative technical descriptions using
wiki-links. This supports the zk-style approach of keeping docs small
and linking out to reference cards.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Phase 2 of documentation restructuring. Creates docs/reference/ with:

Services (16):
- alloy, argocd, borgmatic, 1password, forgejo, grafana
- jellyfin, kiwix, loki, miniflux, navidrome, postgresql
- prometheus, teslamate, transmission, zot

Infrastructure (3):
- hosts - Device inventory
- tailscale - ACLs, groups, tags
- routing - DNS domains and port mappings

Kubernetes (2):
- cluster - Minikube specs
- apps - ArgoCD application registry

Storage (2):
- sifaka - Synology NAS configuration
- backups - Backup policy

All cards use wiki-links for cross-referencing and include YAML
frontmatter with title and tags for Quartz.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
eblume force-pushed feature/docs-phase-2-reference from ce1f696bd8 to 0018d3c593 2026-02-03 13:23:31 -08:00 Compare 
Remove backslash escaping from pipe characters in wiki-links.
Correct: [[services/forgejo|Forgejo]]
Wrong: [[services/forgejo\|Forgejo]]

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Reference docs should describe "what things are", not "how to do things".
Removed:
- CLI command examples
- Operational workflows (PR workflow, sync commands)
- Setup/bootstrap procedures
- "Useful Commands" sections

Also split hosts.md into individual cards:
- infrastructure/indri.md - Primary server details
- infrastructure/gilbert.md - Development workstation

This content belongs in how-to guides (future phase).

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Links to services/postgresql for discoverability from storage section.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Links to services/1password for discoverability from kubernetes section.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- observability - links to prometheus, loki, alloy, grafana
- backup - links to borgmatic, sifaka, backup policy
- disaster-recovery - TBD, links to borgmatic, 1password, forgejo

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
With *.ops.eblu.me URLs routed via Caddy, Tailscale MagicDNS
resolution may no longer be needed. Should be tested.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- New services/immich.md card
- Update sifaka to link photos share to Immich
- Add Immich to services index

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Clarifies that sifaka is the backup TARGET, not source.
Notes RAID 5 for current protection, offsite planned for future.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Clarify immich deployment is k8s Helm chart
- Add immich entry to kubernetes/apps.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Verified against actual k8s PVs - all three NFS exports now listed:
- /volume1/torrents (kiwix, transmission)
- /volume1/music (navidrome)
- /volume1/photos (immich)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
eblume merged commit 254b93096a into main 2026-02-03 14:27:38 -08:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
eblume/blumeops!88
No description provided.