We would like to have runbook to facilitate engineer oncall
- review existing runbook from support which are related to GHES engineering.
A spreadsheet is created now to start with the runbooks that are over 1 year old
- create runbooks for GHES engineering with catagorized topics
A runbook is a how-to guide that focuses on solving a practical problem or targeting a real-world task. Refer to the comapass to decide whether you want to document is a runbook or something else.
- Runbooks will be created with an issue template:
Engineer will fill in the template and corresponding labels for its sub topics will be added accordingly. When the content is filled in, the issue can be marked with runbook-review-ready label, and a reviewer (could be engineer from the topic's AOR or the availability champion) will be assigned to review the issue.
Once review is done runbook-review-approved label will be added by reviewer. An action workflow will create a PR to add content to its corresponding folder with information filled in the issue.
- on closing of ANY sev 1 issue, a comment will be emitted to tag assignees on creating a runbook for the issue.
- on closing of a weekly support issue from oncall project board, always ask if any runbook can be improved.
- summarize periodically on runbook contribution and announce in ghes team slack channel to promote maintenance of runbooks.
This looks great Zheng ! I will echo what Quinn said . . . I'm hoping we can get a good set of runbooks (aka"how to" guides) for specific issues that list a set of instructions describing how a technical issue can be solved (or a customer support issue was solved in the past). I'm hoping that we can create a runbook out of the majority of our SEV-1s that we review in our GHES Availability meetings.