Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add guidance on staying up to date #339

Closed
1 of 3 tasks
Tracked by #2186
36degrees opened this issue Aug 8, 2023 · 2 comments · Fixed by #338
Closed
1 of 3 tasks
Tracked by #2186

Add guidance on staying up to date #339

36degrees opened this issue Aug 8, 2023 · 2 comments · Fixed by #338
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@36degrees
Copy link
Contributor

36degrees commented Aug 8, 2023

What

Replace the existing guidance on updating with npm with new guidance that covers:

  • the benefits of staying up to date
  • how to find out what version you are currently using
  • how to update if you've installed GOV.UK Frontend from precompiled files
  • how to be notified when there's a new release (replacing the existing guidance in the README)
  • how versioning works
  • how to use the release notes effectively (for example what each of the sections mean)

Then:

  • redirect the old path for the updating with npm guidance to the new docs
  • replace the section in the README with a link to the docs
  • add a link from the top of the changelog to the new guidance

Why

We want to encourage all users – not just those who have installed from npm – to keep up to date with new releases.

We want to be able to link from the release notes to some supporting material that helps users understand how to use them effectively.

Who needs to know about this

Tech writer, developers

Done when

  • New guidance on staying up to date has been published
  • README updated to remove duplication and link to the new guidance
  • The existing URL for the updating with npm guidance redirects to the new guidance
@36degrees
Copy link
Contributor Author

Waiting for external 2i.

@claireashworth
Copy link
Contributor

external 2i complete in google doc.

@36degrees 36degrees moved this from Needs review 🔍 to Done 🏁 in GOV.UK Design System cycle board Aug 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

Successfully merging a pull request may close this issue.

2 participants