diff --git a/plugins/search-backend-node/README.md b/plugins/search-backend-node/README.md index 126e8b9988..264780fe93 100644 --- a/plugins/search-backend-node/README.md +++ b/plugins/search-backend-node/README.md @@ -1,17 +1,19 @@ # search-backend-node 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: +platform. This particular plugin is responsible for all aspects of the search +indexing process, including: -- Allowing other backend plugins to register the fact that they have documents - that they'd like to be indexed by a search engine (known as `collators`) -- Allowing other backend plugins to register the fact that they have metadata - that they'd like to augment existing documents in the search index with - (known as `decorators`) +- Providing connections to search engines where actual document indices live + and queries can be made. +- Defining a mechanism for plugins to expose documents that they'd like to be + indexed (called `collators`). +- Defining a mechanism for plugins to add extra metadata to documents that the + source plugin may not be aware of (known as `decorators`). - A scheduler that, at configurable intervals, compiles documents to be indexed - and passes them to a search engine for indexing -- Types for all of the above + and passes them to a search engine for indexing. +- A builder class to wire up all of the above. +- Naturally, types for all of the above. Documentation on how to develop and improve the search platform is currently centralized in the `search` plugin README.md. diff --git a/plugins/search-backend/README.md b/plugins/search-backend/README.md index 6c5e8c1bae..b89c6acf68 100644 --- a/plugins/search-backend/README.md +++ b/plugins/search-backend/README.md @@ -1,8 +1,8 @@ # search-backend 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 +platform. This particular plugin 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. diff --git a/plugins/search/README.md b/plugins/search/README.md index 04abee06ee..f4a32c9597 100644 --- a/plugins/search/README.md +++ b/plugins/search/README.md @@ -1,23 +1,26 @@ # Backstage Search -**This plugin is still under development.** +A flexible, extensible search across your whole Backstage ecosystem. -You can follow the progress and contribute at the Backstage [Search Project Board](https://github.com/backstage/backstage/projects/6) or reach out to us in the [`#search` Discord channel](https://discord.com/channels/687207715902193673/770283289327566848). +Development is ongoing. You can follow the progress and contribute at the Backstage [Search Project Board](https://github.com/backstage/backstage/projects/6) or reach out to us in the [`#search` Discord channel](https://discord.com/channels/687207715902193673/770283289327566848). ## Getting started -Run `yarn start` in the root directory, and then navigate to [/search](http://localhost:3000/search) to check out the plugin. +Run `yarn dev` in the root directory, and then navigate to [/search](http://localhost:3000/search) to check out the plugin. -### Working on the search platform +### Areas of Responsibility -The above search experience is 100% client-side and only looks at the Software Catalog. We are actively developing [a more complete search platform](https://backstage.io/docs/features/search/search-overview), which will replace the current experience when ready. +This search plugin is primarily responsible for the following: -In order to work on this new search platform, you will need to be aware of the following: +- Providing a `` routable extension. +- Exposing various search-related components (like ``, + ``, etc), which can be composed by a Backstage App or by + other Backstage Plugins to power search experiences of all kinds. +- Exposing a ``, which manages search state and API + communication with the Backstage backend. -- **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 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 +Don't forget, a lot of functionality is available in backend plugins: -As you work, be sure not to break the existing, frontend-only search page. +- `@backstage/plugin-search-backend-node`, which is responsible for the search + index management +- `@backstage/plugin-search-backend`, which is responsible for query processing