paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 47 Packages Projects Releases Wiki Activity

Update how-to-guides.md (#7639)

Browse Source
This commit is contained in:
Bodil Björklund
2021-10-15 23:50:51 +02:00
committed by GitHub
parent 59e822b43c
commit 639d48566a
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/search/how-to-guides.md
+8 -8
View File
@@ -47,18 +47,18 @@ const app = createApp({
## How to index TechDocs documents
The techdocs-plugin has supported integrations to Search, meaning that it
The TechDocs plugin has supported integrations to Search, meaning that it
provides a default collator ready to be used.
The purpose of this how-to guide is to walk you through how to register the
The purpose of this guide is to walk you through how to register the
[DefaultTechDocsCollator](https://github.com/backstage/backstage/blob/master/plugins/techdocs-backend/src/search/DefaultTechDocsCollator.ts)
in your App in two steps, so that you can get TechDocs documents indexed.
in your App, so that you can get TechDocs documents indexed.
If you have been through the
[getting started guide](https://backstage.io/docs/features/search/getting-started)
already, you should have the `packages/backend/src/plugins/search.ts` file
available. If you have that, you can jump to the first step of this guide, if
not - start by go through the getting started guide.
[Getting Started with Search guide](https://backstage.io/docs/features/search/getting-started),
you should have the `packages/backend/src/plugins/search.ts` file available. If
so, you can go ahead and follow this guide - if not, start by going through the
getting started guide.
1. Import the DefaultTechDocsCollator from `@backstage/plugin-techdocs-backend`.
@@ -82,7 +82,7 @@ You should now have your TechDocs documents indexed to your search engine of
choice!
If you want your users to be able to filter down to the techdocs type when
searching. You can update your `SearchPage.tsx` file in
searching, you can update your `SearchPage.tsx` file in
`packages/app/src/components/search` by adding `techdocs` to the list of values
of the `SearchType` component.