deprecate explore collator

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2025-08-22 15:42:09 +02:00
parent b1bd24a0b2
commit 9a93520746
9 changed files with 18 additions and 5 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-search-backend-module-explore': patch
---
Deprecate and mark explore collator as moved
+1 -1
View File
@@ -170,7 +170,7 @@ export const exampleCustomCatalogFiltering = createBackendModule({
Here are some of the known Search Collators available in from the Backstage Community:
- [`@backstage/plugin-search-backend-module-explore`](https://github.com/backstage/backstage/tree/master/plugins/search-backend-module-explore): will index content from the [Explore plugin](https://github.com/backstage/community-plugins/tree/main/workspaces/explore/plugins/explore).
- [`@backstage-community/plugin-search-backend-module-explore`](https://github.com/backstage/community-plugins/tree/main/workspaces/explore/plugins/search-backend-module-explore): will index content from the [Explore plugin](https://github.com/backstage/community-plugins/tree/main/workspaces/explore/plugins/explore).
- [`@backstage/plugin-search-backend-module-stack-overflow-collator`](https://github.com/backstage/backstage/tree/master/plugins/search-backend-module-stack-overflow-collator): will index content from Stack Overflow.
- [`@backstage-community/search-backend-module-adr`](https://github.com/backstage/community-plugins/tree/main/workspaces/adr/plugins/search-backend-module-adr): will index content from the [ADR plugin](https://github.com/backstage/community-plugins/tree/main/workspaces/adr/plugins/adr).
@@ -1,5 +1,7 @@
# search-backend-module-explore
THIS ENTIRE PACKAGE IS DEPRECATED and has been moved to the Backstage community repository; please use the `@backstage-community/plugin-search-backend-module-explore` package instead.
This package exports a module that extends the search backend to also indexing the tools exposed by the [`explore` service](https://github.com/backstage/community-plugins/tree/main/workspaces/explore/plugins/explore-backend).
## Installation
@@ -3,6 +3,7 @@
"version": "0.3.5",
"description": "A module for the search backend that exports explore modules",
"backstage": {
"moved": "@backstage-community/plugin-search-backend-module-explore",
"role": "backend-plugin-module",
"pluginId": "search",
"pluginPackage": "@backstage/plugin-search-backend"
@@ -5,7 +5,7 @@
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
// @alpha (undocumented)
// @alpha @deprecated (undocumented)
const _feature: BackendFeature;
export default _feature;
@@ -7,10 +7,10 @@ import { BackendFeature } from '@backstage/backend-plugin-api';
import { ExploreTool } from '@backstage-community/plugin-explore-common';
import { IndexableDocument } from '@backstage/plugin-search-common';
// @public
// @public @deprecated
const _default: BackendFeature;
export default _default;
// @public
// @public @deprecated
export interface ToolDocument extends IndexableDocument, ExploreTool {}
```
@@ -16,6 +16,9 @@
import { default as feature } from './module';
/** @alpha */
/**
* @alpha
* @deprecated This entire package is deprecated and has been moved to the Backstage community repository; please use the `@backstage-community/plugin-search-backend-module-explore` package instead.
*/
const _feature = feature;
export default _feature;
@@ -30,6 +30,7 @@ import { Readable } from 'stream';
/**
* Extended IndexableDocument with explore tool specific properties
*
* @deprecated This entire package is deprecated and has been moved to the Backstage community repository; please use the `@backstage-community/plugin-search-backend-module-explore` package instead.
* @public
*/
export interface ToolDocument extends IndexableDocument, ExploreTool {}
@@ -30,6 +30,7 @@ import { ToolDocumentCollatorFactory } from './collators/ToolDocumentCollatorFac
/**
* Search backend module for the Explore index.
*
* @deprecated This entire package is deprecated and has been moved to the Backstage community repository; please use the `@backstage-community/plugin-search-backend-module-explore` package instead.
* @public
*/
export default createBackendModule({