Merge pull request #11765 from backstage/orkohunter/docs-cost-insights
docs: fix cost insights example app config
This commit is contained in:
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@backstage/plugin-cost-insights': patch
|
||||
---
|
||||
|
||||
Fix broken app-config in the example in the README
|
||||
@@ -26,6 +26,8 @@ yarn add --cwd packages/app @backstage/plugin-cost-insights
|
||||
|
||||
2. Create a CostInsights client. Clients must implement the [CostInsightsApi](https://github.com/backstage/backstage/blob/master/plugins/cost-insights/src/api/CostInsightsApi.ts) interface. Create your own or [use a template](https://github.com/backstage/backstage/blob/master/plugins/cost-insights/src/example/templates/CostInsightsClient.ts) to get started.
|
||||
|
||||
Tip: You can also use the `ExampleCostInsightsClient` from `@backstage/plugin-cost-insights` to see how the plugin looks with some mock data.
|
||||
|
||||
```ts
|
||||
// path/to/CostInsightsClient.ts
|
||||
import { CostInsightsApi } from '@backstage/plugin-cost-insights';
|
||||
@@ -171,16 +173,15 @@ costInsights:
|
||||
name: Some Other Cloud Product
|
||||
icon: data
|
||||
currencies:
|
||||
metricA:
|
||||
currencyA:
|
||||
label: Currency A
|
||||
unit: Unit A
|
||||
currencyB:
|
||||
label: Currency B
|
||||
kind: CURRENCY_B
|
||||
unit: Unit B
|
||||
prefix: B
|
||||
rate: 3.5
|
||||
currencyA:
|
||||
label: Currency A
|
||||
unit: Unit A
|
||||
currencyB:
|
||||
label: Currency B
|
||||
kind: CURRENCY_B
|
||||
unit: Unit B
|
||||
prefix: B
|
||||
rate: 3.5
|
||||
```
|
||||
|
||||
## Alerts
|
||||
|
||||
Reference in New Issue
Block a user