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
@@ -148,6 +148,7 @@ kubernetes
|
||||
learnings
|
||||
lerna
|
||||
lockfile
|
||||
lunr
|
||||
magiclink
|
||||
mailto
|
||||
maintainership
|
||||
|
||||
@@ -24,13 +24,13 @@ Backstage ecosystem.
|
||||
|
||||
## Project roadmap
|
||||
|
||||
| Version | Description |
|
||||
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| Backstage Search v0 ✅ | Search Frontend letting you search through the entities of the software catalog. [See v0 Use Cases.](#backstage-search-v0) |
|
||||
| [Backstage Search V0.5 ⌛][v0.5] | Foundations for the architecture. |
|
||||
| [Backstage Search v1 ⌛][v1] | Basic “out-of-the-box” in-memory indexing process of entities, and their metadata, registered to the Software Catalog. [See v1 Use Cases.](#backstage-search-v1) |
|
||||
| [Backstage Search v2 ⌛][v2] | Search Backend responsible for the indexing process of entities, and their metadata, registered to the Software Catalog. [See v2 Use Cases.](#backstage-search-v2) |
|
||||
| [Backstage Search v3 ⌛][v3] | Standardized Search API lets you index other plugins data to the search engine of choice. [See v3 Use Cases.](#backstage-search-v3) |
|
||||
| Version | Description |
|
||||
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| Backstage Search v0 ✅ | Search Frontend letting you search through the entities of the software catalog. [See v0 Use Cases.](#backstage-search-v0) |
|
||||
| [Backstage Search V0.5 ✅ ][v0.5] | Foundations for the architecture. |
|
||||
| [Backstage Search v1 ⌛][v1] | Basic “out-of-the-box” in-memory indexing process of entities, and their metadata, registered to the Software Catalog. [See v1 Use Cases.](#backstage-search-v1) |
|
||||
| [Backstage Search v2 ⌛][v2] | Search Backend responsible for the indexing process of entities, and their metadata, registered to the Software Catalog. [See v2 Use Cases.](#backstage-search-v2) |
|
||||
| [Backstage Search v3 ⌛][v3] | Standardized Search API lets you index other plugins data to the search engine of choice. [See v3 Use Cases.](#backstage-search-v3) |
|
||||
|
||||
[v0.5]: https://github.com/backstage/backstage/milestone/25
|
||||
[v1]: https://github.com/backstage/backstage/milestone/26
|
||||
@@ -84,6 +84,7 @@ the search engines are used.
|
||||
|
||||
| Search Engine | Support Status |
|
||||
| ------------- | -------------- |
|
||||
| Basic (lunr) | Not yet ❌ |
|
||||
| ElasticSearch | Not yet ❌ |
|
||||
|
||||
[Reach out to us](#feedback) if you want to chat about support for more search
|
||||
@@ -91,16 +92,15 @@ engines.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
| Stack | Location |
|
||||
| --------------- | ------------------------ |
|
||||
| Frontend Plugin | @backstage/plugin-search |
|
||||
| Backend Plugin | ⌛ |
|
||||
| Stack | Location |
|
||||
| --------------- | ------------------------------------- |
|
||||
| Frontend Plugin | @backstage/plugin-search |
|
||||
| Backend Plugin | @backstage/plugin-search-backend |
|
||||
| Indexer Plugin | @backstage/plugin-search-backend-node |
|
||||
| Common Code | @backstage/search-common |
|
||||
|
||||
## Feedback
|
||||
## Get Involved
|
||||
|
||||
For any questions of feedback, reach out to us in the `#search` channel of our
|
||||
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).
|
||||
|
||||
We are still looking for feedback to improve the architecture to fit your
|
||||
use-case, see
|
||||
[this open issue](https://github.com/backstage/backstage/issues/4078).
|
||||
|
||||
@@ -6,8 +6,8 @@ description: Documentation on Search Architecture
|
||||
|
||||
# Search Architecture
|
||||
|
||||
> _This is a proposed architecture which has not been implemented yet. Find our
|
||||
> milestones to follow our progress on the
|
||||
> _This architecture has not been fully implemented yet. Find our milestones to
|
||||
> follow our progress and help contribute on the
|
||||
> [Search Roadmap](./README.md#project-roadmap)._
|
||||
|
||||
Below you can explore the Search Architecture. Our aim with this architecture is
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user