Erich Blume
7ebac4aef6
## Summary - Create tutorials directory structure with index page - Add 5 main tutorials targeting different audiences: - **what-is-blumeops** (Reader, AI) - High-level orientation - **exploring-the-docs** (All) - Navigation guide - **ai-assistance-guide** (AI, Owner) - Context for AI-assisted operations - **contributing** (Contributor) - First contribution workflow - **replicating-blumeops** (Replicator) - Overview for building similar setup - Add 4 replication sub-tutorials: - tailscale-setup, kubernetes-bootstrap, argocd-config, observability-stack - Update README.md to mark Phase 3 complete - Add changelog fragment Each tutorial explicitly identifies its target audiences and links to reference material rather than re-explaining concepts. ## Deployment and Testing - [x] All pre-commit hooks pass (doc-links validates wiki links) - [ ] Build docs via workflow to verify rendering - [ ] Review content for accuracy 🤖 Generated with [Claude Code](https://claude.com/claude-code) Reviewed-on: https://forge.ops.eblu.me/eblume/blumeops/pulls/94
49 lines
1.3 KiB
Markdown
49 lines
1.3 KiB
Markdown
---
|
|
title: docs
|
|
tags:
|
|
- service
|
|
- documentation
|
|
---
|
|
|
|
# Docs (Quartz)
|
|
|
|
Documentation site built with [Quartz](https://quartz.jzhao.xyz/) and served via nginx.
|
|
|
|
## Quick Reference
|
|
|
|
| Property | Value |
|
|
|----------|-------|
|
|
| **URL** | https://docs.ops.eblu.me |
|
|
| **Namespace** | `docs` |
|
|
| **Container** | `registry.ops.eblu.me/blumeops/quartz:v1.0.0` |
|
|
| **Source** | `docs/` directory in blumeops repo |
|
|
| **Build** | Forgejo workflow `build-blumeops.yaml` |
|
|
|
|
## Architecture
|
|
|
|
1. **Source**: Markdown files in `docs/` with Obsidian-compatible wiki-links
|
|
2. **Build**: Forgejo workflow builds Quartz static site on push to main
|
|
3. **Release**: Built assets published as Forgejo release attachments
|
|
4. **Deploy**: Container downloads release bundle on startup, serves via nginx
|
|
|
|
## Release Process
|
|
|
|
Documentation is automatically built and released when changes are pushed to main:
|
|
|
|
1. Workflow detects changes in `docs/` directory
|
|
2. Quartz builds static HTML/CSS/JS
|
|
3. Assets uploaded as release attachment
|
|
4. ArgoCD deployment updated with new `DOCS_RELEASE_URL`
|
|
5. Pod restarts and downloads new bundle
|
|
|
|
## Configuration
|
|
|
|
- **Quartz config**: `quartz.config.ts`
|
|
- **Layout**: `quartz.layout.ts`
|
|
- **ArgoCD app**: `argocd/apps/docs.yaml`
|
|
- **Manifests**: `argocd/manifests/docs/`
|
|
|
|
## Related
|
|
|
|
- [[argocd]] - Deployment management
|
|
- [[forgejo]] - Build workflows
|