From b3126588dc274e41a0a488c52e8f1962f1999510 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Fri, 19 Feb 2021 16:02:08 -0500 Subject: [PATCH 1/2] Add note about sidebar --- plugins/cost-insights/README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/plugins/cost-insights/README.md b/plugins/cost-insights/README.md index 86adb8673f..4d7ef9701a 100644 --- a/plugins/cost-insights/README.md +++ b/plugins/cost-insights/README.md @@ -56,6 +56,38 @@ export const apis = [ export { plugin as CostInsights } from '@backstage/plugin-cost-insights'; ``` +5. Add Cost Insights to your app Sidebar. + +To expose the plugin to your users, you can integrate the `cost-insights` route anyway that suits your application, but most commonly it is added to the Sidebar. + +```ts +// packages/app/src/sidebar.tsx ++ import MoneyIcon from '@material-ui/icons/MonetizationOn'; + + ... + + export const AppSidebar = () => ( + + + + + {/* Global nav, not org-specific */} + + + + + + ++ + {/* End global nav */} + + + + + + ); +``` + ## Configuration Cost Insights has only two required configuration fields: a map of cloud `products` for showing cost breakdowns and `engineerCost` - the average yearly cost of an engineer including benefits. Products must be defined as keys on the `products` field. From acc1da48cd8136be1f05dd302f966bb143761bca Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Fri, 19 Feb 2021 16:03:20 -0500 Subject: [PATCH 2/2] Make codefence a diff --- plugins/cost-insights/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/cost-insights/README.md b/plugins/cost-insights/README.md index 4d7ef9701a..c10d483f3f 100644 --- a/plugins/cost-insights/README.md +++ b/plugins/cost-insights/README.md @@ -60,7 +60,7 @@ export { plugin as CostInsights } from '@backstage/plugin-cost-insights'; To expose the plugin to your users, you can integrate the `cost-insights` route anyway that suits your application, but most commonly it is added to the Sidebar. -```ts +```diff // packages/app/src/sidebar.tsx + import MoneyIcon from '@material-ui/icons/MonetizationOn';