From 0e39d0b4fe32ca0504abb539a8ae68248f695889 Mon Sep 17 00:00:00 2001 From: Eric Peterson Date: Fri, 4 Mar 2022 10:51:03 +0100 Subject: [PATCH] Update documentation to reflect search beta. Signed-off-by: Eric Peterson --- docs/features/search/README.md | 12 ++++++------ docs/features/search/how-to-guides.md | 18 +++++++++++------- 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/docs/features/search/README.md b/docs/features/search/README.md index 0856451882..f25087d59b 100644 --- a/docs/features/search/README.md +++ b/docs/features/search/README.md @@ -24,12 +24,12 @@ Backstage ecosystem. ## Project roadmap -| Version | Description | -| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Backstage Search Pre-Alpha ✅ | Search Frontend letting you search through the entities of the software catalog. [See Pre-Alpha Use Cases.](#backstage-search-pre-alpha) | -| Backstage Search Alpha ✅ | Basic “out-of-the-box” in-memory indexing process of entities, and their metadata, registered to the Software Catalog. [See Alpha Use Cases](#backstage-search-alpha). | -| [Backstage Search Beta ⌛][beta] | At least one production-ready search engine that supports the same use-cases as in the alpha. [See Beta Use Cases](#backstage-search-beta). | -| [Backstage Search GA ⌛][ga] | A stable Search API for plugin developers to add search to their plugins, and app integrators to expose that to their users. [See GA Use Cases](#backstage-search-ga). | +| Version | Description | +| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Backstage Search Pre-Alpha ✅ | Search Frontend letting you search through the entities of the software catalog. [See Pre-Alpha Use Cases.](#backstage-search-pre-alpha) | +| Backstage Search Alpha ✅ | Basic “out-of-the-box” in-memory indexing process of entities, and their metadata, registered to the Software Catalog. [See Alpha Use Cases](#backstage-search-alpha). | +| Backstage Search Beta ✅ | At least one production-ready search engine that supports the same use-cases as in the alpha. [See Beta Use Cases](#backstage-search-beta). | +| [Backstage Search GA ⌛][ga] | A stable Search API for plugin developers to add search to their plugins, and app integrators to expose that to their users. [See GA Use Cases](#backstage-search-ga). | [beta]: https://github.com/backstage/backstage/milestone/27 [ga]: https://github.com/backstage/backstage/milestone/28 diff --git a/docs/features/search/how-to-guides.md b/docs/features/search/how-to-guides.md index 0a5f53d2f2..16596c6e92 100644 --- a/docs/features/search/how-to-guides.md +++ b/docs/features/search/how-to-guides.md @@ -137,9 +137,10 @@ entities are indexed by the search engine. For the purposes of this guide, Search Beta version is defined as: -- **Search Plugin**: At least `v0.x.y` -- **Search Backend Plugin**: At least `v0.x.y` -- **Search Backend Node**: At least `v0.x.y` +- **Search Plugin**: At least `v0.7.2` +- **Search Backend Plugin**: At least `v0.4.6` +- **Search Backend Node**: At least `v0.5.0` +- **Search Common**: At least `v0.3.0` In the Beta version, the Search Platform's indexing process has been rewritten as a stream pipeline in order to improve efficiency and performance on large @@ -149,11 +150,14 @@ If you've not yet extended the Search Platform with custom code, and have instead taken advantage of default collators, decorators, and search engines provided by existing plugins, the migration process is fairly straightforward: -1. Upgrade to at least version `0.x.y` of +1. Upgrade to at least version `0.5.0` of `@backstage/plugin-search-backend-node`, as well as any backend plugins whose - collators you are using (e.g. at least version `0.x.y` of - `@backstage/plugin-catalog-backend` and/or version `0.x.y` of - `@backstage/plugin-techdocs-backend`). + collators you are using (e.g. at least version `0.23.0` of + `@backstage/plugin-catalog-backend` and/or version `0.14.1` of + `@backstage/plugin-techdocs-backend`), as well as any search-engine specific + plugin you are using (e.g. at least version `0.3.0` of + `@backstage/plugin-search-backend-module-pg` or version `0.1.0` of + `@backstage/plugin-search-backend-module-elasticsearch`). 2. Then, make the following changes to your `/packages/backend/src/plugins/search.ts` file: