diff --git a/plugins/api-docs/README.md b/plugins/api-docs/README.md index 5650b378f5..f71b796ec4 100644 --- a/plugins/api-docs/README.md +++ b/plugins/api-docs/README.md @@ -342,7 +342,7 @@ import { ApiExplorerPage } from '@backstage/plugin-api-docs'; ## Old Frontend System -If your Backstage app uses the old frontend system, you need to manually wire the plugin into your app. +If your Backstage app uses the old frontend system, you need to manually wire the plugin into your app as outlined in this section. If you are on the new frontend system, you can skip this. 1. Add the `ApiExplorerPage` extension to the app: diff --git a/plugins/catalog-graph/README.md b/plugins/catalog-graph/README.md index b1af843190..058fc28164 100644 --- a/plugins/catalog-graph/README.md +++ b/plugins/catalog-graph/README.md @@ -143,7 +143,7 @@ import { ## Old Frontend System -If your Backstage app uses the old frontend system, you need to manually wire the plugin into your app. +If your Backstage app uses the old frontend system, you need to manually wire the plugin into your app as outlined in this section. If you are on the new frontend system, you can skip this. 1. Add the `CatalogGraphPage` to your `packages/app/src/App.tsx`: diff --git a/plugins/catalog/README.md b/plugins/catalog/README.md index ae8ddd1033..af8c82b35c 100644 --- a/plugins/catalog/README.md +++ b/plugins/catalog/README.md @@ -24,7 +24,7 @@ Once installed, the plugin is automatically available in your app through the de ## Old Frontend System -If your Backstage app uses the old frontend system, you need to manually wire the plugin into your app. +If your Backstage app uses the old frontend system, you need to manually wire the plugin into your app as outlined in this section. If you are on the new frontend system, you can skip this. ### Add the plugin to your `packages/app` diff --git a/plugins/devtools/README.md b/plugins/devtools/README.md index b049839861..3f9a3da747 100644 --- a/plugins/devtools/README.md +++ b/plugins/devtools/README.md @@ -202,7 +202,7 @@ Here's how to add the Catalog Unprocessed Entities tab: ## Old Frontend System -If your Backstage app uses the old frontend system, you need to manually wire the plugin into your app. +If your Backstage app uses the old frontend system, you need to manually wire the plugin into your app as outlined in this section. If you are on the new frontend system, you can skip this. 1. Open the `packages/app/src/App.tsx` file 2. Then after all the import statements add the following line: @@ -211,7 +211,7 @@ If your Backstage app uses the old frontend system, you need to manually wire th import { DevToolsPage } from '@backstage/plugin-devtools'; ``` -3. In this same file just before the closing ``, this will be near the bottom of the file, add this line: +3. In this same file just before the closing ``, this will be near the bottom of the file, add this line: ```ts } /> diff --git a/plugins/kubernetes/README.md b/plugins/kubernetes/README.md index baf0ab42a3..fe64aea257 100644 --- a/plugins/kubernetes/README.md +++ b/plugins/kubernetes/README.md @@ -14,7 +14,7 @@ See our announcement blog post [New Backstage feature: Kubernetes for Service Ow ## Setup & Configuration -This plugin must be explicitly added to a Backstage app, along with its peer backend plugin. +This plugin must be installed in a Backstage app, along with its peer backend plugin. ```bash # From your Backstage root directory diff --git a/plugins/org/README.md b/plugins/org/README.md index 9c8050e940..062f88fa98 100644 --- a/plugins/org/README.md +++ b/plugins/org/README.md @@ -43,7 +43,7 @@ For the full list of available extensions and their configuration options, see t ## Old Frontend System -If your Backstage app uses the old frontend system, you need to manually wire the plugin into your app. +If your Backstage app uses the old frontend system, you need to manually wire the plugin into your app as outlined in this section. If you are on the new frontend system, you can skip this. ### MyGroupsSidebarItem diff --git a/plugins/scaffolder/README.md b/plugins/scaffolder/README.md index 6a2ad697b5..bc3f0f8ed6 100644 --- a/plugins/scaffolder/README.md +++ b/plugins/scaffolder/README.md @@ -24,18 +24,20 @@ Once installed, the plugin is automatically available in your app through the de ### Troubleshooting -If you encounter the [issue of closing EventStream](https://github.com/backstage/backstage/issues/5535) +If you encounter [issues with early closure of the `EventStream`](https://github.com/backstage/backstage/issues/5535) which auto-updates logs during task execution, you can enable long polling. To do so, update your `packages/app/src/apis.ts` file to register a `ScaffolderClient` with the `useLongPollingLogs` set to `true`. By default, it is `false`. ```typescript import { + AnyApiFactory, createApiFactory, discoveryApiRef, fetchApiRef, identityApiRef, } from '@backstage/core-plugin-api'; +import { scmIntegrationsApiRef } from '@backstage/integration-react'; import { scaffolderApiRef, ScaffolderClient, @@ -60,6 +62,7 @@ export const apis: AnyApiFactory[] = [ }), }), // ... other factories +]; ``` This replaces the default implementation of the `scaffolderApiRef`. @@ -71,11 +74,11 @@ to launch the plugin locally using the `createDevApp` of the `./dev/index.tsx` f To play with it, open a terminal and run the command: `yarn start` within the `./plugins/scaffolder` folder -**NOTE:** Don't forget to open a second terminal and to launch the backend or [backend-next](../../docs/backend-system/index.md) there, using `yarn start` and to specify the locations of the templates to play with ! +**NOTE:** Don't forget to open a second terminal and to launch the backend there, using `yarn start backend` and to specify the locations of the templates to play with! ## Old Frontend System -If your Backstage app uses the old frontend system, you need to manually wire the plugin into your app. +If your Backstage app uses the old frontend system, you need to manually wire the plugin into your app as outlined in this section. If you are on the new frontend system, you can skip this. ### Add the plugin to your `packages/app` diff --git a/plugins/user-settings/README.md b/plugins/user-settings/README.md index 2fa5e5db39..8644001fe1 100644 --- a/plugins/user-settings/README.md +++ b/plugins/user-settings/README.md @@ -22,7 +22,7 @@ Once installed, the plugin is automatically available in your app through the de ## Old Frontend System -If your Backstage app uses the old frontend system, you need to manually wire the plugin into your app. +If your Backstage app uses the old frontend system, you need to manually wire the plugin into your app as outlined in this section. If you are on the new frontend system, you can skip this. ### Components Usage