eblume/blumeops
1
1
Fork 0
Code Issues Pull requests Projects Releases 83 Packages Wiki Activity Actions
blumeops/docs/tutorials/exploring-the-docs.md
Erich Blume e311b36b3c Add Phase 4: how-to guides documentation (#95) 
## Summary
- Create `docs/how-to/` directory with index and four how-to guides
- deploy-k8s-service: Quick reference for Kubernetes deployments via ArgoCD
- add-ansible-role: Adding new Ansible roles for indri services
- update-tailscale-acls: Modifying Tailscale ACL policies via Pulumi
- troubleshooting: Diagnosing and fixing common issues
- Update exploring-the-docs to include How-to section links
- Update README.md to mark Phase 4 as complete

## Deployment and Testing
- [x] Pre-commit hooks pass (including doc-links validator)
- [ ] Build and deploy to docs.ops.eblu.me to verify rendering

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Reviewed-on: https://forge.ops.eblu.me/eblume/blumeops/pulls/95
2026-02-03 20:17:24 -08:00

2.9 KiB
Raw Blame History

title tags
exploring-the-docs
tutorials
getting-started

Exploring the Documentation

Audiences: All (Owner, AI, Reader, Contributor, Replicator)

This guide explains how the BlumeOps documentation is organized and how to find what you need.

Documentation Structure

The docs follow the Diataxis framework:

Section Purpose When to Use
**[[tutorials/index Tutorials]]** Learning-oriented
**[[reference/index Reference]]** Information-oriented
**[[how-to/index How-to]]** Task-oriented
Explanation (planned) Understanding-oriented "I want to understand why"

Quick Paths by Audience

For Erich (Owner)

You probably want quick access to operational details:

  • how-to/index for common operations (deploy, troubleshoot, update ACLs)
  • reference/index has service URLs, commands, and config locations
  • The zk-docs mise task still works for legacy zettelkasten access
  • ai-assistance-guide explains how to work effectively with Claude

For Claude/AI Agents

Context for effective assistance:

  • Read ai-assistance-guide for operational conventions
  • reference/index has the technical specifics you'll need
  • The repo's CLAUDE.md has critical rules (especially the kubectl context requirement)

For External Readers

Understanding what this is:

  • reference/index shows what's actually running
  • Browse service pages to see specific implementations
  • The repo's README has project context

For Contributors

Getting started with changes:

For Replicators

Replicators are people who want to build their own similar homelab GitOps setup, using BlumeOps as inspiration.

  • replicating-blumeops provides the overview
  • The replication/ tutorials go deep on components
  • Reference pages show specific configuration choices

Using Wiki Links

Documentation uses [[wiki-links]] for cross-references:

  • [[service-name]] links to a reference page
  • [[folder/page]] links to nested pages
  • [[page | Display Text]] customizes the link text

When reading on the web (docs.ops.eblu.me), these render as clickable links. The backlinks panel shows what references each page.

Pre-commit hooks automatically validate that all wiki-links point to existing files and that link targets are unambiguous.

Legacy Content

The docs/zk/ directory contains zettelkasten cards from before the restructuring. These are read-only reference - new content goes in the structured sections. The cards will eventually be migrated or archived.

To view legacy cards:

mise run zk-docs