Andre Wanlin
d5c4a9db09
Signed-off-by: Andre Wanlin <awanlin@spotify.com> Fixed typo Signed-off-by: Andre Wanlin <awanlin@spotify.com> Updated API report Signed-off-by: Andre Wanlin <awanlin@spotify.com> Moved types Signed-off-by: Andre Wanlin <awanlin@spotify.com> Updated changesets Signed-off-by: Andre Wanlin <awanlin@spotify.com> Fixed type error Signed-off-by: Andre Wanlin <awanlin@spotify.com> Updated changeset based on feedback Signed-off-by: Andre Wanlin <awanlin@spotify.com>
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';
const backend = createBackend();
backend.add(import('@backstage/plugin-search-backend'));
backend.add(import('@backstage/plugin-search-backend-module-techdocs'));
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.