Show how to hide locations from search

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2022-01-07 15:41:45 +01:00
parent 3cf9ff0ba4
commit 45df287eec
1 changed files with 34 additions and 0 deletions
@@ -97,3 +97,37 @@ of the `SearchType` component.
  ...
 </Paper>
 ```
+
+## How to limit what can be searched in the Software Catalog
+
+The Software Catalog includes a wealth of information about the components,
+systems, groups, users, and other aspects of your software ecosystem. However,
+you may not always want _every_ aspect to appear when a user searches the
+catalog. Examples include:
+
+- Entities of kind `Location`, which are often not useful to Backstage users.
+- Entities of kind `User` or `Group`, if you'd prefer that users and groups be
+  exposed to search in a different way (or not at all).
+
+It's possible to write your own [Collator](./concepts.md#collators) to control
+exactly what's available to search, (or a [Decorator](./concepts.md#decorators)
+to filter things out here and there), but the `DefaultCatalogCollator` that's
+provided by `@backstage/plugin-catalog-backend` offers some configuration too!
+
+```diff
+// packages/backend/src/plugins/search.ts
+
+indexBuilder.addCollator({
+  defaultRefreshIntervalSeconds: 600,
+  collator: DefaultCatalogCollator.fromConfig(config, {
+    discovery,
+    tokenManager,
+   filter: {
+      kind: ['API', 'Component', 'Domain', 'Group', 'System', 'User'],
+   },
+  }),
+});
+```
+
+As shown above, you can add a catalog entity filter to narrow down what catalog
+entities are indexed by the search engine.