Display Incident Timeline Events
Proposal
Display the timeline events in the incident UI, in a separate timeline tab.
Design
Example view 1 | Example view 2 (with event manually added to the timeline) |
---|---|
- Items added to the timeline are displayed in time order, from oldest to most recent
- Links should be visible and clickable.
- Timeline items added from the incident comments should link back to the original comment.
- Icons will vary depending on the type of timeline item. For a first pass, we will include icons for: Status changes (for documenting status changes), Comments (for timeline items added from the incident comments), Tanuki (when something is published to the status page), and warning (for when the alert is promoted to an incident. Manually added timeline events (and all other events not otherwise specified) will use the clock icon.
- The content should be limited to 280 chars. For the MVC, we'll truncate the text for the display of the timeline event. Full content is visible when editing. Character display limit can be announced in the footer of the text editing field, like this:
- Images aren't displayed in the timeline and are replaced with a link to the image. Text for the link is
image
, title for the link is image alt text (displayed in a tooltip), and paper clip icon is included before the text. - The content should be limited in it's scope, and only provide bold, italic, linking and code blocks.
Engineering breakdown
- Backend to provide events via an API (GraphQL)
- Frontend to consume API and display items
Edited by Sean Arnold