Flow doc site: set up runbook
Open
Nobody has claimed this yet.
Developer Tool Team
Feature
Feedback
- Dominant language
- Go
- Stars
- 361
- Forks
- 159
- PR merge metrics
- No merged PRs in 30d
Description
Issue To Be Solved
A on-call runbook is needed to cover topics including but not limited to:
- deployment process (already documented; ping kerry to link it)
- when the app is down, how do we get started to debug
- ensure everyone in the team has permissions needed to perform dev-ops
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are mentioned. Start by locating the Flow documentation site and the existing deployment documentation, then define the runbook structure with the team; done means it links the deployment process, explains how to begin debugging an unavailable app, and documents the permissions needed for dev-ops work.
Written by the indexing model from the issue text.
Assessment
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100