Skip to content

Commit 2879f49

Browse files
committed
docs: updating service dependency docs after enabling pagerduty option
Signed-off-by: Tiago Barbosa <tbarbos@hotmail.com>
1 parent c28af0f commit 2879f49

5 files changed

Lines changed: 46 additions & 5 deletions

File tree

docs/advanced/configure-service-dependency-sync.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,16 @@ This feature is very powerfull for users that want to leverage [PagerDuty Status
1111

1212
This feature is **disabled** by default but can easily be enabled on the PagerDuty advanced configuration page. If you haven't enabled it yet you can do so by following the instructions in [here](/backstage-plugin-docs/advanced/service-entity-mapping/#adding-the-pagerdutypage-component).
1313

14-
![on-call-engineer](https://github.com/user-attachments/assets/f8332378-2439-4b7d-b130-b73acccd666b)
14+
![dependency-sync-strategy](../images/dependency-sync-strategy.png)
1515

16-
Here you can choose to use Backstage as the main source and the plugin will automatically add/remove service dependencies to your mapped entities in PagerDuty. You can optionally choose to merge service dependencies from Backstage and PagerDuty or even keep it disabled.
16+
Here you can choose:
17+
18+
- to use **Backstage as the main source** and the plugin will automatically add/remove service dependencies to your mapped entities in PagerDuty
19+
- to set **PagerDuty as the main source** and the plugin will automatically add/remove entity relations in Backstage
20+
- to **merge service dependencies** from Backstage and PagerDuty
21+
- to keep it **disabled**.
1722

1823
!!! note
1924
The syncing mechanism will overwrite all services on the destination so use this mechanism carefully.
2025

2126
**Example:** You set Backstage as your main source and you already have service dependencies in PagerDuty. Those will be overwritten has Backstage is now configured as the source of thruth.
22-
23-
‼️ **Important**: Due to a Backstage design decision it is not possible to fully overwrite the relations specified in each entity's configuration file. For that reason the option to synchronise strictly from PagerDuty side is not available.
39.6 KB
Loading

docs/release-notes/entity-processor.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,23 @@
11
# Release notes for Entity Processor module
22

3+
## > 0.3.1
4+
5+
[GitHub release](https://github.com/PagerDuty/backstage-plugin-entity-processor/releases/tag/0.3.1)
6+
7+
### Summary
8+
9+
Release **0.3.1** removes a limitation that prevented users from enabling PagerDuty as their main source for syncing service dependencies.
10+
11+
With the help of the Backstage team, we were able to implement a few changes that overcome this limitation and users are now able to set PagerDuty as their main source for service dependencies and get their dependencies sync to Backstage for all mapped entities.
12+
13+
### Changes
14+
15+
- feat: enable pagerduty service dependency sync
16+
17+
### Dependencies
18+
19+
- `@pagerduty/backstage-plugin-common: 0.2.1`
20+
321
## > 0.3.0
422

523
[GitHub release](https://github.com/PagerDuty/backstage-plugin-entity-processor/releases/tag/0.3.0)

docs/release-notes/frontend.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# Release notes for Frontend plugin
22

3+
## > 0.15.1
4+
5+
[GitHub release](https://github.com/PagerDuty/backstage-plugin/releases/tag/0.15.1)
6+
7+
### Summary
8+
9+
This release enables the `PagerDuty` option in the PagerDutyPage component settings which allows users to set PagerDuty as their main source for syncing service dependencies to Backstage.
10+
11+
This feature was disabled due to a limitation on version [0.3.0](https://github.com/PagerDuty/backstage-plugin-entity-processor/releases/tag/0.3.0) of `@pagerduty/backstage-plugin-entity-processor` which is now fixed and released on version [0.3.1](https://github.com/PagerDuty/backstage-plugin-entity-processor/releases/tag/0.3.1).
12+
13+
### Changes
14+
15+
- refactor: enable PagerDuty option on PagerDutyPage
16+
17+
### Dependencies
18+
19+
- `@pagerduty/backstage-plugin-backend: 0.9.0`
20+
- `@pagerduty/backstage-plugin-common: 0.2.1`
21+
- `@pagerduty/backstage-plugin-entity-provider: 0.3.1`
22+
323
## > 0.15.0
424

525
[GitHub release](https://github.com/PagerDuty/backstage-plugin/releases/tag/0.15.0)

overrides/main.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{% block announce %}
44
<div>
55
<p>
6-
<strong>🎉 New release!</strong> <span style="margin-left: 20px;"> Checkout the latest versions for Frontend(<a href="/backstage-plugin-docs/release-notes/frontend/#0150">0.15.0</a>), Backend(<a href="/backstage-plugin-docs/release-notes/backend/#091">0.9.1</a>), Common(<a href="/backstage-plugin-docs/release-notes/common/#021">0.2.1</a>), Scaffolder Actions(<a href="/backstage-plugin-docs/release-notes/scaffolder-actions/#021">0.2.1</a>) and Entity Processor(<a href="/backstage-plugin-docs/release-notes/entity-processor/#030">0.3.0</a>) </span>
6+
<strong>🎉 New release!</strong> <span style="margin-left: 20px;"> Checkout the latest versions for Frontend(<a href="/backstage-plugin-docs/release-notes/frontend/#0151">0.15.1</a>), Backend(<a href="/backstage-plugin-docs/release-notes/backend/#091">0.9.1</a>), Common(<a href="/backstage-plugin-docs/release-notes/common/#021">0.2.1</a>), Scaffolder Actions(<a href="/backstage-plugin-docs/release-notes/scaffolder-actions/#021">0.2.1</a>) and Entity Processor(<a href="/backstage-plugin-docs/release-notes/entity-processor/#031">0.3.1</a>) </span>
77
</p>
88
</div>
99
{% endblock %}

0 commit comments

Comments
 (0)