From 9e4729ad956b9c319aa8d06f5c9b6544b78ff374 Mon Sep 17 00:00:00 2001 From: secustor Date: Wed, 3 Sep 2025 19:07:48 +0200 Subject: [PATCH] docs: add instructions to readmes Signed-off-by: secustor --- .../catalog-unprocessed-entities/README.md | 10 +++++-- plugins/devtools/README.md | 27 +++++++++++++++++++ 2 files changed, 35 insertions(+), 2 deletions(-) diff --git a/plugins/catalog-unprocessed-entities/README.md b/plugins/catalog-unprocessed-entities/README.md index ebadbb7054..3918d97e50 100644 --- a/plugins/catalog-unprocessed-entities/README.md +++ b/plugins/catalog-unprocessed-entities/README.md @@ -52,16 +52,22 @@ Import `catalogUnprocessedEntitiesPlugin` in your `App.tsx` and add it to your a ```typescript import catalogUnprocessedEntitiesPlugin from '@backstage/plugin-catalog-unprocessed-entities'; - -// ... +import { unprocessedEntitiesDevToolsRoute } from '@backstage/plugin-catalog-unprocessed-entities/alpha'; export const app = createApp({ features: [ + appFeature, // ... catalogUnprocessedEntitiesPlugin, // ... ], }); + +// Optionally add unprocessed entities route to devtools +const appFeature = createFrontendModule({ + pluginId: 'app', + extensions: [unprocessedEntitiesDevToolsRoute], +}); ``` ## Customization diff --git a/plugins/devtools/README.md b/plugins/devtools/README.md index 3d82190c2f..1112de0d36 100644 --- a/plugins/devtools/README.md +++ b/plugins/devtools/README.md @@ -160,6 +160,33 @@ You can also add tabs to show content from other plugins that fit well with the #### Catalog Unprocessed Entities Tab +##### New Frontend System + +Create an extension and/or load a 3rd party extension to add additional tabs. + +```tsx +import { DevToolsRouteBlueprint } from '@backstage/plugin-devtools-react'; + +export const unprocessedEntitiesDevToolsRoute = DevToolsRouteBlueprint.make({ + params: { + path: 'unprocessed-entities', + title: 'Unprocessed Entities', + loader: () => + import('../components/UnprocessedEntities').then( + ({ UnprocessedEntitiesContent }) => + createElement(UnprocessedEntitiesContent), + ), + }, +}); + +const appFeature = createFrontendModule({ + pluginId: 'app', + extensions: [unprocessedEntitiesDevToolsRoute], +}); +``` + +##### Old System + Here's how to add the Catalog Unprocessed Entities tab: 1. Install and setup the [Catalog Unprocessed Entities plugin](https://github.com/backstage/backstage/tree/master/plugins/catalog-unprocessed-entities) as per its documentation