Skip to content

Commit 375ef0b

Browse files
committed
Update overview.md
- Add section for Copilot teams data
1 parent 8dd6d5e commit 375ef0b

2 files changed

Lines changed: 8 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Copilot dashboard can be found on the Copilot tab within the Digital Landsca
1616
- [Makefile](#makefile)
1717
- [AWS Lambda Scripts](#aws-lambda-scripts)
1818
- [Setup - Running in a container](#setup---running-in-a-container)
19-
- [Setup - running outside of a Container (Development only)](#setup---running-outside-of-a-container-development-only)
19+
- [Setup - running outside of a Container (Development only)](#running-outside-of-a-container-development-only)
2020
- [Storing the container on AWS Elastic Container Registry (ECR)](#storing-the-container-on-aws-elastic-container-registry-ecr)
2121
- [Deployment to AWS](#deployment-to-aws)
2222
- [Deployment Prerequisites](#deployment-prerequisites)

docs/technical_documentation/overview.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Overview
22

33
AWS Lambda Function which updates the GitHub Copilot dashboard's:
4+
45
- Organisation-wide historic data
56
- Copilot teams
67
- Teams history
@@ -24,7 +25,7 @@ This project uses 2 major components:
2425

2526
### The Lambda Function
2627

27-
This component updates the dashboard's historic information, stored within an S3 bucket. The lambda imports the GitHub API Toolkit to get the API response containing the usage information. The script then adds any new data to the existing historic data within the S3 bucket.
28+
This component updates the Digital Landscape's Copilot dashboard data, stored within S3 buckets. The lambda imports the GitHub API Toolkit to get the API response containing the data, then adds any new data to the relevant S3 bucket.
2829

2930
### The GitHub API Toolkit
3031

@@ -34,6 +35,10 @@ This component is an imported library which is shared across multiple GitHub too
3435

3536
[View docs for the Copilot usage data endpoint](https://docs.github.com/en/rest/copilot/copilot-usage?apiVersion=2022-11-28#get-a-summary-of-copilot-usage-for-organization-members).
3637

37-
### Historic Data
38+
### Historic Usage Data
3839

3940
This section gathers data from AWS S3. The Copilot usage endpoints have a limitation where they only return the last 100 days worth of information. To get around this, the project has an AWS Lambda function which runs weekly and stores data within an S3 bucket.
41+
42+
### Copilot Teams Data
43+
44+
This section gathers a list of teams within the organisation with Copilot data and updates the S3 bucket accordingly. This allows all relevant teams to be displayed within the dashboard.

0 commit comments

Comments
 (0)