jsDoc comment added

Signed-off-by: mufaddal motiwala <mufaddalmm.52@gmail.com>
This commit is contained in:
mufaddal motiwala
2022-02-08 12:09:31 +05:30
parent 22ebeb4575
commit a7abd5f35b
2 changed files with 9 additions and 4 deletions
+1 -3
View File
@@ -9,9 +9,7 @@ import { BackstagePlugin } from '@backstage/core-plugin-api';
import { Entity } from '@backstage/catalog-model';
import { RouteRef } from '@backstage/core-plugin-api';
// Warning: (ae-missing-release-tag) "DashboardSnapshotComponent" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
// @public
export const DashboardSnapshotComponent: ({
guid,
name,
+8 -1
View File
@@ -60,7 +60,14 @@ export const EntityNewRelicDashboardCard = newRelicDashboardPlugin.provide(
},
}),
);
/**
* Render dashboard snapshots from Newrelic in backstage. Use dashboards which have the tag `isDashboardPage: true`
*
* @remarks
* This can be helpful for rendering dashboards outside of Entity Catalog.
*
* @public
*/
export const DashboardSnapshotComponent = newRelicDashboardPlugin.provide(
createComponentExtension({
name: 'DashboardSnapshotComponent',