Add a new runbook
To add a new runbook, you will create a file in the
runbooks/source directory of the cloud-platform repository.
git pullto get the latest changes
- Create a feature branch for your new runbook
make previewto start a development webserver to view your changes
Add your runbook as a new file in the [source] directory
Your filename must match
Your file must have a header section like this
--- title: Add a new runbook weight: 9999 last_reviewed_on: 2020-04-21 review_in: 3 months ---
weightvalue controls ordering in the table of contents
position * 100to leave enough room for new runbooks to be inserted without reordering
Do not put leading zeroes on the
weightvalue, they won’t work
Your content must start with a markdown heading one line, e.g.
# Add a new runbook
You can also use this to use the title as the heading
# <%= current_page.data.title %>
6. Push your feature branch and raise a PR
7. Merge your PR and delete your feature branch
A GitHub action will compile and deploy a new version of the runbooks guide, with your changes.