search

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

Move templates and patterns to plugins #1653

Closed joelanman closed 1 year ago

joelanman commented 2 years ago

What

We provide some patterns and templates in the kit, such as:

We'd like to consider moving them to plug-ins, installed by default

Why

If any of these change, they require a new release of the kit itself. This is especially a problem if it is a breaking change in the pattern or template as it makes the kit itself look like a major release.

It also puts us in a better position to support transition from our patterns to one in the design system (such as is happening to Task List)

Who needs to work on this

Who needs to review this

Done when

Izabela-16 commented 2 years ago

@nataliecarey please review and let us know how we want to proceed before the planning session next week. Is this something we want to include in v13?

joelanman commented 2 years ago

I think we'd end up with 3 plug-ins (these arent finalised names):

govuk-prototype-kit-templates

The in-service templates like Question, Content, Check answers

govuk-publishing-templates

The govuk publishing templates, like Start page and Mainstream guide, and any necessary components like Related links

govuk-task-list

The task list template/component.

Possibly a 4th - the existing Step by step plugin

One issue with naming is, they will include both templates and components, so 'templates' alone might not be right?

joelanman commented 1 year ago

We now have 3 plugins:

We have to think about how we can manage the release of the kit where these are removed. If we do nothing prototypes will break as they rely on these plugins, so ideally we can auto install them at the same time.

We should also add the common templates plugin to the starter package.json