diff --git a/packages/app-next/app-config.yaml b/packages/app-next/app-config.yaml index 1121cfc0d5..8e6322e366 100644 --- a/packages/app-next/app-config.yaml +++ b/packages/app-next/app-config.yaml @@ -111,6 +111,11 @@ app: # - entity-content:azure-devops/pull-requests # - entity-content:azure-devops/git-tags + # Enable the catalog-unprocessed-entities tab in devtools + - devtools-content:catalog-unprocessed-entities: true + # Disable the catalog-unprocessed-entities element outside devtools + - page:catalog-unprocessed-entities: false + # scmAuthExtension: >- # createScmAuthExtension({ # id: 'apis.scmAuth.addons.ghe', diff --git a/packages/app-next/src/App.tsx b/packages/app-next/src/App.tsx index 6c567f3fe1..47f717c7ee 100644 --- a/packages/app-next/src/App.tsx +++ b/packages/app-next/src/App.tsx @@ -45,6 +45,8 @@ import { convertLegacyPageExtension } from '@backstage/core-compat-api'; import { convertLegacyEntityContentExtension } from '@backstage/plugin-catalog-react/alpha'; import { pluginInfoResolver } from './pluginInfoResolver'; import { appModuleNav } from './modules/appModuleNav'; +import devtoolsPlugin from '@backstage/plugin-devtools/alpha'; +import { unprocessedEntitiesDevToolsContent } from '@backstage/plugin-catalog-unprocessed-entities/alpha'; /* @@ -116,6 +118,11 @@ const notFoundErrorPageModule = createFrontendModule({ extensions: [notFoundErrorPage], }); +const devtoolsPluginUnprocessed = createFrontendModule({ + pluginId: 'catalog-unprocessed-entities', + extensions: [unprocessedEntitiesDevToolsContent], +}); + const collectedLegacyPlugins = convertLegacyAppRoot( } /> @@ -133,6 +140,8 @@ const app = createApp({ notFoundErrorPageModule, appModuleNav, customHomePageModule, + devtoolsPlugin, + devtoolsPluginUnprocessed, ...collectedLegacyPlugins, ], advanced: { diff --git a/plugins/catalog-unprocessed-entities/README.md b/plugins/catalog-unprocessed-entities/README.md index 98bdf953d2..b39a4a7ad4 100644 --- a/plugins/catalog-unprocessed-entities/README.md +++ b/plugins/catalog-unprocessed-entities/README.md @@ -55,21 +55,33 @@ import catalogUnprocessedEntitiesPlugin from '@backstage/plugin-catalog-unproces import { unprocessedEntitiesDevToolsContent } from '@backstage/plugin-catalog-unprocessed-entities/alpha'; // Optionally add unprocessed entities route to devtools -const appFeature = createFrontendModule({ - pluginId: 'app', +const devtoolsPluginUnprocessed = createFrontendModule({ + pluginId: 'catalog-unprocessed-entities', extensions: [unprocessedEntitiesDevToolsContent], }); export const app = createApp({ features: [ - appFeature, // ... catalogUnprocessedEntitiesPlugin, + + // Optionally add unprocessed entities route to devtools + devtoolsPluginUnprocessed, + devtoolsPlugin, // devtools plugin needs to be added too, if autodiscover is disabled // ... ], }); ``` +```yaml +app: + extensions: + # Enable the catalog-unprocessed-entities tab in devtools + - devtools-content:catalog-unprocessed-entities: true + # Disable the catalog-unprocessed-entities element outside devtools including the sidebar + - page:catalog-unprocessed-entities: false +``` + ## Customization If you want to use the provided endpoints in a different way, you can use the ApiRef doing the following: diff --git a/plugins/catalog-unprocessed-entities/src/alpha/devToolsRoute.tsx b/plugins/catalog-unprocessed-entities/src/alpha/devToolsContent.tsx similarity index 98% rename from plugins/catalog-unprocessed-entities/src/alpha/devToolsRoute.tsx rename to plugins/catalog-unprocessed-entities/src/alpha/devToolsContent.tsx index 505648da4b..3dcdc0ad6b 100644 --- a/plugins/catalog-unprocessed-entities/src/alpha/devToolsRoute.tsx +++ b/plugins/catalog-unprocessed-entities/src/alpha/devToolsContent.tsx @@ -23,6 +23,7 @@ import { DevToolsContentBlueprint } from '@backstage/plugin-devtools-react'; */ export const unprocessedEntitiesDevToolsContent = DevToolsContentBlueprint.make( { + disabled: true, params: { path: 'unprocessed-entities', title: 'Unprocessed Entities', diff --git a/plugins/catalog-unprocessed-entities/src/alpha/index.ts b/plugins/catalog-unprocessed-entities/src/alpha/index.ts index 13c527949f..001fa77643 100644 --- a/plugins/catalog-unprocessed-entities/src/alpha/index.ts +++ b/plugins/catalog-unprocessed-entities/src/alpha/index.ts @@ -15,4 +15,4 @@ */ export { default } from './plugin'; -export { unprocessedEntitiesDevToolsContent } from './devToolsRoute'; +export { unprocessedEntitiesDevToolsContent } from './devToolsContent'; diff --git a/plugins/devtools-react/src/index.ts b/plugins/devtools-react/src/index.ts index 822b885769..70b4915ae8 100644 --- a/plugins/devtools-react/src/index.ts +++ b/plugins/devtools-react/src/index.ts @@ -22,4 +22,4 @@ export { type DevToolsContentBlueprintParams, DevToolsContentBlueprint, -} from './devToolsContentBlueprint.tsx'; +} from './devToolsContentBlueprint'; diff --git a/plugins/devtools/README.md b/plugins/devtools/README.md index 967f3693a6..b23c35d4dd 100644 --- a/plugins/devtools/README.md +++ b/plugins/devtools/README.md @@ -179,20 +179,20 @@ import { DevToolsContentBlueprint } from '@backstage/plugin-devtools-react'; export const unprocessedEntitiesDevToolsContent = DevToolsContentBlueprint.make( { + disabled: true, params: { path: 'unprocessed-entities', title: 'Unprocessed Entities', loader: () => - import('../components/UnprocessedEntities').then( - ({ UnprocessedEntitiesContent }) => - createElement(UnprocessedEntitiesContent), - ), + import('../components/UnprocessedEntities').then(m => ( + + )), }, }, ); const appFeature = createFrontendModule({ - pluginId: 'app', + pluginId: 'catalog-unprocessed-entities', extensions: [unprocessedEntitiesDevToolsContent], }); ```