Govuk-frontend: Improve before and after steps in publishing docs

Created on 15 Sep 2020  路  6Comments  路  Source: alphagov/govuk-frontend

What

We currently have a fairly well documented process for creating the actual release of GOV.UK Frontend.

However it feels like that there are things around it which are missing from the docs:

  • We should probably have templates for all the various cards we need to create to complete the release.
  • The current docs don't mention creating the release notes and getting them 2id for both GOV.UK Frontend or Prototype Kit (forgetting about the latter nearly tripped me up the other day since the release note for the kit hadn't been drafted when I started doing the frontend release - this was my bad but it would have been helpful to have a heads up right at the start of the publishing docs to say this should be done before the Frontend release can be started).
  • The current docs don't mention publishing a new version of the kit; again we probably should check before we start the frontend release whether there's anything blocking the release of a new kit version such as a pending PR which should be included in the new version of the kit.
  • As part of the release we often have guidance/docs in the Design System or Frontend docs that need to be lined up and ready to publish once the release goes out; again it would be good to be reminded about this before starting the release so that we can check whether all these docs have been signed off and are ready to go.
  • We should probably write the Slack announcement together with the release notes, instead of writing it when the release has already gone out.

Why

To make the release process as easy as possible for us, and to ensure that everything is up-to-date when we tell our users about the new release.

Who needs to know about this

Tech writer, developers

Done when

  • [ ] A draft has been created in a Google doc
  • [ ] A draft has been reviewed by a tech writer (and possibly 2id)
documentation 馃晹 hours

Most helpful comment

@hannalaakso Just chatted through this with Eoin. When you have a PR ready with the changes, let us know and Eoin and I will review together. If you have any questions in the meantime just let us know!

All 6 comments

@hannalaakso this card is currently in the stretch goals section of the sprint board? Can you add the "done when" section to it please? Thank you!

@hannalaakso Just chatted through this with Eoin. When you have a PR ready with the changes, let us know and Eoin and I will review together. If you have any questions in the meantime just let us know!

@hannalaakso Have reviewed! Let me know if you want to go over anything.

Have sent doc for 2i.

The content has received 2i approval. I'll raise a PR to update the page.

Was this page helpful?
0 / 5 - 0 ratings