paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 25 Packages Projects Releases Wiki Activity

Clean up READMEs

Browse Source 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
Eric Peterson
2021-02-16 11:10:13 +01:00
parent 1c136c7da8
commit d78542d037
3 changed files with 32 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/search/README.md
+4 -4
View File
@@ -6,15 +6,15 @@ You can follow the progress and contribute at the Backstage [Search Project Boar
## 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 start` in the root directory, and then navigate to [/search](http://localhost:3000/search) to check out the plugin.
### Working on the search platform
Currently, the search experience available in Backstage is 100% on the front-end, 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.
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.
In order to work on the new search platform, you will need to be aware of the following:
In order to work on this new search platform, you will need to be aware of the following:
- **The use-search-platform feature flag**: The new search platform will move the primary search page to the App-level, out of the search plugin. You'll need to enable this feature flag to work on the net platform.
- **The use-search-platform feature flag**: The new search platform will move the primary search page to the App-level, out of the search plugin. You'll need to enable this feature flag to work on the new platform.
- **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.
- **Backend**: Don't forget, a lot of functionality will be made available in backend plugins:
- `@backstage/plugin-search-indexer-backend`, which is responsible for the search index management