Tutorials

Step-by-step tutorials covering single-node operation, multi-node fleet updates, crash recovery, OS reconstruction, portability, and validation labs.

Tutorials vs Runbooks — placement rule

Section

Purpose

Tone

Audience state

Tutorials

Teach or validate expected behavior. Demonstrate that the system does what the spec says, with reproducible inputs and observable outputs.

Indicative, demonstrative. “Here is how it works; here is the evidence it works.”

Calm, learning, producing evidence.

Runbooks

Tell operators what to do during bring-up, incidents, failures, drills, or recovery.

Imperative. “Run X; check Y; if Z, then…”

Under time pressure, sometimes under fire.

If a doc teaches a concept or produces an evidence artifact, it belongs under Tutorials. If a doc tells someone to type a command right now to recover or proceed, it belongs under Runbooks. The Demo Runbook is the canonical example: it walks the operator through make demo-up / make demo-run step-by-step including failure drills — so it lives under Runbooks → Demo Runbook, not here.

Installed: the same Demo Runbook documents the installed-operator equivalents (bash demo/scripts/demo_up.sh plus the three numbered scripts) in its “Operator paths” preamble; the placement rule applies to both forms.

Contributor placement guidance for new docs lives at contributing/doc-placement.md.

CE Concepts

Numbered conceptual tutorials covering the single-node and multi-node flows on CE-tier (Community Edition) artifacts. These teach the deterministic-relay model end-to-end without requiring a Controlled Deployment / orchestrator / fleet topology.

Controlled Concepts — A future group covering orchestrator-backed, fleet-scale concepts (signed-bundle provenance, staged rollout policy, fleet-state derivation, audit-completeness in the controlled deployment). The pages will land here when the Controlled-deployment docs surface stabilizes.

Validation Evidence

Validation labs and proof reports — reproducible-input, reproducible-output tutorials that double as evidence artifacts for audit and partner-readiness review. Each page captures a specific claim (rollout latency, HA failover, relay throughput, etc.) and walks through how to produce the evidence.

Other Tutorials

Mixed-purpose tutorials that don’t yet fit cleanly into CE Concepts or Validation Evidence. Concept-shaped pages here are candidates for CE Concepts; the previously-listed runbook-shaped pages (operator-runbook, orchestrator-ha-runbook, integrity-failure-drill) have been moved to Runbooks per the placement rule.

The HA orchestrator operator runbook is published in the self-hosted tier: see the self-hosted tier site.