From 9a6d0ebd0d9f4d18284e67c4b3bfbb309142b22b Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Wed, 1 Jun 2022 11:46:23 +0200 Subject: [PATCH 1/3] fix broken cost insights example Signed-off-by: Himanshu Mishra --- plugins/cost-insights/README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/plugins/cost-insights/README.md b/plugins/cost-insights/README.md index c78f4d4b6d..c874fee82d 100644 --- a/plugins/cost-insights/README.md +++ b/plugins/cost-insights/README.md @@ -171,16 +171,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 From bf3b97e535d23d444478b50f3a764877ceb8ea13 Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Wed, 1 Jun 2022 11:47:45 +0200 Subject: [PATCH 2/3] add a tip about example cost insights client Signed-off-by: Himanshu Mishra --- plugins/cost-insights/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/plugins/cost-insights/README.md b/plugins/cost-insights/README.md index c874fee82d..295cfcccd2 100644 --- a/plugins/cost-insights/README.md +++ b/plugins/cost-insights/README.md @@ -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'; From 2fc98ac50c89a2ffb06c8951d35cbd62b294ff53 Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Wed, 1 Jun 2022 11:55:41 +0200 Subject: [PATCH 3/3] add changeset Signed-off-by: Himanshu Mishra --- .changeset/good-squids-rest.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/good-squids-rest.md diff --git a/.changeset/good-squids-rest.md b/.changeset/good-squids-rest.md new file mode 100644 index 0000000000..dc9f9129e2 --- /dev/null +++ b/.changeset/good-squids-rest.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-cost-insights': patch +--- + +Fix broken app-config in the example in the README