Status detail pages with incident issue descriptions
Problem to solve
Incident response teams need a place to publish details such as a full list of systems affected, estimated remediation time, and steps to perform for manual remediation or workarounds. Incident teams can mitigate the flood of support tickets and customer emails that accompany downtime and degraded usage by publishing up-to-date information.
Users and customers want to validate if the problems they are experiencing are systemwide or localized. During an active incident, they want to see up-to-date troubleshooting information to gauge how long and how broadly their usage may be affected to they can plan actions accordingly.
Intended users
See #205164 (closed)
Further details
This work supports the Status Page vision.
Proposal
- When a new incident is created a status detail page is automatically generated
- The text in the description of the incident issue is automatically added the status detail page.
- When the incident issue description is updated, the status page is automatically updated.
- Status detail pages should have a unique, permanent URL so users can link directly to the incident
Out of scope
- This iteration does not include pulling images from the incident issue and rendering them on the status detail page.
- This iteration does not include posting comments to the detail page.
Design
For this issue, we'll be displaying the incident description on the incident detail page only, which (at gitlab) generally includes both the summary and the timeline:
The open/closed badge shown in the design above can be added in a separate issue: #205581 (closed)
Permissions and Security
Since all non-confidential issues that are created in the linked project publish status detail pages, anyone with permissions to create an issue will have the ability to publish a public status detail page.
Documentation
Documentation required. We will need to create a new section in docs called Status page.
Availability & Testing
A new end to end test will be introduced to cover the functionality of this feature, please follow up in E2E test for Status Page with Incidents
What does success look like, and how can we measure that?
What is the type of buyer?
Links / references
Full designs for the MVC and future iterations in Sketch cloud
User flow viewable in Mural