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.

Sign up for GitHub

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

Jump to bottom

Improve explanation of the different module systems we support #373

Closed
2 tasks
Tracked by #366
romaricpascal opened this issue Nov 17, 2023 · 3 comments
Closed
2 tasks
Tracked by #366

Improve explanation of the different module systems we support #373

romaricpascal opened this issue Nov 17, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation
Milestone
v5.0

Comments

@romaricpascal
Copy link
Member

romaricpascal commented Nov 17, 2023 •
edited
Loading

What

  • Add some kind of "education" bit before diving into the details: "GOV.UK Frontend supports the following module systems"...
  • Clarify that we're still supporting UMD/CommonJS and that migrating to ES Modules, while encouraged can happen in a second stage
  • Bearing in mind that people may not be familiar with all these module systems

Why

We've noticed users were not necessarily familiar with which modules systems we were still supporting, or with the terminology around these modules systems

Who needs to work on this

Developers, Tech writers

Who needs to review this

Developers, Tech writers

Done when

  • We've defined how and where we'd clarify this
  • We've update the relevant pieces of documentation
@romaricpascal romaricpascal mentioned this issue Nov 17, 2023
Closed
4 tasks
@romaricpascal romaricpascal added documentation Improvements or additions to documentation javascript Pull requests that update Javascript code and removed javascript Pull requests that update Javascript code labels Nov 17, 2023
@romaricpascal romaricpascal moved this from Backlog 🗄 to To discuss in GOV.UK Design System cycle board Nov 17, 2023
@romaricpascal romaricpascal mentioned this issue Nov 17, 2023
Closed
1 task
@romaricpascal romaricpascal added this to the v5.0 milestone Nov 17, 2023
@romaricpascal romaricpascal changed the title Improve understanding of the different module systems we support Improve explanation of the different module systems we support Nov 17, 2023
@romaricpascal
Copy link
Member Author

This piece of content should probably go in the "Import CSS, assets and JavaScript" page.

@romaricpascal romaricpascal moved this from To discuss to Sprint Backlog 🏃🏼‍♀️ in GOV.UK Design System cycle board Nov 21, 2023
@romaricpascal romaricpascal mentioned this issue Nov 27, 2023
Closed
9 tasks
@romaricpascal
Copy link
Member Author

Should be closed when #341 merges

@colinrotherham colinrotherham moved this from Sprint Backlog 🏃🏼‍♀️ to In progress 📝 in GOV.UK Design System cycle board Dec 7, 2023
@colinrotherham colinrotherham self-assigned this Dec 7, 2023
@romaricpascal
Copy link
Member Author

Closed by #395 , #397, #398 and #404

@romaricpascal romaricpascal moved this from In progress 📝 to Done 🏁 in GOV.UK Design System cycle board Dec 8, 2023
@colinrotherham colinrotherham removed their assignment Dec 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
GOV.UK Design System cycle board
Archived in project
Milestone
v5.0
Development

No branches or pull requests
2 participants
@romaricpascal @colinrotherham