Merge pull request #16308 from adamdmharvey/adamdmharvey/fix-install-instructions-explore

chore: Improve install instructions for Explore plugin
2023-02-14 10:07:59 +01:00
parent 62c3ba4eaa 9fc1e58a5d
commit 3fd435ac54
2 changed files with 6 additions and 7 deletions
@@ -76,10 +76,9 @@ To index explore tools you will need to register the search collator in the
 ```diff
 +import { ToolDocumentCollatorFactory } from '@backstage/plugin-explore-backend';

-async function createSearchEngine(
-  env: PluginEnvironment,
-): Promise<SearchEngine> {
-  ...
+...
+
+ // collator gathers entities from explore.
 +  indexBuilder.addCollator({
 +    schedule,
 +    factory: ToolDocumentCollatorFactory.fromConfig(env.config, {
@@ -87,8 +86,8 @@ async function createSearchEngine(
 +      logger: env.logger,
 +    }),
 +  });
-  ...
-}
+
+...
 ```

 ### Wire up the Frontend
@@ -30,7 +30,7 @@ any path for the route, but we recommend the following:

 ```diff
 // packages/app/src/App.tsx
-+ import { ExplorePage, explorePlugin } from '@backstage/plugin-explore';
+ import { ExplorePage } from '@backstage/plugin-explore';

 ...