search

alphagov / govuk-frontend

GOV.UK Frontend contains the code you need to start building a user interface for government platforms and services.
https://frontend.design-system.service.gov.uk/
MIT License
1.16k stars 319 forks source link

Improve docs for setting up a preview of GOV.UK Frontend branch #2057

Closed hannalaakso closed 3 years ago

hannalaakso commented 4 years ago

What

We have some guidance about publishing a pre-release of GOV.UK Frontend which essentially allows you to preview your GOV.UK Frontend branch in the Design System.

It would be good to do a tech writer review of the above docs.

We have a subsequent card https://github.com/alphagov/govuk-design-system/issues/1425 to link to these docs from the Design System community section.

Why

We should improve these docs to help contributors set up previews of their work in the Design System and saving our team time spent on supporting contributors.

Who needs to know about this

Eoin

Done when

EoinShaughnessy commented 3 years ago

@hannalaakso Have reviewed guidance and added comments to Google doc: https://docs.google.com/document/d/1chXZ0K8PkeXGLLewJ58a7BTloL_WyfuZ8nmjsdpbyRM/edit?usp=sharing

hannalaakso commented 3 years ago

Thanks @EoinShaughnessy, I left a few minor comments in the doc but overall it looks great.

EoinShaughnessy commented 3 years ago

@hannalaakso Have sent updated doc for tech writer review.

EoinShaughnessy commented 3 years ago

@hannalaakso Hi! Can I get your help with a few final questions the reviewer had? I tried to resolve these by following the steps, but couldn't confirm expected behaviour. https://docs.google.com/document/d/1chXZ0K8PkeXGLLewJ58a7BTloL_WyfuZ8nmjsdpbyRM/edit?usp=sharing

EoinShaughnessy commented 3 years ago

@hannalaakso The doc has passed 2i, so I've raised a PR. See https://github.com/alphagov/govuk-frontend/pull/2056.

The PR also includes a change I made, as we discussed, to the message for a successful run.

Is the next step (after PR review) to link to the updated doc from Research and develop your contribution?

hannalaakso commented 3 years ago

@EoinShaughnessy I've split linking to the doc to a separate card https://github.com/alphagov/govuk-design-system/issues/1425.

EoinShaughnessy commented 3 years ago

I've edited the doc to reflect the change of scope — towards users who have already made branch changes before they go to publish a pre-release. See https://github.com/alphagov/govuk-frontend/pull/2056.