Get data from Github on who is using the Design System

[kellylee-gds]

Brief

By the end of the cycle we should have a first iteration of team metrics available in one place.
More specifically, a list of who is using GOV.UK Frontend, by service name / github repo and organisation.

MUST

• total number of github repo dependent on GOV.UK frontend - monthly, ie https://github.com/alphagov/govuk-frontend/network/dependents
• list of github repos that uses GOV.UK frontend, including via ports
• a way to assign organisation name to the repo list
• a way to collect the github repo data automatically and regularly (quarterly?)
• combine the github list with other sources, e.g x-gov, manual checks like the top 100, top 75 etc so that we have a comprehensive list of who and which organisation are using the Design System

SHOULD

• one place to display and find team metric
• include npm data into the same location, updated automatically and regularly (monthly)

COULD

• include mailchimp, total subscribers per month, into the same location, updated automatically and regularly (monthly)
• include zendesk data, total number of tickets per month, into the same location, updated automatically and regularly (monthly)
• build a dashboard

WON'T

• report on availability metric

Epic lead

Trang

Driving role(s)

Brett, Owen

Repo housekeeping

Preview Give feedback

1. Use DS auth token [using GitHub Actions' token]
2. Add basic linting to repo HOUSEKEEPING: Add basic linting design-system-github-stats#6
3. Remove raw-deps.json from ignore list HOUSEKEEPING: Remove raw-deps from .gitignore design-system-github-stats#5
4. Set branch protection rules

Data gathering

Preview Give feedback

1. Review filter/validation lists
2. Investigate retrieving data from indirect dependencies (including looking into how different tools consume govuk-frontend)

Automation

Preview Give feedback

1. Automate running of the script
2. Save to dated google sheet, with a separate sheet per view?

[Stretch] Dashboard

Preview Give feedback

1. Add basic tests to repo
2. Add history for results
3. Add reporting: on regressions, on script failures
4. Decide where to host Dashboard
5. Add NPM data
6. Add mailchimp data
7. Add Zendesk data

[trang-erskine]

SMT want some kind of availability that's common across the products.

• Pay is using payment acceptance rates, probably something on here https://payments.statuspage.io/#.

• Notify provide uptime and % of successful messages sent within 10 seconds.

We could share availability for Netlify (GOV.UK Design System website) and npm (GOV.UK Frontend).

[trang-erskine]

Value metrics

• npm download
• number of services using the Design System
• number organisation using the Design System
• community membership (total subscribers to mailchimp)

Nice to have?

• % of services using which major version of Frontend. e.g V4, V5

[trang-erskine]

Support / operational metrics, @kellylee-gds do you think we should zendesk? or is there anything else you can think of?

[kellylee-gds]

@trang-erskine I think Zendesk is a better metric than Slack or GitHub (at least until we begin proper backlog moderation)

[domoscargin]

We created an MVP implementation to deliver before the end of the cycle: alphagov/design-system-github-stats#4

We have further improved the repo (alphagov/design-system-github-stats#20, alphagov/design-system-github-stats#27) and plan to create small stories to finish up the work.