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

Define and create new content needed for v5.0.0 of GOV.UK Frontend #311

Closed
4 tasks done
Tracked by #2186
claireashworth opened this issue Apr 26, 2023 · 3 comments
Closed
4 tasks done
Tracked by #2186
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@claireashworth
Copy link
Contributor

claireashworth commented Apr 26, 2023

What

Define what changes are needed to update our content for v.5.0.0 of GOV.UK Frontend and draft content.

Why

v5.0.0 might need explicit documentation to differentiate it from v4.0.0.

Who needs to work on this and review it

Tech writer, content designer, developers, designers

Done when

The content is agreed and drafted ready for testing with users and reviewing.

  • Use plans from #3549 to define what needs to be in documentation for v5.0.0
  • Write draft documentation for v5.0.0
  • Review complete
  • Final amendments before publishing
@claireashworth claireashworth added the documentation Improvements or additions to documentation label Apr 26, 2023
@claireashworth claireashworth self-assigned this Apr 26, 2023
@claireashworth
Copy link
Contributor Author

Content changes identified to date:

Frontend Site

Landing page

  • clarify the line ‘use GOV.UK Frontend with old (‘legacy’) GOV.UK frameworks’
  • add another line about using previous versions of frontend
  • potentially move some of the initial ‘get started’ info to this page in preparation for amending that section (maybe a name change to something like ‘Setting up GOV.UK Frontend’)
    Install with Node.js package manager (npm)
  • check whether the requirements need updating
  • check whether the install instructions need updating
    Install using precompiled files
  • check whether package install is correct and update link as needed
  • update the ‘cannot do after installing’ information. This could potentially include some relevant info about v4/v5 differences with a link to a new page on the differences if we go that route
  • [from Ollie] update the example HTML to update the inline script and to remove the IE8 specific stylesheet
  • [from Ollie] update the example in step 3 of ‘copy the files’ to remove the crown png reference
  • [from Ollie] - In Get started step 5 ('Get the JavaScript working') - the inline script in step 1 will need updating and Step 3 will need updating (to use type="module", I think?)
    Update using Node.js package manager (npm)
  • update example where it shows version “4.5.0”
  • update earlier versions example?
  • would this work better if moved next to the Installing npm section?
    Support Internet Explorer 8
  • [from Ollie] - This page will need to be removed
    Use with our old frameworks or colours
  • [from Ollie] - This page will need to be removed
    Using HTML test files
  • Check if the file structure change means this section needs updating with different file paths
    Migration from our old frameworks
  • [from Ollie] - This page will need to be removed
  • This page to be replaced with a new page about migrating to v5 and highlighting the differences between v4 and v5 for reference
    Import CSS, assets and JavaScript
  • [from Ollie] 'Import JavaScript using a bundler' might change
  • [from Ollie] The CSP hash for the inline script will have changed in v5
  • [from Ollie] 'Select and initialise an individual component' might change if we create a static function to instantiate new components
    Configure components with JavaScript
  • [from Ollie] 'Passing configuration to a new instance of a component in JavaScript' might change if we create a static function to instantiate new component
    Javascript API reference
  • [from Ollie] The example at the top of the document (set the preventDoubleClick option of a button) might change
    Sass API reference
  • [from Ollie] The entry for $govuk-new-link-styles will no longer exist after v5, but needs to remain for v4

@claireashworth claireashworth moved this from Backlog 🗄 to In progress 📝 in GOV.UK Design System cycle board Jun 26, 2023
@claireashworth claireashworth moved this from In progress 📝 to Sprint Backlog 🏃🏼‍♀️ in GOV.UK Design System cycle board Jul 11, 2023
@claireashworth claireashworth moved this from Sprint Backlog 🏃🏼‍♀️ to In progress 📝 in GOV.UK Design System cycle board Jul 11, 2023
@36degrees 36degrees added this to the v5.0.0 milestone Jul 31, 2023
@claireashworth
Copy link
Contributor Author

The 2 main pieces of content left to do are:

@claireashworth claireashworth moved this from In progress 📝 to Needs review 🔍 in GOV.UK Design System cycle board Aug 1, 2023
@Izabela-16
Copy link

Ollie to look at documenting it on Friday, so Claire is clear what solution will be used.

@36degrees 36degrees moved this from Needs review 🔍 to In progress 📝 in GOV.UK Design System cycle board Sep 18, 2023
@colinrotherham colinrotherham moved this from In progress 📝 to Needs review 🔍 in GOV.UK Design System cycle board Sep 18, 2023
@Izabela-16 Izabela-16 moved this from Needs review 🔍 to Done 🏁 in GOV.UK Design System cycle board Sep 25, 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

No branches or pull requests

4 participants