Skip to main content

Add a runbook

To add a new runbook:

  • Create a new *.html.md.erb file in the source/runbooks directory of this repository, containing the runbook information
  • Add frontmatter metadata at the top of the file using this template:
---
owner_slack: "#developer-experience-alerts"
title: <Runbook Title>
last_reviewed_on: YYYY-MM-DD
review_in: 6 months
---

Use #developer-experience-alerts as the default owner_slack value unless an alternative channel has been explicitly agreed by the team. Use review_in: 6 months as the default review period unless a shorter review cadence is required.

  • Add a corresponding list item in the source/index.html.md.erb file under the title Runbooks title.
## Runbooks
- [Add a runbook](runbooks/add-a-runbook.html)
- [Dependabot Process](runbooks/dependabot-process.html)
...

The link target should be runbooks/[filename].html i.e. if the runbook file is source/runbooks/foobar.html.md.erb then the link target should be runbooks/foobar.html

  • Raise and merge a PR to add your changes to the main branch of this repository
This page was last reviewed on 24 June 2026. It needs to be reviewed again on 24 December 2026 by the page owner #developer-experience-alerts .