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

chore: update documentation for exporting the plugin

Browse Source 
Signed-off-by: blam <ben@blam.sh>
Signed-off-by: ivgo <ivgo@spreadgroup.com>
This commit is contained in:
ivgo
2023-06-27 11:47:59 +02:00
parent 57585d89f9
commit e6f362887c
1 changed files with 4 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/catalog-unprocessed-entities/README.md
+4 -9
View File
@@ -51,17 +51,12 @@ import { useApi } from '@backstage/core-plugin-api';
const catalogUnprocessedEntitiesApi = useApi(catalogUnprocessedEntitiesApiRef);
```
Note that you will need to add the API implementation to avoid your instance to crash due to "missing implementation for apiRef". To do so, add the following lines:
Note that if you are not rendering the `CatalogUnprocessedEntitiesPage` in the `App.tsx` tree, you will need to export the `catalogUnproccessedEntitiesPlugin` from your `plugins.ts` file to setup the plugin otherwise you will receive an error like `No implementation available for apiRef{plugin.catalog-unprocessed-entities.service}`
```typescript
// In packages/app/src/apis.ts
import { catalogUnprocessedEntitiesPlugin } from '@backstage/plugin-catalog-unprocessed-entities';
export const apis: AnyApiFactory[] = [
// ...other API implementations
...catalogUnprocessedEntitiesPlugin.getApis(),
];
// In packages/app/src/plugins.ts
...
export { catalogUnprocessedEntitiesPlugin } from '@backstage/plugin-catalog-unprocessed-entities';
```
## Getting started