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 new package directories, filenames, extensions #3482

Closed
5 tasks done
Tracked by #2639 ...
romaricpascal opened this issue Apr 3, 2023 · 3 comments
Closed
5 tasks done
Tracked by #2639 ...

Define new package directories, filenames, extensions #3482

romaricpascal opened this issue Apr 3, 2023 · 3 comments

Comments

@romaricpascal
Copy link
Member

romaricpascal commented Apr 3, 2023

What

Agree on what the published package should look like for v5, focusing on what versions of the component JavaScript (and other entry points) need to exist, including:

  • directory structures
  • file names and extensions
  • what transformations need to be made to each version (transpilation, addition of polyfills)

Draft updated documentation for Importing JavaScript that shows how and when the various versions of the JavaScript would be used by teams.

Why

Build a shared vision for the package so we know where we're trying to get to.

We can use the agreed package structure and draft documentation when communicating the upcoming changes to the community, allowing us to get feedback and reduce the risk around the changes.

Who needs to work on this

Developers, Tech writers

Who needs to review this

Developers, Tech writers

Done when

### We've agreed on

Tasks

Tasks

@colinrotherham colinrotherham changed the title Define new package structure Define new package directories, filenames Jun 15, 2023
@colinrotherham colinrotherham changed the title Define new package directories, filenames Define new package directories, filenames, extensions Jun 15, 2023
@36degrees 36degrees moved this from Backlog 🗄 to In progress 📝 in GOV.UK Design System cycle board Jun 20, 2023
@colinrotherham colinrotherham moved this from In progress 📝 to Needs review 🔍 in GOV.UK Design System cycle board Jun 27, 2023
@colinrotherham colinrotherham linked a pull request Jul 5, 2023 that will close this issue
@colinrotherham
Copy link
Contributor

Decision record for this issue:

I've updated the tasks with remaining documentation changes

@colinrotherham
Copy link
Contributor

That's all the outstanding changes to govuk-frontend ticked off in #3950

Next it's the Frontend documentation site

@colinrotherham
Copy link
Contributor

Going to close this one 🙌

Realised we've double-task-listed the Frontend Docs changes in:

@colinrotherham colinrotherham moved this from In progress 📝 to Done 🏁 in GOV.UK Design System cycle board Jul 13, 2023
@colinrotherham colinrotherham moved this from Done 🏁 to Ready to release 🚀 in GOV.UK Design System cycle board Jul 13, 2023
@colinrotherham colinrotherham removed their assignment Aug 23, 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
None yet
Projects
Development

No branches or pull requests

2 participants