diff --git a/.changeset/rude-sloths-cross.md b/.changeset/rude-sloths-cross.md index 8e22070662..8d3fc486e8 100644 --- a/.changeset/rude-sloths-cross.md +++ b/.changeset/rude-sloths-cross.md @@ -5,4 +5,10 @@ '@backstage/plugin-explore-react': patch --- -Updated to use new @backstage/plugin-explore-backend +Added new `@backstage/plugin-explore-backend` & `@backstage/plugin-explore-common` packages. + +This deprecates the `ExploreToolsConfig` API (in `@backstage/plugin-explore-react`) which is replaced by the `ExploreApi` & `ExploreClient`. The list of `ExploreTool` data can now be provided on the backend by either using the supplied `StaticExploreToolProvider` or by implementing a custom `ExploreToolProvider`. See the [explore-backend README](https://github.com/backstage/backstage/blob/master/plugins/explore-backend/README.md) for full details. + +NOTE: Existing installations that have customized the `ExploreToolConfig` will continue to work through the new `ExploreClient`. However, existing data should be migrated over to new `explore-backend` plugin as `ExploreToolConfig` will be removed in the future. + +BREAKING CHANGE: If you have previously installed the `explore` plugin, but not yet customized the `ExploreToolConfig` API in your `packages/app`, this will result in an empty list of tools. diff --git a/plugins/explore-backend/README.md b/plugins/explore-backend/README.md index 927cc47fd7..d1714806f4 100644 --- a/plugins/explore-backend/README.md +++ b/plugins/explore-backend/README.md @@ -99,7 +99,7 @@ See [the explore plugin README](../explore/README.md) for more information. The `explore-backend` uses the `ExploreToolProvider` interface to provide a list of tools used in your organization and/or within your Backstage instance. This -can be overriden to provide tools from any source. For example you could create +can be customized to provide tools from any source. For example you could create a `CustomExploreToolProvider` that queries an internal for tools in your `packages/backend/src/plugins/explore.ts` file. diff --git a/plugins/explore/README.md b/plugins/explore/README.md index e8bd4446d9..0204f34714 100644 --- a/plugins/explore/README.md +++ b/plugins/explore/README.md @@ -59,7 +59,7 @@ export const Root = ({ children }: PropsWithChildren<{}>) => ( ``` -### Use earch result list item for Explore Tools +### Use search result list item for Explore Tools When you have your `packages/app/src/components/search/SearchPage.tsx` file ready to make modifications, add the following code snippet to add the diff --git a/plugins/explore/src/plugin.ts b/plugins/explore/src/plugin.ts index b6bf7238e3..f1869ae849 100644 --- a/plugins/explore/src/plugin.ts +++ b/plugins/explore/src/plugin.ts @@ -23,7 +23,7 @@ import { fetchApiRef, } from '@backstage/core-plugin-api'; import { ExploreClient, exploreApiRef } from './api'; -import { exampleTools } from './util/examples'; +// import { exampleTools } from './util/examples'; /** @public */ export const explorePlugin = createPlugin({ @@ -54,9 +54,9 @@ export const explorePlugin = createPlugin({ // TODO: Determine if this should return undefined or exampleTools // - `undefined` will enable the explore-backend to be used via the ExploreClient backwards compatibility // which is likely the desired behavior for anyone that has not yet overriden this API - // return undefined as any; + return undefined as any; // - `exampleTools` will disable the explore-backend fetching for users that have not yet overriden this API - return exampleTools; + // return exampleTools; }, }), }),