diff --git a/docs/advanced/homepage-component.md b/docs/advanced/homepage-component.md index 0f9ae3a..f7c25f8 100644 --- a/docs/advanced/homepage-component.md +++ b/docs/advanced/homepage-component.md @@ -2,6 +2,9 @@ The most common use case for the plugin is to have an instance of the plugin in each service. Still, you might want to have multiple instances of the plugin in your homepage to provide visibility on multiple services at the same time. +!!! warning + The `PagerDutyHomepageCard` has not yet been updated to match the new UI of the `PagerDutyCard` released on version `0.10.0` of the frontend plugin. + If that is your case you might want to leverage the `PagerDutyHomepageCard` component like so. ```html diff --git a/docs/capabilities.md b/docs/capabilities.md index 5ad3d85..27949c6 100644 --- a/docs/capabilities.md +++ b/docs/capabilities.md @@ -27,7 +27,7 @@ See all recent changes sent to PagerDuty through integrations like GitHub, GitLa ### See and contact on call staff -Quickly check who is on call for your service and reach out if necessary. The plugin allows you to email the on call person directly or open the user profile in PagerDuty. +Quickly check who is on call for your service and reach out if necessary. The plugin allows you to see the escalation policy that the on-call user is assigned to and navigate to PagerDuty for more details. ![view-oncall-engineers](images/view-oncall-engineers.png) diff --git a/docs/getting-started/pagerduty.md b/docs/getting-started/pagerduty.md index 555bb6d..08ae313 100644 --- a/docs/getting-started/pagerduty.md +++ b/docs/getting-started/pagerduty.md @@ -65,13 +65,14 @@ In order to use **Scoped OAuth** you need to register an App in PagerDuty. Follo ```typescript abilities.read // used in scaffolder only - change_events.read + analytics.read escalation_policies.read incidents.read oncalls.read schedules.read services.read services.write // used in scaffolder only + standards.read teams.read users.read vendors.read // used in scaffolder only diff --git a/docs/images/change-events-forbidden.png b/docs/images/change-events-forbidden.png index caed55c..ac52f71 100644 Binary files a/docs/images/change-events-forbidden.png and b/docs/images/change-events-forbidden.png differ diff --git a/docs/images/create-incident-button-hidden.png b/docs/images/create-incident-button-hidden.png index b7e389d..04624ed 100644 Binary files a/docs/images/create-incident-button-hidden.png and b/docs/images/create-incident-button-hidden.png differ diff --git a/docs/images/create-incident-button.png b/docs/images/create-incident-button.png index 9a8c3ce..48199a3 100644 Binary files a/docs/images/create-incident-button.png and b/docs/images/create-incident-button.png differ diff --git a/docs/images/list-incidents.png b/docs/images/list-incidents.png index e91d850..f67f3a4 100644 Binary files a/docs/images/list-incidents.png and b/docs/images/list-incidents.png differ diff --git a/docs/images/releases/0100-new-ui.png b/docs/images/releases/0100-new-ui.png new file mode 100644 index 0000000..952ad2f Binary files /dev/null and b/docs/images/releases/0100-new-ui.png differ diff --git a/docs/images/view-oncall-engineers.png b/docs/images/view-oncall-engineers.png index e28fd22..3e3c675 100644 Binary files a/docs/images/view-oncall-engineers.png and b/docs/images/view-oncall-engineers.png differ diff --git a/docs/images/view-recent-changes.png b/docs/images/view-recent-changes.png index d58d9e4..e9c2356 100644 Binary files a/docs/images/view-recent-changes.png and b/docs/images/view-recent-changes.png differ diff --git a/docs/index.md b/docs/index.md index c5c0400..2277560 100644 --- a/docs/index.md +++ b/docs/index.md @@ -56,7 +56,7 @@ We are working on some cool new features and capabilities. Here are some of them - [x] Create scaffolder action to allow services to be created in PagerDuty - [x] Adding support for [Scoped OAuth](https://developer.pagerduty.com/docs/f59fdbd94ceab-o-auth-functionality) -- [ ] Improving UI for the existing PagerDuty Card +- [x] Improving UI for the existing PagerDuty Card - [ ] Adding support for adding multiple services on the same card - [ ] Adding support for a Team PagerDuty card diff --git a/docs/release-notes/backend.md b/docs/release-notes/backend.md index dfb54e5..4bd4751 100644 --- a/docs/release-notes/backend.md +++ b/docs/release-notes/backend.md @@ -1,5 +1,30 @@ # Release notes for Backend plugin +## > 0.5.1 + +[GitHub release](https://github.com/PagerDuty/backstage-plugin-backend/releases/tag/0.5.1) + +### Summary + +This release fixes a bug related to missing API scopes that was preventing the new capabilities introduce by the new UI (frontend 0.10.0). + +### Changes + +- fix: adds the required API scopes for the new UI + +## > 0.5.0 + +[GitHub release](https://github.com/PagerDuty/backstage-plugin-backend/releases/tag/0.5.0) + +### Summary + +This release introduces new backend API endpoints to query **service standards** and **service metrics**. These features are used by the frontend component to provide additional information on the services. + +### Changes + +- feat: apis supporting new card UI +- build(deps): Bump follow-redirects from 1.15.5 to 1.15.6 + ## > 0.4.6 [GitHub release](https://github.com/PagerDuty/backstage-plugin-backend/releases/tag/0.4.6) diff --git a/docs/release-notes/common.md b/docs/release-notes/common.md index a09fd34..7194bf6 100644 --- a/docs/release-notes/common.md +++ b/docs/release-notes/common.md @@ -1,5 +1,18 @@ # Release notes for Frontend plugin +## > 0.1.2 + +[GitHub release](https://github.com/PagerDuty/backstage-plugin-common/releases/tag/0.1.2) + +### Summary + +This release introduces new types to support the new PagerDutyCard UI that requires Service Standards, Service Status and Service Metrics. + +### Changes + +- chore(deps): Bump follow-redirects from 1.15.5 to 1.15.6 +- feat: add types to support updated UI + ## > 0.1.1 [GitHub release](https://github.com/PagerDuty/backstage-plugin-common/releases/tag/0.1.1) @@ -10,7 +23,7 @@ This release introduces a security patch to a third-party dependency. ### Changes -- build(deps): Bump ip from 2.0.0 to 2.0.1 (#29) by @dependabot +- build(deps): Bump ip from 2.0.0 to 2.0.1 ## > 0.1.0 diff --git a/docs/release-notes/frontend.md b/docs/release-notes/frontend.md index 2e55c1f..f7b4bc8 100644 --- a/docs/release-notes/frontend.md +++ b/docs/release-notes/frontend.md @@ -1,5 +1,34 @@ # Release notes for Frontend plugin +## > 0.10.0 + +[GitHub release](https://github.com/PagerDuty/backstage-plugin/releases/tag/0.10.0) + +### Summary + +This release introduces a new UI to the PagerDutyCard that is used on each Entity Page. This new UI introduces: + +- official PagerDuty logo +- clear visibility on incident status and urgency +- service status +- service standards +- visibility on service metrics (total incidents, high urgency incidents, total number of interruptions) +- escalation policy information on the on-call section + +This release also updates the behaviour of some components from the PagerDutyCard. + +- the button to contact the on-call user by email is now removed +- the "create incident" button is now completely hidden in case of `read-only` mode, instead of just disabling the button. + +![0100-new-ui](../images/releases/0100-new-ui.png) + +**For Scoped OAuth users** 👉 This release requires you to add additional scopes to your App Registration in PagerDuty: `analytics.read` and `standards.read`. + +### Changes + +- chore(deps): bump follow-redirects from 1.15.4 to 1.15.6 +- style: refresh PagerDutyCard UI + ## > 0.9.3 [GitHub release](https://github.com/PagerDuty/backstage-plugin/releases/tag/0.9.3) diff --git a/overrides/main.html b/overrides/main.html index 574fa29..c22c63e 100644 --- a/overrides/main.html +++ b/overrides/main.html @@ -3,7 +3,7 @@ {% block announce %}

- 🎉 New release! Checkout the latest versions for Frontend(0.9.3), Backend(0.4.6) and Common(0.1.1) + 🎉 New release! Checkout the latest versions for Frontend(0.10.0), Backend(0.5.1) and Common(0.1.2)

{% endblock %} \ No newline at end of file