Improved Tech-Insights documentation

Signed-off-by: Andre Wanlin <awanlin@rapidrtc.com>
This commit is contained in:
Andre Wanlin
2022-03-18 13:13:20 -05:00
parent f9653d19eb
commit 2fe58c7285
5 changed files with 148 additions and 9 deletions
+3 -7
View File
@@ -47,12 +47,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`.
### Customize scorecards overview title and description:
## Boolean Scorecard Example
```tsx
// packages/app/src/components/catalog/EntityPage.tsx
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:
## Links
- [The Backstage homepage](https://backstage.io)
```
![Boolean Scorecard Example](./docs/boolean-scorecard-example.png)
Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

+5
View File
@@ -12,6 +12,11 @@
"backstage": {
"role": "frontend-plugin"
},
"repository": {
"type": "git",
"url": "https://github.com/backstage/backstage",
"directory": "plugins/tech-insights"
},
"scripts": {
"build": "backstage-cli package build",
"start": "backstage-cli package start",