Runbooks
Runbooks provide step-by-step operational procedures for common tasks and incident response. Each runbook should be self-contained and actionable.
Available Runbooks
| Runbook | Description |
|---|---|
| Deploy to Production | Steps to deploy a new release to production |
| Rollback Release | Emergency rollback procedures |
| Get Electron Logs | Debug electron processes |
Runbook Standards
All runbooks should follow these guidelines:
- Be Specific: Include exact commands, URLs, and credentials locations (never actual credentials)
- Include Prerequisites: List required access, tools, and permissions
- Define Success Criteria: How to verify the procedure completed successfully
- Document Rollback Steps: Every action should have a way to undo it
- Include Contact Information: Who to escalate to if something goes wrong
Template
When creating a new runbook, use the Runbook Template as a starting point.