alphagov / govuk-prototype-kit

Rapidly create HTML prototypes of GOV.UK services
https://prototype-kit.service.gov.uk
MIT License
306 stars 236 forks source link

Review the automated and manual migration processes #1634

Closed joelanman closed 2 years ago

joelanman commented 2 years ago

What

As a team, review the automated and manual migration processes

Why

Who needs to work on this

Who needs to review this

Done when

Izabela-16 commented 2 years ago

Any changes will go to the separate card

Izabela-16 commented 2 years ago

Prototype test cases @joelanman to link them to the ticket

joelanman commented 2 years ago

here's some, will add more when I find them

A good way to find them is to go to dept github accounts and search 'prototype' in their repos

lfdebrux commented 2 years ago

@BenSurgisonGDS and I started looking at this today, some notes: https://docs.google.com/document/d/1nxIiYASTqo2j7bAssAgi4aIMiXVElJybe01ZwLaz0JA/edit

lfdebrux commented 2 years ago

I've finished reviewing and documenting the process needed to migrate a prototype, I've documented in the first section of https://docs.google.com/document/d/1nxIiYASTqo2j7bAssAgi4aIMiXVElJybe01ZwLaz0JA.

@nataliecarey @BenSurgisonGDS please take a look and let me know if I've missed any steps.

I've deliberately kept the content detailed but succint, as there are a lot of steps. This means that only an expert user would be able to understand the steps, but I've kept the target audience as being team members. I don't think we'd be able to write content that would explain each step in a way that fit with the needs of a plurality of our users.

lfdebrux commented 2 years ago

In terms of reviewing the automated process, we're part way there. @BenSurgisonGDS and I understand what it is supposed to be doing, and we've shared what we've learnt with @joelanman. Whats outstanding is: @BenSurgisonGDS is continuing to add tests to make sure it is actually doing what it is supposed to; and I would like it if we had a shared understanding and agreement among the team of what the automated process does and doesn't do.

lfdebrux commented 2 years ago

We want to get some quantitive data before we make decisions on further changes to the automated process (see ticket #1720), so I'm putting this ticket in blocked until that work has been completed.

lfdebrux commented 2 years ago

After looking at the automated migration script I have some proposals for changes:

We might make more as a result of reviewing the output of #1720.

lfdebrux commented 2 years ago

We've agreed to move the above tickets https://github.com/alphagov/govuk-prototype-kit/issues/1634#issuecomment-1294863003 into the sprint backlog, but that we don't think further changes are probably needed right now.