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

Merge pull request #9952 from backstage/iameap/mv-techdocs-search-common

Browse Source
This commit is contained in:
Eric Peterson
2022-03-04 20:06:39 +01:00
committed by GitHub
parent 795743969f d52155466a
commit c938e0d61d
153 changed files with 1978 additions and 495 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/search/README.md
+1 -1
View File
@@ -128,7 +128,7 @@ plugins integrated to search.
| Frontend Plugin | @backstage/plugin-search |
| Backend Plugin | @backstage/plugin-search-backend |
| Indexer Plugin | @backstage/plugin-search-backend-node |
| Common Code | @backstage/search-common |
| Common Code | @backstage/plugin-search-common |
## Get Involved
docs/features/search/how-to-guides.md
+1 -1
View File
@@ -369,7 +369,7 @@ implement the factory method that instantiates the stream:
```ts
import { BatchSearchEngineIndexer } from '@backstage/plugin-search-backend-node';
import { SearchEngine } from '@backstage/search-common';
import { SearchEngine } from '@backstage/plugin-search-common';
export class YourSearchEngineIndexer extends BatchSearchEngineIndexer {
constructor({ type }: { type: string }) {
// Customize the number of documents passed to the index method per batch.
docs/features/techdocs/cli.md
+1 -1
View File
@@ -97,7 +97,7 @@ techdocs-cli generate
Alias: `techdocs-cli build`
The generate command uses the
[`@backstage/techdocs-common`](https://github.com/backstage/backstage/tree/master/packages/techdocs-common)
[`@backstage/plugin-techdocs-node`](https://github.com/backstage/backstage/tree/master/plugins/techdocs-node)
package from Backstage for consistency. A Backstage app can also generate and
publish TechDocs sites if `techdocs.builder` is set to `'local'` in
`app-config.yaml`. See
docs/getting-started/project-structure.md
+2 -2
View File
@@ -160,8 +160,8 @@ are separated out into their own folder, see further down.
reusable React components. Stories are within the core package, and are
published in the [Backstage Storybook](https://backstage.io/storybook).
- [`techdocs-common/`](https://github.com/backstage/backstage/tree/master/packages/techdocs-common) -
Common functionalities for TechDocs, to be shared between
- [`techdocs-node/`](https://github.com/backstage/backstage/tree/master/plugins/techdocs-node) -
Common node.js functionalities for TechDocs, to be shared between
[techdocs-backend](https://github.com/backstage/backstage/tree/master/plugins/techdocs-backend)
plugin and [techdocs-cli](https://github.com/backstage/techdocs-cli).