Skip to content

Add Infrastructure Planning Policy, Database Guidelines, and Terraform Style Guide - #89

Merged
sn0wm1ku merged 7 commits into
mainfrom
i88-20260713-1954
Jul 14, 2026
Merged

Add Infrastructure Planning Policy, Database Guidelines, and Terraform Style Guide#89
sn0wm1ku merged 7 commits into
mainfrom
i88-20260713-1954

Conversation

@github-actions

@github-actions github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown

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 to
    zero, 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 data
    store (SQL vs NoSQL) and structuring relational schemas, including OSBR's SQL
    house style.
  • doc/style-guide-terraform.md (Style Guide) — Terraform / OpenTofu coding
    conventions (RFC 2119 levels, industry 🌎 / house 🏠 tags).

Wiring:

  • doc/.vitepress/config.mts — sidebar entries: Infrastructure Planning Policy
    under Policies, Database Guidelines nested under Development Guide, Terraform
    under Style Guide.
  • doc/development-guide.md and doc/style-guide.md — link the new pages from
    the Development Guide and Style Guide indexes.

Test plan:

  • pnpm docs:build passes — 18 markdown files including the 3 new pages, no
    build errors. VitePress fails the build on dead links, so a clean build
    confirms every internal cross-link resolves.
  • node --check doc/.vitepress/config.mts passes.
  • Rendered pages and sidebar nesting verified via pnpm docs:preview (see §5).

3. Additional Instructions / Notes for Shipping (optional)

N/A

4. Check before Review Request

  • Self Review : I reviewed changes by myself and approved them.
    • Ensure there is no sensitive information, typos, unrelated changes, or debugging code.
  • Evidence : I attached evidences to prove the changes.
    • Record and attach a demo video. For minor changes, attaching an image is also acceptable.
    • Evidences should be updated to the latest version when further changes are made.

5. Evidence

Verification:

  • pnpm docs:buildbuild complete with no dead-link or build errors; all 18
    markdown files (including the 3 new pages) rendered.
  • Rendered-page screenshots captured from pnpm docs:preview for the three new
    pages (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).
shot-1-infra-policy shot-2-database shot-3-terraform

@github-actions github-actions Bot added the addition A mirror label for the "Addition" issue type. label Jul 13, 2026
@github-actions github-actions Bot added the addition A mirror label for the "Addition" issue type. label Jul 13, 2026
…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>
@sn0wm1ku

Copy link
Copy Markdown
Member

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)

sn0wm1ku and others added 3 commits July 13, 2026 20:22
…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 sn0wm1ku left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@sn0wm1ku
sn0wm1ku merged commit f36de9f into main Jul 14, 2026
1 check passed
@sn0wm1ku
sn0wm1ku deleted the i88-20260713-1954 branch July 14, 2026 00:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

addition A mirror label for the "Addition" issue type.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Infrastructure Planning Policy, Database Guidelines, and Terraform Style Guide

2 participants