diff --git a/.changeset/bright-pillows-build.md b/.changeset/bright-pillows-build.md new file mode 100644 index 0000000000..9939fddf42 --- /dev/null +++ b/.changeset/bright-pillows-build.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-explore': patch +--- + +Added a section to explore plugin README that describes the customization of explore tools content. diff --git a/plugins/explore/README.md b/plugins/explore/README.md index 8e1cbaed02..94ab0984a0 100644 --- a/plugins/explore/README.md +++ b/plugins/explore/README.md @@ -79,3 +79,39 @@ const routes = ( ); ``` + +## ToolExplorer Content Customization + +Override the `exploreToolsConfigRef` API in `/packages/app/src/apis.ts`. + +```tsx +import { exploreToolsConfigRef } from '@backstage/plugin-explore-react'; + +export const apis: AnyApiFactory[] = [ + ... + + createApiFactory({ + api: exploreToolsConfigRef, + deps: {}, + factory: () => ({ + async getTools() { + return tools; + }, + /* e.g. tools = [ + { + title: 'New Relic', + description:'new relic plugin, + url: '/newrelic', + image: 'https://i.imgur.com/L37ikrX.jpg', + tags: ['newrelic', 'proxy', 'nerdGraph'], + }, + ] + */ + }), + }), + + .... + +]; + +```