Files
backstage/plugins/search
Jussi Hallila 9266b80ab3 Implement DefaultTechDocsCollator
* Implements a collator for tech docs.
   * Retrieves mkdocs created search index for entities that have documentation configured
* Registers collator to expose tech docs content to be searchable
* Adds pagination to example search
* Modifies example search to contain tech docs
   * Displays docs results with link to docs and the entity name as title.
* Creates a reusable type filter to be located in the search package.
* Add tests for type filter

Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-07-15 13:14:25 +02:00
..
2021-06-18 20:26:42 +02:00
2021-07-15 13:14:25 +02:00
2021-07-15 09:19:25 +00:00
2021-07-15 09:19:25 +00:00

Backstage Search

A flexible, extensible search across your whole Backstage ecosystem.

Development is ongoing. You can follow the progress and contribute at the Backstage Search Project Board or reach out to us in the #search Discord channel.

Getting started

Run yarn dev in the root directory, and then navigate to /search to check out the plugin.

Areas of Responsibility

This search plugin is primarily responsible for the following:

  • Providing a <SearchPage /> routable extension.
  • Exposing various search-related components (like <SearchBar />, <SearchFilter />, etc), which can be composed by a Backstage App or by other Backstage Plugins to power search experiences of all kinds.
  • Exposing a <SearchContextProvider />, which manages search state and API communication with the Backstage backend.

Don't forget, a lot of functionality is 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