diff --git a/plugins/periskop/README.md b/plugins/periskop/README.md index ecf66c4e24..ecc7349bef 100644 --- a/plugins/periskop/README.md +++ b/plugins/periskop/README.md @@ -6,7 +6,7 @@ ## Periskop aggregated errors -The Periskop Backstage Plugin exposes a component named `PeriskopErrorsTable`. +The Periskop Backstage Plugin exposes a component named `EntityPeriskopErrorsCard`. Each of the entries in the table will direct you to the error details in your deployed Periskop instance location. ![periskop-errors-card](./docs/periskop-plugin-screenshot.png) @@ -27,7 +27,7 @@ yarn add @backstage/plugin-periskop ```tsx // In packages/app/src/components/catalog/EntityPage.tsx -import { PeriskopErrorsTable } from '@backstage/plugin-periskop'; +import { EntityPeriskopErrorsCard } from '@backstage/plugin-periskop'; const componentPage = ( @@ -35,7 +35,7 @@ const componentPage = ( - + diff --git a/plugins/periskop/api-report.md b/plugins/periskop/api-report.md index e60f039d4e..5412b70dfb 100644 --- a/plugins/periskop/api-report.md +++ b/plugins/periskop/api-report.md @@ -102,7 +102,7 @@ export type PeriskopApiOptions = { export const periskopApiRef: ApiRef; // @public (undocumented) -export const PeriskopErrorsTable: () => JSX.Element; +export const EntityPeriskopErrorsCard: () => JSX.Element; // @public (undocumented) export const periskopPlugin: BackstagePlugin<{}, {}>; diff --git a/plugins/periskop/src/components/PeriskopErrorsTable/PeriskopErrorsTable.tsx b/plugins/periskop/src/components/PeriskopErrorsTable/EntityPeriskopErrorsCard.tsx similarity index 99% rename from plugins/periskop/src/components/PeriskopErrorsTable/PeriskopErrorsTable.tsx rename to plugins/periskop/src/components/PeriskopErrorsTable/EntityPeriskopErrorsCard.tsx index e7044a7037..c4c8623f8e 100644 --- a/plugins/periskop/src/components/PeriskopErrorsTable/PeriskopErrorsTable.tsx +++ b/plugins/periskop/src/components/PeriskopErrorsTable/EntityPeriskopErrorsCard.tsx @@ -80,7 +80,7 @@ function isNotFoundInInstance( return (apiResult as NotFoundInInstance)?.body !== undefined; } -export const PeriskopErrorsTable = () => { +export const EntityPeriskopErrorsCard = () => { const { entity } = useEntity(); const entityPeriskopName: string = entity.metadata.annotations?.[PERISKOP_NAME_ANNOTATION] ?? diff --git a/plugins/periskop/src/components/PeriskopErrorsTable/index.ts b/plugins/periskop/src/components/PeriskopErrorsTable/index.ts index 61936dc476..0d0ab65d41 100644 --- a/plugins/periskop/src/components/PeriskopErrorsTable/index.ts +++ b/plugins/periskop/src/components/PeriskopErrorsTable/index.ts @@ -15,7 +15,7 @@ */ export { - PeriskopErrorsTable, + EntityPeriskopErrorsCard, isPeriskopAvailable, PERISKOP_NAME_ANNOTATION, -} from './PeriskopErrorsTable'; +} from './EntityPeriskopErrorsCard'; diff --git a/plugins/periskop/src/extensions.ts b/plugins/periskop/src/extensions.ts index 663be0ec35..990a41f24e 100644 --- a/plugins/periskop/src/extensions.ts +++ b/plugins/periskop/src/extensions.ts @@ -20,13 +20,13 @@ import { createComponentExtension } from '@backstage/core-plugin-api'; /** * @public */ -export const PeriskopErrorsTable = periskopPlugin.provide( +export const EntityPeriskopErrorsCard = periskopPlugin.provide( createComponentExtension({ - name: 'PeriskopErrorsTable', + name: 'EntityPeriskopErrorsCard', component: { lazy: () => - import('./components/PeriskopErrorsTable').then( - m => m.PeriskopErrorsTable, + import('./components/EntityPeriskopErrorsCard').then( + m => m.EntityPeriskopErrorsCard, ), }, }), diff --git a/plugins/periskop/src/index.ts b/plugins/periskop/src/index.ts index a22fc65d73..facb97bcc8 100644 --- a/plugins/periskop/src/index.ts +++ b/plugins/periskop/src/index.ts @@ -15,10 +15,10 @@ */ export { periskopPlugin, periskopApiRef } from './plugin'; -export { PeriskopErrorsTable } from './extensions'; +export { EntityPeriskopErrorsCard } from './extensions'; export { isPeriskopAvailable, PERISKOP_NAME_ANNOTATION, -} from './components/PeriskopErrorsTable'; +} from './components/EntityPeriskopErrorsCard'; export * from './api/index'; export * from './types';