Skip to content

Commit

Permalink
docs: new UI release
Browse files Browse the repository at this point in the history
Signed-off-by: Tiago Barbosa <[email protected]>
  • Loading branch information
t1agob committed Mar 23, 2024
1 parent 651aef6 commit 45f61a8
Show file tree
Hide file tree
Showing 15 changed files with 76 additions and 5 deletions.
3 changes: 3 additions & 0 deletions docs/advanced/homepage-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/capabilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
3 changes: 2 additions & 1 deletion docs/getting-started/pagerduty.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Binary file modified docs/images/change-events-forbidden.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/create-incident-button-hidden.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/create-incident-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/list-incidents.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/releases/0100-new-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/view-oncall-engineers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/view-recent-changes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
25 changes: 25 additions & 0 deletions docs/release-notes/backend.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
15 changes: 14 additions & 1 deletion docs/release-notes/common.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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

Expand Down
29 changes: 29 additions & 0 deletions docs/release-notes/frontend.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
2 changes: 1 addition & 1 deletion overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{% block announce %}
<div>
<p>
<strong>🎉 New release!</strong> <span style="margin-left: 20px;"> Checkout the latest versions for Frontend(<a href="/release-notes/frontend/#093">0.9.3</a>), Backend(<a href="/release-notes/backend/#046">0.4.6</a>) and Common(<a href="/release-notes/common/#011">0.1.1</a>) </span>
<strong>🎉 New release!</strong> <span style="margin-left: 20px;"> Checkout the latest versions for Frontend(<a href="/release-notes/frontend/#0100">0.10.0</a>), Backend(<a href="/release-notes/backend/#051">0.5.1</a>) and Common(<a href="/release-notes/common/#012">0.1.2</a>) </span>
</p>
</div>
{% endblock %}

0 comments on commit 45f61a8

Please sign in to comment.