Review content of migration script output

lfdebrux commented 2 years ago

What

Review how the automated migration script for v13 communicates with user, and revise if necessary.

Why

We want to make sure users are clear about what they need to do after running the migration script.

Who needs to work on this

Content designer, Developer

Who needs to review this

Content designer, Developer

Done when

[x] We are happy with the output of the v13 automated migration script
[x] We are confident users will know what to do with the output

lfdebrux commented 2 years ago

Example current content:

% node ~/Code/design-system/govuk-prototype-kit--v13/bin/cli migrate
Migrating your prototype to v13

added 435 packages in 20s

33 packages are looking for funding
  run `npm fund` for details
Succeeded [Migrate config.js to config.json]
Succeeded [Deleted files that are no longer needed]
Failed [Overwrite app/filters.js]
Failed [Overwrite app/assets/javascripts/application.js]
Failed [Overwrite app/views/layout.html]
Failed [Delete app/assets/sass/application.scss]
Failed [Delete app/assets/sass/patterns/_check-your-answers.scss]
Failed [Delete app/assets/sass/patterns/_pagination.scss]
Failed [Delete app/assets/sass/patterns/_task-list.scss]
Failed [Delete app/assets/sass/unbranded.scss]
Failed [Delete app/views/includes/breadcrumb_examples.html]
Succeeded [Delete app/assets/images/separator-2x.png]
Succeeded [Delete app/assets/javascripts/auto-store-data.js]
Succeeded [Delete app/assets/images/separator.png]
Succeeded [Delete app/assets/images/unbranded.ico]
Succeeded [Delete app/assets/javascripts/jquery-1.11.3.js]
Succeeded [Update application SCSS file]
Succeeded [Update routes file]
Succeeded [Deleted directories that are no longer needed]
Failed [Remove empty directory /app/assets/images]
Failed [Remove empty directory /app/assets/sass/patterns]
Failed [Remove empty directory /app/views/includes]

In my opinion this is a bit wordy, and it doesn't really tell user what to do.

lfdebrux commented 2 years ago

@NoraGDS to pair with developer on content.

lfdebrux commented 2 years ago

I think there are three scenarios we need to consider here:

script migrates prototype without failures, user can try running prototype
script migrates prototype but has one or more failures, user should contact support
script does not try migrating prototype for one or more reasons, user should contact support

lfdebrux commented 2 years ago

@NoraGDS and I discussed, she's happy with the current output, she found it useful for the script to show it's doing something, just needed a message at the end to explain what to do next.

We drafted content in Google Docs:

https://docs.google.com/document/d/1MeequzheG79JnB9zjy9PpoK3yIVmDNzmANkzgorLOCw/edit

alphagov / govuk-prototype-kit