Merge pull request #6262 from jamesrenaud/master

Update PagerDuty Plugin Doc
2021-07-05 11:28:21 +02:00
parent c9b712c6c3 d1bd7bb825
commit 9b743a33b8
6 changed files with 19 additions and 4 deletions
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-pagerduty': patch
+---
+
+Update README
@@ -8,11 +8,21 @@ There is also an easy way to trigger an alarm directly to the person who is curr

 This plugin requires that entities are annotated with an [integration key](https://support.pagerduty.com/docs/services-and-integrations#add-integrations-to-an-existing-service). See more further down in this document.

-This plugin provides:
+## Features

- A list of incidents
- A way to trigger an alarm to the person on-call
- Information details about the person on-call
+### View any open incidents
+
+![PagerDuty plugin showing no incidents and the on-call rotation](doc/pd1.png)
+
+### Email link, and view contact information for staff on call
+
+![PagerDuty plugin showing on-call rotation contact information](doc/pd2.png)
+
+### Trigger an incident for a service
+
+![PagerDuty plugin popup modal for creating an incident](doc/pd3.png)
+
+![PagerDuty plugin showing an active incident](doc/pd4.png)

 ## Setup instructions