Address PR review feedback for Phase 3 tutorials
Tutorial changes: - Replace what-is-blumeops with adding-a-service tutorial - Update ai-assistance-guide with Mise Tasks table - Update contributing with tooling setup, target revisions, DNS preview - Remove AI-only sections from contributing and exploring-the-docs - Add replicator explanation to exploring-the-docs - Add pre-commit link validation note - Add Core Services phase to replication roadmap - Add docs service to services list in replicating-blumeops New reference cards: - docs.md - Quartz documentation service - tailscale-operator.md - Kubernetes ingress operator - ansible/roles.md - Available ansible roles Other updates: - Add mise to Brewfile - Update docs/index.md to link to exploring-the-docs - Add notes to update exploring-the-docs in future phases - Link tailscale-operator from apps.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
50046f42f8
commit
1e4e72b923
18 changed files with 620 additions and 120 deletions
49
docs/reference/services/docs.md
Normal file
49
docs/reference/services/docs.md
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
---
|
||||
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
|
||||
Loading…
Add table
Add a link
Reference in a new issue