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

Create a new page highlighting v5 differences and how to migrate to v5 #315

Closed
1 of 4 tasks
Tracked by #2186
claireashworth opened this issue Jun 7, 2023 · 5 comments · Fixed by #357
Closed
1 of 4 tasks
Tracked by #2186

Create a new page highlighting v5 differences and how to migrate to v5 #315

claireashworth opened this issue Jun 7, 2023 · 5 comments · Fixed by #357
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@claireashworth
Copy link
Contributor

claireashworth commented Jun 7, 2023

What

Create a reference page for the differences between v4 and v5 and how to migrate to v5 for existing users.

Why

To use as a single source of information for existing users that we can also link to as needed from other documentation. This reduces duplication of info and makes the information easier to maintain/update.

Who needs to know about this

Tech writer, content designer, developers

Done when

The new page is published.

  • Draft content
  • Approve with team and community as needed
  • Independent review from another technical writer and Calvin
  • Publish
@claireashworth
Copy link
Contributor Author

Thie inital structure/draft is complete. Next stage is to flesh out the content and then send it to review.

@claireashworth
Copy link
Contributor Author

claireashworth commented Sep 4, 2023

Draft doc is here
Initial draft created alongside the draft release notes. Ready for review by the team.

(edit - review is reliant on when there are no more additions to changelog)

@claireashworth claireashworth moved this from In progress 📝 to Needs review 🔍 in GOV.UK Design System cycle board Sep 5, 2023
@Izabela-16 Izabela-16 moved this from Needs review 🔍 to In progress 📝 in GOV.UK Design System cycle board Sep 13, 2023
@claireashworth
Copy link
Contributor Author

This doc was updated with new additions on 17th October. Confirmation needed of no more additions to release notes before we can review and approve.

@claireashworth claireashworth moved this from In progress 📝 to Needs review 🔍 in GOV.UK Design System cycle board Oct 23, 2023
@claireashworth
Copy link
Contributor Author

Romaric left comments and I've made amendments based on those comments. There's still a couple of new things to add from the Changelog, but other than that it's ready for review.

@romaricpascal
Copy link
Member

Fixed by #357

@romaricpascal romaricpascal moved this from Needs review 🔍 to Ready to release 🚀 in GOV.UK Design System cycle board Oct 26, 2023
@36degrees 36degrees moved this from Ready to release 🚀 to Done 🏁 in GOV.UK Design System cycle board Dec 8, 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.

5 participants