Sync up docs with progress made on Search Foundations. (#5136)

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
Eric Peterson
2021-03-29 10:14:26 +02:00
committed by GitHub
parent 820b791b68
commit d355b516f5
5 changed files with 22 additions and 24 deletions
+1 -4
View File
@@ -2,10 +2,7 @@
This plugin is part of a suite of plugins that comprise the Backstage search
platform, which is still very much under development. This plugin specifically
is responsible for:
- Exposing a JSON API for querying a search engine
- Types related to interacting with that API
is responsible for exposing a JSON API for querying a search engine
Documentation on how to develop and improve the search platform is currently
centralized in the `search` plugin README.md.
+1 -1
View File
@@ -15,7 +15,7 @@ The above search experience is 100% client-side and only looks at the Software C
In order to work on this new search platform, you will need to be aware of the following:
- **In-development app search route**: The new search platform will move the primary search page to the App-level, out of the search plugin. For now, to ensure the old experience is still easy to test, you can work on the new platform at `/search-next` instead of `/search`.
- **App SearchPage Component**: You'll find a new search page under `/packages/app/src/components/search`. When ready, we'll add an equivalent page to the `@backstage/create-app` template.
- **App SearchPage Component**: You'll find a new search page in this plugin `SearchPageNext`. When sufficiently stable, we'll replace `SearchPage` with `SearchPageNext`
- **Backend**: Don't forget, a lot of functionality will be made available in backend plugins:
- `@backstage/plugin-search-backend-node`, which is responsible for the search index management
- `@backstage/plugin-search-backend`, which is responsible for query processing