From 5e8cd3c72cd5ce54bd0f83f68c3bc8b45c50ca6a Mon Sep 17 00:00:00 2001 From: Eric Peterson Date: Thu, 5 Jan 2023 14:30:54 +0100 Subject: [PATCH] Clean up search docs homepage Signed-off-by: Eric Peterson --- docs/features/search/README.md | 82 +++------------------------------- 1 file changed, 7 insertions(+), 75 deletions(-) diff --git a/docs/features/search/README.md b/docs/features/search/README.md index 21deffb3a0..97d3d7efcb 100644 --- a/docs/features/search/README.md +++ b/docs/features/search/README.md @@ -23,7 +23,8 @@ See the more detailed [architecture](./architecture.md) and [tech stack](./archi ## Project roadmap -No current plans. +No current plans. Check [Backstage issues labeled `search`](https://github.com/backstage/backstage/issues?q=is%3Aopen+is%3Aissue+label%3Asearch) +for community-led ideas and initiatives. ## Supported @@ -42,11 +43,11 @@ The following sections show the plugins and search engines currently supported b See [Backstage Search Architecture](architecture.md) to get an overview of how the search engines are used. -| Search Engines | Support Status | -| -------------------------------------------------- | -------------- | -| [ElasticSearch](./search-engines.md#elasticsearch) | ✅ | -| [Lunr](./search-engines.md#lunr) | ✅ | -| [Postgres](./search-engines.md#postgres) | Community ✅ | +| Search Engines | Support Status | +| ------------------------------------------------------------- | -------------- | +| [Elasticsearch/OpenSearch](./search-engines.md#elasticsearch) | ✅ | +| [Lunr](./search-engines.md#lunr) | ✅ | +| [Postgres](./search-engines.md#postgres) | Community ✅ | [Reach out to us](#get-involved) if you want to chat about support for more plugin integrations and search engines. @@ -56,72 +57,3 @@ search engines. For any questions, feedback, or to help move search forward, reach out to us in the **#search** channel of our [Discord chatroom](https://github.com/backstage/backstage#community). - -## Use Cases supported - -#### **Backstage Search Pre-Alpha** - -Search Frontend letting you search through the entities of the software catalog. - -The pre-alpha is intended to solve for the following user stories, but will get -there by means of a front-end only, non-extensible MVP. - -- As a software engineer I should be able to navigate to a search page and - search for entities registered in the Software Catalog. -- As a software engineer I should be able to use the search input field in the - sidebar to search for entities registered in the Software Catalog. -- As a software engineer I should be able to see the number of results my search - returned. -- As a software engineer I should be able to filter on metadata (kind, - lifecycle) when I’ve performed a search. -- As a software engineer I should be able to hide the filters if I don’t need to - use them. - -#### **Backstage Search Alpha** - -Basic “out-of-the-box” in-memory indexing process of entities, and their metadata, registered to the Software Catalog. - -We will consider Backstage Search to be in alpha when the above use-cases are -met, but built on top of a flexible, extensible platform. - -- As an integrator, I should be able to provide all of the pre-alpha experiences - to my users if I choose, but also be able to customize the experience using a - composable set of components. -- As a plugin developer, I should have a standard way to expose my plugin's data - to Backstage Search. -- As an integrator, I should still be able to expose everything in the Software - Catalog in search, but it should be possible to customize what is searchable. -- As an integrator, although I should be able to customize all of the above, it - should be possible to have the pre-alpha user experiences covered without - having to set up and configure a search engine. - -#### **Backstage Search Beta** - -At least one production-ready search engine that supports the same use-cases as in the alpha. - -We will consider Backstage Search to be in a beta phase when the above use-cases -are met, and can be deployed using a production-ready search engine. - -- As an integrator, I should be able to power my Backstage Search experience - (including querying and indexing) using a production-ready search engine like - ElasticSearch. -- As an integrator, I should be able to configure the connection to my search - engine in **app_config.yaml**. -- As an integrator, I should be able to tune the queries sent to my chosen - search engine according to my organization's needs, but a sensible default - query should be in place so that I am not required to do so. - -#### **Backstage Search 1.0** - -A stable Search API for plugin developers to add search to their plugins, and app integrators to expose that to their users. - -We will consider Backstage Search to be 1.0 when the above -use-cases are met, and an ecosystem of search-enabled plugins are available and -stable. - -- As a plugin developer, there should be at least one example of a Backstage - plugin that integrates with search that I can use as inspiration for my own - plugin's search capabilities (for example, the TechDocs plugin). -- As an app integrator, there should be plenty of examples and documentation on - how to customize and extend search in my Backstage instance to meet my - organization's needs.