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

link to main README; refactor wording

Browse Source 
Signed-off-by: Ryan Vazquez <ryanv@spotify.com>
This commit is contained in:
Ryan Vazquez
2021-03-24 14:31:18 -04:00
parent 117fa99502
commit bc05e90297
2 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/cost-insights/README.md
+2 -2
View File
@@ -144,6 +144,6 @@ costInsights:
The CostInsightsApi `getAlerts` method may return any type of alert or recommendation (called collectively "Action Items" in Cost Insights) that implements the [Alert type](https://github.com/backstage/backstage/blob/master/plugins/cost-insights/src/types/Alert.ts). This allows you to deliver any alerts or recommendations specific to your infrastructure or company migrations.
The Alert type includes an `element` field to supply the JSX Element that will be rendered in the Cost Insights "Action Items" section; we recommend using Backstage's [InfoCard](https://backstage.io/storybook/?path=/story/layout-information-card--default) and [Recharts](http://recharts.org/en-US/) to show actionable visualizations.
To learn more about using Cost Insights' ready-to-use alerts, see the alerts [README](https://github.com/backstage/backstage/blob/master/plugins/cost-insights/src/alerts/README.md).
The Alert `url` should link to documentation or instructions for resolving the alert. This may be omitted if no external link is needed.
Example implementations of custom alerts, forms and components can be found in the [examples](https://github.com/backstage/backstage/tree/master/plugins/cost-insights/src/example) directory.
plugins/cost-insights/src/alerts/README.md
+8 -6
View File
@@ -1,6 +1,6 @@
# Cost Insights Alerts
Cost Insights currently supports [project growth](https://github.com/backstage/backstage/blob/master/plugins/cost-insights/src/alerts/ProjectGrowthAlert.tsx) and [unlabeled dataflow](https://github.com/backstage/backstage/blob/master/plugins/cost-insights/src/alerts/UnlabeledDataflowAlert.tsx) alerts. They do not require any UI or additional configuration but are extendable for custom implementations.
Cost Insights supports custom and ready-to-use alerts such as [project growth](https://github.com/backstage/backstage/blob/master/plugins/cost-insights/src/alerts/ProjectGrowthAlert.tsx) and [unlabeled dataflow](https://github.com/backstage/backstage/blob/master/plugins/cost-insights/src/alerts/UnlabeledDataflowAlert.tsx) alerts. These exported alerts do not require any UI or additional configuration but are extendable for custom implementations.
### Basic Setup
@@ -35,9 +35,7 @@ export class CostInsightsClient extends CostInsightsApi {
### Custom Setup
Default properties such as the title, subtitle and even the chart itself can be overridden.
Additionally, alerts can be extended to support actions such as snoozing or dismissing.
Default properties such as the title, subtitle and instructions page url can be overridden - even default UI such as chart itself. Additionally, alerts can be extended to support actions such as snoozing or dismissing.
![project-growth-alert-custom](../assets/project-growth-alert-custom.png)
@@ -71,6 +69,7 @@ export class ProjectGrowthAlert extends DefaultProjectGrowthAlert {
return 'A custom subtitle for a project growth alert';
}
// render a custom component in the Action Items section
get element(){
return <MyCustomChart data={this.data} />
}
@@ -87,7 +86,6 @@ export class ProjectGrowthAlert extends DefaultProjectGrowthAlert {
...
}
}
```
```ts
@@ -116,7 +114,11 @@ export class CostInsightsClient extends CostInsightsApi {
### Advanced Setup
If the default UI is insufficient, alerts can render their own custom forms for actions such as snoozing or dismissing. Cost Insights exports several core UI components such as the `BarChart` and `LegendItem` to support custom implementations.
Alerts can render their own custom forms for actions such as snoozing or dismissing if the default UI is insufficient.
Cost Insights exports several core UI components such as the `BarChart` and `LegendItem` to support custom implementations.
**Note**: We recommend using Backstage's [InfoCard](https://backstage.io/storybook/?path=/story/layout-information-card--default) and [Recharts](http://recharts.org/en-US/) to show actionable visualizations.
For more advanced usage, see example [KubernetesMigrationAlert](https://github.com/backstage/backstage/blob/master/plugins/cost-insights/src/example/alerts/KubernetesMigrationAlert.tsx).