Update plugin readme

Signed-off-by: Jenah Blitz <jenah.blitz@simplybusiness.com>
This commit is contained in:
Jenah Blitz
2023-01-26 14:39:00 -05:00
parent 8f23856aa9
commit 5d9ee0ef30
+20 -5
View File
@@ -18,14 +18,21 @@ The Airbrake plugin provides connectivity between Backstage and Airbrake (https:
yarn add --cwd packages/backend @backstage/plugin-airbrake-backend
```
3. Add the `EntityAirbrakeContent` to `packages/app/src/components/catalog/EntityPage.tsx` for all the entity pages you want Airbrake to be in:
3. Add the `EntityAirbrakeContent` and `isAirbrakeAvailable` to `packages/app/src/components/catalog/EntityPage.tsx` for all the entity pages you want Airbrake to be in:
```typescript jsx
import { EntityAirbrakeContent } from '@backstage/plugin-airbrake';
import {
EntityAirbrakeContent,
isAirbrakeAvailable,
} from '@backstage/plugin-airbrake';
const serviceEntityPage = (
<EntityLayoutWrapper>
<EntityLayout.Route path="/airbrake" title="Airbrake">
<EntityLayout.Route
if={isAirbrakeAvailable}
path="/airbrake"
title="Airbrake"
>
<EntityAirbrakeContent />
</EntityLayout.Route>
</EntityLayoutWrapper>
@@ -33,7 +40,11 @@ The Airbrake plugin provides connectivity between Backstage and Airbrake (https:
const websiteEntityPage = (
<EntityLayoutWrapper>
<EntityLayout.Route path="/airbrake" title="Airbrake">
<EntityLayout.Route
if={isAirbrakeAvailable}
path="/airbrake"
title="Airbrake"
>
<EntityAirbrakeContent />
</EntityLayout.Route>
</EntityLayoutWrapper>
@@ -41,7 +52,11 @@ The Airbrake plugin provides connectivity between Backstage and Airbrake (https:
const defaultEntityPage = (
<EntityLayoutWrapper>
<EntityLayout.Route path="/airbrake" title="Airbrake">
<EntityLayout.Route
if={isAirbrakeAvailable}
path="/airbrake"
title="Airbrake"
>
<EntityAirbrakeContent />
</EntityLayout.Route>
</EntityLayoutWrapper>