Heikki Hellgren
d5a1fe189b
quite a big PR for this but the changes are pretty stright forward. hopefully gets merged before most of these plugins move to the community repository. Signed-off-by: Heikki Hellgren <heikki.hellgren@op.fi>
search-backend-module-techdocs
This package exports a module that extends the search backend to also index techdocs.
Installation
Add the module package as a dependency:
# From your Backstage root directory
yarn --cwd packages/backend add @backstage/plugin-search-backend-module-techdocs
Add the collator to your backend instance, along with the search plugin itself:
// packages/backend/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();
You may also want to add configuration parameters to your app-config, for example for controlling the scheduled indexing interval. These parameters should be placed under the search.collators.techdocs key. See the config definition file for more details.