paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 47 Packages Projects Releases Wiki Activity

Address review feedback on plugin README updates

Browse Source 
- Apply freben's suggested wording for old frontend system sections to
  clarify they can be skipped on the new frontend system
- Fix scaffolder README: add missing imports (AnyApiFactory,
  scmIntegrationsApiRef), closing bracket, and update link text
- Fix devtools README: correct closing tag from `</ FlatRoutes>` to
  `</FlatRoutes>`
- Fix kubernetes README: reword "must be explicitly added" to avoid
  conflicting with feature discovery paragraph

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
This commit is contained in:
Patrik Oldsberg
2026-03-16 13:20:01 +01:00
parent 538c985672
commit 98b6b9701b
8 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/scaffolder/README.md
+6 -3
View File
@@ -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`