Add Phase 3 tutorials with audience targeting
Create tutorials directory with learning-oriented content: - what-is-blumeops: High-level orientation (Reader, AI) - exploring-the-docs: Navigation guide (All audiences) - ai-assistance-guide: Context for AI assistance (AI, Owner) - contributing: First contribution workflow (Contributor) - replicating-blumeops: Overview for replicators Add replication sub-tutorials: - tailscale-setup: Networking foundation - kubernetes-bootstrap: Cluster setup - argocd-config: GitOps configuration - observability-stack: Metrics, logs, dashboards Each tutorial explicitly identifies target audiences and links heavily to reference material rather than re-explaining. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
bf03d71780
commit
50046f42f8
12 changed files with 1361 additions and 7 deletions
78
docs/tutorials/exploring-the-docs.md
Normal file
78
docs/tutorials/exploring-the-docs.md
Normal file
|
|
@ -0,0 +1,78 @@
|
|||
---
|
||||
title: exploring-the-docs
|
||||
tags:
|
||||
- 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](https://diataxis.fr/) framework:
|
||||
|
||||
| Section | Purpose | When to Use |
|
||||
|---------|---------|-------------|
|
||||
| **[[tutorials/index | Tutorials]]** | Learning-oriented | "I'm new and want to understand" |
|
||||
| **[[reference/index | Reference]]** | Information-oriented | "I need specific technical details" |
|
||||
| **How-to** (planned) | Task-oriented | "I need to do X" |
|
||||
| **Explanation** (planned) | Understanding-oriented | "I want to understand why" |
|
||||
|
||||
## Quick Paths by Audience
|
||||
|
||||
### For Erich (Owner)
|
||||
|
||||
You probably want quick access to operational details:
|
||||
- [[reference/index|Reference]] 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|Reference]] 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:
|
||||
- [[what-is-blumeops]] gives the high-level overview
|
||||
- [[reference/index|Reference]] shows what's actually running
|
||||
- Browse service pages to see specific implementations
|
||||
|
||||
### For Contributors
|
||||
|
||||
Getting started with changes:
|
||||
- [[contributing]] walks through the workflow
|
||||
- [[reference/index|Reference]] tells you where things live
|
||||
- The `CLAUDE.md` in the repo root has contribution rules
|
||||
|
||||
### For Replicators
|
||||
|
||||
Building your own:
|
||||
- [[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.
|
||||
|
||||
## 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:
|
||||
```bash
|
||||
mise run zk-docs
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue