Skip to content

Commit 368deb5

Browse files
committed
Update README to enhance structure with a table of contents and add new metrics dashboard features. Plus add KPI assets for README.
1 parent 9cd736d commit 368deb5

File tree

3 files changed

+30
-3
lines changed

3 files changed

+30
-3
lines changed

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,17 @@ With the release of the latest [GitHub Copilot Metrics API](https://github.com/o
44

55
However, many organizations that we work with already have established Power BI teams. If your organization is **already using Power BI, please read on!**
66

7-
## New Features
7+
## Table of Contents
8+
- [New Metrics API Features](#new-features)
9+
- [Metrics Dashboard Setup](#metrics-dashboard-setup)
10+
- [Connect to Metrics API](#connect-to-metrics-api)
11+
- [Connect to local JSON data source](#connect-to-local-json-data-source)
12+
- [KPI - Savings Dashboard](#kpi---savings-dashboard)
13+
- [Publishing](#publishing)
14+
- [Maintainers](#maintainers)
15+
- [Support](#support)
16+
17+
## New Metrics API Features
818
- New metrics for Pull Request summaries and Copilot Chat on GitHub.com.
919
- Clarity on code completions and Copilot Chat usage in IDEs.
1020
- User engagement summaries updated daily.
@@ -16,7 +26,7 @@ Located in the `./samples` directory you'll find sample JSON and PBIX files use
1626
1727
![Image of the Power BI dashboard with sample GitHub Copilot Metrics API data displayed.](./assets/Sample_Metrics_PBI.png)
1828

19-
## Setup
29+
## Metrics Dashboard Setup
2030

2131
### Connect to Metrics API
2232
> Notes: The REST API provides metrics for the previous 28 days and is refreshed daily with data from the previous day. Please ensure you are using the latest version of the [REST API](https://docs.github.com/en/enterprise-cloud@latest/rest/copilot/copilot-metrics).
@@ -101,7 +111,7 @@ In order to connect we'll need to generate a token and link to your metrics data
101111
10. Click **Close and Apply** in the top-left of the **Power Query Editor**.
102112
11. On the **Report View** page click **Refresh** to load the new data into your dashboard.
103113
104-
### Test: Modify the local JSON data source
114+
### Connect to local JSON data source
105115
> Note: This example provided a proof of concept for loading metrics data and requires an exported JSON file. If you have access to the REST API you can configure the **Source** accordingly.
106116
107117
1. Download and open the sample `GitHub Copilot - Telemetry Sample (Metrics with KPIs).pbix` file.
@@ -113,6 +123,23 @@ In order to connect we'll need to generate a token and link to your metrics data
113123
6. On the **Report View** page click **Refresh** to load the new data into your dashboard.
114124
7. **Happy Customizing!**
115125
126+
## KPI - Savings Dashboard
127+
A new KPI tab has been added to the dashboard to help you estimate savings. The KPI tab is configured to display the potential time and case savings. You can configure the KPI tab to display these details by modifying the following fields in the `config` data sourcefrom the **Tabel view**:
128+
129+
| Name | Description |
130+
| :------------------------- | :----------------------------------------------- |
131+
| total_devs | Total number of developers at your organization. |
132+
| avg_hourly_salary | Average hourly salary of developers. |
133+
| annual_work_weeks | Total number of work weeks in a year. |
134+
| average_weekly_hour_savings| Average number of hours developers saved per week. The default is 3.5 hours and assumed a 10% time saving, but this can be updated based on customer survey data or other measurements. |
135+
136+
These values can be modified in the `config` data source below:
137+
![Image of the KPI config table in the Power BI.](./assets/KPI_config.png)
138+
139+
Once configured, the KPI dashboard will display this potential savings against current usage pulled from the Metrics API:
140+
![Image of the KPI tab in the Power BI.](./assets/Sample_KPI_PBI.png)
141+
142+
116143
## Publishing
117144
If you need help deploying or publishing this script, please see: [Publish README](/publish/README.md)
118145

assets/KPI_config.png

11.8 KB
Loading

assets/Sample_KPI_PBI.png

92.8 KB
Loading

0 commit comments

Comments
 (0)