coulomb/runbook-tutorials
5
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
runbook-tutorials/README.md
tegwick 79996ab249
All checks were successful
CI Smoke / host-smoke (push) Successful in 1s
Details
CI Smoke / container-smoke (push) Successful in 2s
Details
Work Records / validate (push) Successful in 13s
Details
Adopt spec v0.2: schema, semantic validator, operating modes; workplans updated 
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

Assistant: claude-code
Assistant-Model: sonnet
Assistant-Process: 295952@bnt-lap001
Assistant-Session: e93f64ad-516c-46eb-9666-aad8d300c477
2026-09-29 10:49:10 +02:00

1.5 KiB
Raw Blame History

runbook-tutorials

A user interface specialized to present runbook tutorials that with parameters can guide through actual IT administration and operation tasks.

  • Intent: INTENT.md · Scope: SCOPE.md
  • Pack specification: docs/pack-spec.md (v0.1, runnable) and docs/pack-spec-v0.2.md (v0.2: stages, gates, datapoints, actors, modes; validates, not yet runnable). Schemas in schema/. UX findings: docs/ux-review-2026-09-29.md
  • Packs live where the procedure lives: runbooks/<pack>/pack.yaml in the owning repo. Examples: net-kingdom/runbooks/, and here runbooks/example-hello/ and runbooks/showcase-lighthouse/ (a harmless story to try the UI on).
python3 -m rtut validate <repo-root>      # validate every pack
python3 -m rtut list <repo-root>          # id, engine, exercise status, title
python3 -m rtut show <pack.yaml>          # steps with owners and done-when
python3 -m rtut render <pack.yaml> <step> -p name=value
python3 -m rtut launch <pack.yaml>        # legacy-command packs: start the existing console
python3 -m rtut ui <repo-root>            # local web UI on 127.0.0.1:8877: walk a pack, record a run
python3 -m rtut run new|start|verify|done|finish <pack.yaml> ...   # the same run record from the terminal
make test

Status: specification, validator, legacy launch, run records with verification and exercise-status diff, and a first local web UI work. Terminal walk-through mode and the console migration are open (workplans/).