Skip to content

Commit f5d7316

Browse files
Merge pull request #17 from PagerDuty/feat/DEVECO-328-update-docs-after-service-mappings-release
feat: [DEVECO-328] Update docs after the release of service mappings
2 parents d1fa243 + 4fd304b commit f5d7316

6 files changed

Lines changed: 18 additions & 14 deletions

File tree

docs/advanced/service-entity-mapping.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ This can of course be automated through the use of PagerDuty's APIs but it's sti
66

77
For that reason, we created a `PagerDutyPage` component that is intended to be the single place for advanced configurations related to this plugin.
88

9-
> At this point in time the `PagerDutyPage` only allows Admins to map existing PagerDuty services to Backstage entities. Other features will be released in the future.
10-
119
## Installing dependencies
1210

1311
In order to set this up in your Backstage instance you should install the necessary packages first by running the following command. This command will install the entity processor module that we will configure later on.
@@ -92,16 +90,23 @@ Now, Backstage Admins will have the option to configure the mapping between Page
9290

9391
## Mapping services to entities
9492

95-
Once you navigate to the new `/pagerduty` route will see a page similar to the one below. On the table you will see a list of all your PagerDuty services, their current mapping, and the mapping status.
93+
Once you navigate to the new `/pagerduty` route you will see a page similar to the one below. On the table you will see a list of all your Backstage entities, their current mapping, and the mapping status.
9694

9795
![service-entity-mapping](../images/service-entity-mapping.png)
9896

99-
To define the mapping between existing PagerDuty services and Backstage entities you need to select the edit option on the right. Once you do so, a new modal screen will pop up. Here, you can choose from a list of available Backstage entities that you want to map to the PagerDuty service.
97+
To define the mapping between existing PagerDuty services and Backstage entities you need to select the edit option on the right. Once you do so, a new modal screen will pop up. Here, you can choose from a list of suggested PagerDuty services that you want to map to the Backstage entity. Use Auto-Mapping to receive intelligent suggestions that will help you quickly find and map services.
98+
99+
![service-auto-mapping-modal](../images/service-entity-auto-mapping-modal.png)
100+
101+
### Editing a mapping
102+
103+
Click the pencil icon to open the mapping editor with enhanced search and filtering. Quickly locate the right entity by searching for service names or IDs, or filter by team to see contextually relevant suggestions.
104+
105+
![service-mapping-edit](../images/service-entity-mapping-modal.png)
100106

101-
!!! warning
102-
Currently we only support 1:1 mapping between PagerDuty services and Backstage entities due to a limitation on the `PagerDutyCard` that only supports one service at a time. There is work in progress to overcome this limitation.
107+
### Removing a mapping
103108

104-
![service-mapping-modal](../images/service-entity-mapping-modal.png)
109+
To unmap a service, click the pencil icon and select "None" from the dropdown.
105110

106111
Once you select a new mapping, Backstage Entity Processor will be instructed to run and update the Backstage entity configuration. This is a best-effort action and the configuration update might not be immediate.
107112

docs/capabilities.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,13 @@ The PagerDuty plugin allows users to create incidents directly from Backstage. Y
5353

5454
### Map existing PagerDuty services to Backstage entities
5555

56-
The PagerDuty plugin for Backstage allows Admins to add a `PagerDutyPage` component to their Backstage installation in order to easily map their existing PagerDuty services to Backstage entities without the need to make code changes to the service configuration.
56+
The PagerDuty plugin for Backstage allows Admins to add a `PagerDutyPage` component to their Backstage installation to easily map their PagerDuty services to Backstage entities without needing code changes to the service configuration.
5757

58-
!!! warning
59-
This feature currently supports 1:1 mapping between services and entities due to a limitation on the `PagerDutyCard` that only allows one service to be configured at a time.
58+
The mapping interface includes intelligent service suggestions, searchable drop-downs, and team-based recommendations to streamline the setup process, especially for organizations with large service catalogs.
6059

6160
![service-entity-mapping](images/service-entity-mapping.png)
6261

63-
This feature leverages the entity processor module to make the necessary updates to each Backstage entity configuration. The `PagerDutyPage` allows admins to see the status of each entity and decide whether to make the necessary change in source code to ensure the configuration is in sync.
62+
This feature leverages the entity processor module to make the necessary updates to each Backstage entity automatically. The searchable interface and intelligent suggestions help you quickly find and map services, especially useful for large service catalogs with hundreds or thousands of services. Admins can decide whether to make the necessary changes in source code to ensure the mapping stays in sync.
6463

6564
### Sync service dependencies between Backstage and PagerDuty
6665

137 KB
Loading
65.3 KB
Loading
-12.1 KB
Loading

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ We are working on some cool new features and capabilities. Here are some of them
6262
- [x] Improving UI for the existing PagerDuty Card
6363
- [x] Adding support for multiple PagerDuty accounts in the same Backstage instance
6464
- [x] Enabling service dependency sync between Backstage and PagerDuty
65-
- [ ] Adding support for multiple services on the same card
66-
- [ ] Adding support for a Team PagerDuty card
67-
- [ ] And many more ...
65+
- [x] Service Mapping
66+
- [ ] Service Custom Field Mapping
67+
- [ ] Runbook Automation integration
6868

6969
For more details on what is in progress and what we are considering refer to the [project page](https://github.com/orgs/PagerDuty/projects/22) on GitHub.

0 commit comments

Comments
 (0)