Update readme files and api reports

Co-authored-by: Emma Indal <emma.indahl@gmail.com>
Signed-off-by: Camila Belo <camilaibs@gmail.com>

.changeset/tall-chairs-explain.md

@@ -4,4 +4,4 @@
 '@backstage/plugin-explore-backend': patch
 ---
 
-Deprecate the collator files in the backend package by extracting them into a separate module.
+Collator factories instantiated in new backend system modules and now marked as deprecated. Will be continued to be exported publicly until the new backend system is fully rolled out.

.changeset/wet-lamps-happen.md

@@ -4,4 +4,4 @@
 '@backstage/plugin-search-backend-module-explore': minor
 ---
 
-Extend the index with custom collators by creating search plugin modules.
+Package introduced to export search backend modules that can be used with the new backend system to extend search with plugin specific functionality, such as collators. For documentation on how to migrate, check out the [how to migrate to the new backend system guide](../docs/features/search/how-to-guides.md#how-to-migrate-to-use-search-together-with-the-new-backend-system).

docs/features/search/how-to-guides.md

@@ -370,7 +370,7 @@ export const SearchModal = ({ toggleModal }: { toggleModal: () => void }) => (
 
 There are other more specific search results layout components that also accept result item extensions, check their documentation: [SearchResultList](https://backstage.io/storybook/?path=/story/plugins-search-searchresultlist--with-result-item-extensions) and [SearchResultGroup](https://backstage.io/storybook/?path=/story/plugins-search-searchresultgroup--with-result-item-extensions).
 
-## How to migrate to use Search together with the new backend system
+## How to migrate your backend installation to use Search together with the new backend system
 
 > DISCLAIMER: The new backend system is in alpha, and so are the search backend support for the new backend system. We don't recommend you to migrate your backend installations to the new system yet. But if you want to experiment, this is the guide for you!
 

plugins/search-backend-module-catalog/README.md

@@ -6,6 +6,22 @@ This package exports catalog backend modules responsible for extending search.
 
 ## Example
 
+### Use default schedule
+
+```tsx
+// packages/backend-next/src/index.ts
+import { createBackend } from '@backstage/backend-defaults';
+import { searchPlugin } from '@backstage/plugin-search-backend/alpha';
+import { searchModuleCatalogCollator } from '@backstage/plugin-search-backend-module-catalog/alpha';
+
+const backend = createBackend();
+backend.add(searchPlugin());
+backend.add(searchModuleCatalogCollator());
+backend.start();
+```
+
+### Use custom schedule
+
 ```tsx
 // packages/backend-next/src/index.ts
 import { createBackend } from '@backstage/backend-defaults';
@@ -23,5 +39,3 @@ backend.add(searchPlugin());
 backend.add(searchModuleCatalogCollator({ schedule }));
 backend.start();
 ```
-
-...

plugins/search-backend-module-explore/README.md

@@ -6,6 +6,22 @@ This package exports explore backend modules responsible for extending search.
 
 ## Example
 
+### Use default schedule
+
+```tsx
+// packages/backend-next/src/index.ts
+import { createBackend } from '@backstage/backend-defaults';
+import { searchPlugin } from '@backstage/plugin-search-backend/alpha';
+import { searchModuleExploreCollator } from '@backstage/plugin-search-backend-module-explore/alpha';
+
+const backend = createBackend();
+backend.add(searchPlugin());
+backend.add(searchModuleExploreCollator());
+backend.start();
+```
+
+### Use custom schedule
+
 ```tsx
 // packages/backend-next/src/index.ts
 import { createBackend } from '@backstage/backend-defaults';
@@ -23,5 +39,3 @@ backend.add(searchPlugin());
 backend.add(searchModuleExploreCollator({ schedule }));
 backend.start();
 ```
-
-...

plugins/search-backend-module-techdocs/README.md

@@ -6,6 +6,22 @@ This package exports techdocs backend modules responsible for extending search.
 
 ## Example
 
+### Use default schedule
+
+```tsx
+// packages/backend-next/src/index.ts
+import { createBackend } from '@backstage/backend-defaults';
+import { searchPlugin } from '@backstage/plugin-search-backend/alpha';
+import { searchModuleTechDocsCollator } from '@backstage/plugin-search-backend-module-techdocs/alpha';
+
+const backend = createBackend();
+backend.add(searchPlugin());
+backend.add(searchModuleTechDocsCollator());
+backend.start();
+```
+
+### Use custom schedule
+
 ```tsx
 // packages/backend-next/src/index.ts
 import { createBackend } from '@backstage/backend-defaults';
@@ -23,5 +39,3 @@ backend.add(searchPlugin());
 backend.add(searchModuleTechDocsCollator({ schedule }));
 backend.start();
 ```
-
-...

plugins/search-backend-node/alpha-api-report.md

@@ -3,24 +3,12 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
-import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
-import { DocumentDecoratorFactory } from '@backstage/plugin-search-common';
 import { DocumentTypeInfo } from '@backstage/plugin-search-common';
 import { ExtensionPoint } from '@backstage/backend-plugin-api';
+import { RegisterCollatorParameters } from '@backstage/plugin-search-backend-node';
+import { RegisterDecoratorParameters } from '@backstage/plugin-search-backend-node';
 import { SearchEngine } from '@backstage/plugin-search-common';
 import { ServiceRef } from '@backstage/backend-plugin-api';
-import { TaskRunner } from '@backstage/backend-tasks';
-
-// @public
-export interface RegisterCollatorParameters {
-  factory: DocumentCollatorFactory;
-  schedule: TaskRunner;
-}
-
-// @public
-export interface RegisterDecoratorParameters {
-  factory: DocumentDecoratorFactory;
-}
 
 // @alpha
 export interface SearchEngineRegistryExtensionPoint {

plugins/search-backend-node/src/alpha.ts

@@ -31,7 +31,7 @@ import { createExtensionPoint } from '@backstage/backend-plugin-api';
 import {
   RegisterCollatorParameters,
   RegisterDecoratorParameters,
-} from './types';
+} from '@backstage/plugin-search-backend-node';
 
 import { IndexBuilder } from './IndexBuilder';
 
@@ -157,11 +157,3 @@ export const searchIndexRegistryExtensionPoint =
   createExtensionPoint<SearchIndexRegistryExtensionPoint>({
     id: 'search.index.registry',
   });
-
-/**
- * @alpha
- */
-export type {
-  RegisterCollatorParameters,
-  RegisterDecoratorParameters,
-} from './types';