blumeops/docs/how-to/knowledgebase/review-documentation.md
Erich Blume b0bac91ca9 Fix frontmatter field name for Quartz date display (#158)
## Summary

- Rename `date-modified` -> `modified` in all 80 docs and the `docs-check-frontmatter` task

Quartz's `CreatedModifiedDate` plugin recognizes `modified`, `lastmod`, `updated`, and `last-modified` — but not `date-modified`. The wrong field name caused Quartz to ignore frontmatter dates entirely and fall through to filesystem timestamps (UTC inside Dagger), showing Feb 12 on pages built late on Feb 11 PST.

## Test plan

- [x] `mise run docs-check-frontmatter` passes
- [ ] Kick off docs release after merge — verify rendered dates match frontmatter values

Reviewed-on: https://forge.ops.eblu.me/eblume/blumeops/pulls/158
2026-02-11 16:45:12 -08:00

2.5 KiB

title modified tags
Review Documentation 2026-02-09
how-to
documentation
maintenance

Review Documentation

How to periodically review and maintain the BlumeOps knowledge base.

Review by Staleness

Show docs sorted by when they were last reviewed (most stale first):

mise run docs-review

This reads the last-reviewed frontmatter field from each card. Cards without the field are treated as never-reviewed and appear at the top. The script shows a staleness table and then displays the most stale card with a review checklist.

To show more entries in the table:

mise run docs-review -- --limit 30

Marking a Card as Reviewed

After reviewing a card, add or update the last-reviewed field in its frontmatter:

---
title: Some Card
last-reviewed: 2026-02-09
tags:
  - reference
---

Commit this change alongside any fixes you make during the review.

Review Checklist

When reviewing a documentation card, consider:

Check Description
Accuracy Is the information current and correct?
Links Are wiki-links working? Should more be added?
Scope Is the card appropriately sized (not too large/small)?
Category Is it in the right section (reference/how-to/tutorial/explanation)?
Frontmatter Are title and tags appropriate?
Related Should it link to related cards?

Verify Deployed State

For service reference cards, verify the documentation matches reality:

ArgoCD Apps (Kubernetes services)

Check if the app is synced and healthy:

argocd app get <app-name>
argocd app diff <app-name>  # Show pending changes

If out of sync, either the docs are stale or a deployment is pending.

Ansible Roles (indri services)

Check if the role applies idempotently (no changes needed):

mise run provision-indri -- --tags <role> --check --diff

If changes would be made, either the docs are stale or the host has drifted.

Pulumi (Tailscale ACLs, DNS)

Check for drift:

# Tailscale ACLs
cd pulumi/tailscale && pulumi preview

# DNS (Gandi)
cd pulumi/gandi && pulumi preview

If changes are pending, investigate whether docs or infrastructure is stale.

Making Changes

If a card needs updates:

  1. Create a feature branch
  2. Make the edits
  3. Run mise run docs-check-links to verify links
  4. Create a PR for review

See update-documentation for publishing changes.