alphagov / design-system-support

Scripts that helps the GOV.UK Design System team support users

Design System Support

This repository contains code to help us do support on the GOV.UK Design System team.

Requirements

• Git
• Node.js (npm)
• Security access to credentials

Setup

Clone this repository to your machine locally and then pull it's dependencies using

npm install

Adding credentials

You'll need access to BitWarden to access the credentials for ZenDesk.

1. Copy .env.example to .env
2. Fill in credentials

.env is ignored by git, but make sure not to put these credentials into version control

Generating support log CSVs

When doing analysis of our support, we take Slack, Zendesk and Github data and bring them together.

You can generate CSVs from Zendesk and Github, which then need to be copied into the main spreadsheet.

all CSV files in this repository are ignored by git, but make sure not to put these credentials into version control

Build all

npm run build:csv

Zendesk

npm run build:csv:zendesk

Github

npm run build:csv:github

You can adjust how far back to pull Github issues by passing the createdMonthsAgo argument in the command line.

The default is 1 month.

npm run build:csv:github -- --createdMonthsAgo=3

design-system-support's Issues

Zendesk tagging is not appearing in reports

What

Zendesk tagging data is not pulling into the monthly reports that are pulled by the devs. Ideally I'd get both the primary tag and also the secondary one coming through, but I assume this needs the script to be adjusted slightly. I'm not sure if this helps, but I can ask the Zendesk support desk if there's a specific thing we need to include in the script to get this.

Why

So we can pull data on Zendesk tags for the Support Dashboard.

Who needs to work on this

Dev

Who needs to review this

PA

Done when

• The Zendesk tags (primary and secondary) are pulling into the reports that the developers pull.

`createdMonthsAgo` flag doesn't work

The flag that's reported in the README doesn't have any effect

npm run build:csv:github -- --createdMonthsAgo=3

As a temporary measure you can override the default here: https://github.com/alphagov/design-system-support/blob/master/src/github/index.js#L36

Update zendesk support function to account for different tag and KPI columns

Problem

At the moment, the zendesk csv generation function will output both primary and secondary tags as a single string, like so:

"primary_tag,secondary_tag"

This doesn't line up with how we format our zendesk support spreadsheet. It additionally doesn't account for the column "KPI Met". It appears that there was an extra step by whoever was managing this data previously to clean up the data after the csv gets generated.

Proposal

• Split the tags into separate primary and secondary tag columns
• Explicitly set a blank column for the KPI which can be handled manually after export as there doesn't appear to be a way to draw this information from zendesk API response