Add Infrastructure Planning Policy, Database Guidelines, and Terraform Style Guide - #89
Conversation
…m style guide New handbook pages: - infra-planning-policy.md: 12 guiding principles (scale-to-zero, Zero Trust, IaC, one-tool-owns-each-resource, reliability & delivery, observability, environments, backups/DR, secrets, deploy safety, cost, managed-vs-self-host) plus grouped references. - database-guidelines.md: SQL vs NoSQL selection and SQL schema/style guidance. - style-guide-terraform.md: Terraform/OpenTofu coding conventions. - config.mts: sidebar entries for the three pages. Refs #88 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…h; work already committed locally)
|
Status check on this assigned PR: the branch is empty — but the implementation already exists locally.
Next step is captured as a ticket (no re-implementation — just land the existing commit here, then fill the PR template + evidence):
🤖 auto-posted by sn0wm1ku/ghDuty · co-authored by Claude (claude-opus-4-8) |
…nning-docs' into worktree-infra-planning-policy
- Sidebar: move Database Guidelines under Development Guide (sibling of Style Guide) instead of a top-level Guideline item. - development-guide.md: add a subsection linking Database Guidelines, and list Terraform in the Style Guide languages. - style-guide.md: list the Terraform Style Guide alongside the other per-language guides. Refs #88 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
sn0wm1ku
left a comment
There was a problem hiding this comment.
Approving: infrastructure planning policy plus database and Terraform guidelines. Verified pnpm docs:build passes with no dead-link or build errors (all internal cross-links resolve), and the three new pages render with correct sidebar nesting (Infrastructure Planning Policy under Policies, Database Guidelines under Development Guide, Terraform under Style Guide) via docs:preview. Additive documentation, no runtime surface.
1. Target
2. Specification / Test Plan
Adds an infrastructure planning policy and two supporting guideline pages to the
handbook, grounded in big-tech decision frameworks (AWS / Azure / Google
Well-Architected, Google SRE, DORA, The Twelve-Factor App, OWASP / CIS / NIST)
and right-sized for an SME. All external references were fetched and verified
live.
Pages added:
doc/infra-planning-policy.md(Policies) — 12 guiding principles: scale tozero, Zero Trust, IaC mandatory, one-tool-owns-each-resource, reliability &
delivery measured, observability, environments & promotion, backups & DR,
secrets & least-privilege, deploy safely & reversibly, cost as a design
constraint, managed-over-self-hosted — plus grouped references.
doc/database-guidelines.md(Guideline → Development Guide) — choosing a datastore (SQL vs NoSQL) and structuring relational schemas, including OSBR's SQL
house style.
doc/style-guide-terraform.md(Style Guide) — Terraform / OpenTofu codingconventions (RFC 2119 levels, industry 🌎 / house 🏠 tags).
Wiring:
doc/.vitepress/config.mts— sidebar entries: Infrastructure Planning Policyunder Policies, Database Guidelines nested under Development Guide, Terraform
under Style Guide.
doc/development-guide.mdanddoc/style-guide.md— link the new pages fromthe Development Guide and Style Guide indexes.
Test plan:
pnpm docs:buildpasses — 18 markdown files including the 3 new pages, nobuild errors. VitePress fails the build on dead links, so a clean build
confirms every internal cross-link resolves.
node --check doc/.vitepress/config.mtspasses.pnpm docs:preview(see §5).3. Additional Instructions / Notes for Shipping (optional)
N/A
4. Check before Review Request
5. Evidence
Verification:
pnpm docs:build→build completewith no dead-link or build errors; all 18markdown files (including the 3 new pages) rendered.
pnpm docs:previewfor the three newpages (Infrastructure Planning Policy, Database Guidelines, Terraform Style
Guide), showing the pages render and the sidebar nesting is correct
(Infrastructure Planning Policy under Policies; Database Guidelines under
Development Guide; Terraform under Style Guide).