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

Change variable name to documentType

Browse Source 
Signed-off-by: Kacper Nowacki <kacper.nowacki@dynatrace.com>
This commit is contained in:
Kacper Nowacki
2023-03-01 14:14:31 +01:00
parent 35b5587118
commit 5a2df6c0c8
4 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/search/how-to-guides.md
+3 -3
View File
@@ -189,7 +189,7 @@ entities are indexed by the search engine.
In some cases you might want to have the ability to change the document type in which catalog entities will be indexed by catalog collator.
Such option gives a possibility to customize SearchPage results and filters depending on which document type you would like to see results for.
You can achieve that by passing additional parameter `type` to the `DefaultCatalogCollatorFactory`.
You can achieve that by passing additional parameter `documentType` to the `DefaultCatalogCollatorFactory`.
Let's say that you want to have two different document types for some entities.
Our example will cover a use case in which we want to:
@@ -197,7 +197,7 @@ Our example will cover a use case in which we want to:
- Store entities of kind `User` or `Group` under document type `yourCustomDocumentType`,
- Store rest of entities under default document type `software-catalog`
To achieve that you will have to remove `User` and `Group` from your previous collator `filter` and register new `DefaultCatalogCollatorFactory` with new parameter `type`.
To achieve that you will have to remove `User` and `Group` from your previous collator `filter` and register new `DefaultCatalogCollatorFactory` with new parameter `documentType`.
```diff
// packages/backend/src/plugins/search.ts
@@ -222,7 +222,7 @@ To achieve that you will have to remove `User` and `Group` from your previous co
+ filter: {
+ kind: ['User', 'Group'],
+ },
+ type: 'yourCustomDocumentType',
+ documentType: 'yourCustomDocumentType',
+ }),
+ });
```