Update docs to refer new prop
Signed-off-by: Rogerio Angeliski <angeliski@hotmail.com>
This commit is contained in:
@@ -38,6 +38,10 @@ const serviceEntityPage = (
|
||||
title="Customized title for the scorecard"
|
||||
description="Small description about scorecards"
|
||||
/>
|
||||
<EntityTechInsightsScorecardContent
|
||||
title="Show only simpleTestCheck in this card"
|
||||
checksId={['simpleTestCheck']}
|
||||
/>
|
||||
</EntityLayout.Route>
|
||||
...
|
||||
</EntityLayoutWrapper>
|
||||
@@ -46,6 +50,8 @@ const serviceEntityPage = (
|
||||
|
||||
It is not obligatory to pass title and description props to `EntityTechInsightsScorecardContent`. If those are left out, default values from `defaultCheckResultRenderers` in `CheckResultRenderer` will be taken, hence `Boolean scorecard` and `This card represents an overview of default boolean Backstage checks`.
|
||||
|
||||
You can pass an array `checksId` as a prop with the [Fact Retrievers ids](../tech-insights-backend#creating-fact-retrievers) to limit which checks you want to show in this card, If you don't pass, the default value is show all checks.
|
||||
|
||||
## Boolean Scorecard Example
|
||||
|
||||
If you follow the [Backend Example](https://github.com/backstage/backstage/tree/master/plugins/tech-insights-backend#backend-example), once the needed facts have been generated the boolean scorecard will look like this:
|
||||
|
||||
Reference in New Issue
Block a user