diff --git a/microsite/sidebars.ts b/microsite/sidebars.ts index cf893d6895..3cffa45747 100644 --- a/microsite/sidebars.ts +++ b/microsite/sidebars.ts @@ -551,15 +551,15 @@ export default { ), sidebarElementWithIndex( { - label: 'New Frontend System', - description: 'New frontend system components and architecture.', + label: 'Frontend System', + description: 'Frontend system components and architecture.', }, [ 'frontend-system/index', sidebarElementWithIndex( { label: 'Architecture', - description: 'Architecture of the new frontend system.', + description: 'Architecture of the frontend system.', differentiator: 'frontend-system/', }, [ diff --git a/plugins/catalog-import/README.md b/plugins/catalog-import/README.md index ba98d19f0b..efb7c84fa3 100644 --- a/plugins/catalog-import/README.md +++ b/plugins/catalog-import/README.md @@ -98,7 +98,11 @@ Following React components accept optional props for providing custom example en ## Old Frontend System -If your Backstage app uses the old frontend system, add the `CatalogImportPage` extension to the 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 `CatalogImportPage` extension to the app: ```tsx // packages/app/src/App.tsx diff --git a/plugins/catalog-unprocessed-entities/README.md b/plugins/catalog-unprocessed-entities/README.md index 8cdf275851..fc20168b80 100644 --- a/plugins/catalog-unprocessed-entities/README.md +++ b/plugins/catalog-unprocessed-entities/README.md @@ -47,7 +47,11 @@ app: ## Old Frontend System -If your Backstage app uses the old frontend system, import into your `App.tsx` and include into the `` component: +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. + +Import it into your `App.tsx` and include it in the `` component: ```tsx title="packages/app/src/App.tsx" import { CatalogUnprocessedEntitiesPage } from '@backstage/plugin-catalog-unprocessed-entities'; diff --git a/plugins/mui-to-bui/README.md b/plugins/mui-to-bui/README.md index 4217f103a8..0b760c4ef2 100644 --- a/plugins/mui-to-bui/README.md +++ b/plugins/mui-to-bui/README.md @@ -21,7 +21,11 @@ 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, add a route for the page in 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 a route for the page in your app: ```tsx // packages/app/src/App.tsx diff --git a/plugins/scaffolder/README.md b/plugins/scaffolder/README.md index bc3f0f8ed6..9c9ca15dfa 100644 --- a/plugins/scaffolder/README.md +++ b/plugins/scaffolder/README.md @@ -25,9 +25,9 @@ Once installed, the plugin is automatically available in your app through the de ### Troubleshooting 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`. +used to auto-update logs during task execution, you can work around them by enabling +long polling. To do so, update your `packages/app/src/apis.ts` file to register a +`ScaffolderClient` with `useLongPollingLogs` set to `true`. By default, it is `false`. ```typescript import { @@ -74,7 +74,8 @@ 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 there, using `yarn start backend` and to specify the locations of the templates to play with! +**NOTE:** Don't forget to open a second terminal, start your Backstage backend there, +and configure the template locations that you want to test. ## Old Frontend System