Erich Blume
dc46eb7def
## Summary - Updated frontmatter `title:` in all 63 doc cards from slug-case to human-readable (e.g. `borgmatic` → `Borgmatic`, `ai-assistance-guide` → `AI Assistance Guide`) - Titles now closely match file stems so `[[wiki-links]]` render naturally without alternate anchor text - Corrected titles that diverged from stems (e.g. `host-inventory` → `Hosts`, `grafana-alloy` → `Alloy`, `argocd-applications` → `Apps`) - Deleted `title-test-alpha.md` and `title-test-beta.md` test cards and removed their reference index entry ## Deployment and Testing - [x] `docs-check-links` passes — all wiki-links valid - [x] `docs-check-index` passes - [x] `docs-check-filenames` passes - [ ] Verify titles render correctly on docs site after deploy Reviewed-on: https://forge.ops.eblu.me/eblume/blumeops/pulls/117
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
|