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

Update documentation on tasks #2772

Closed
2 of 3 tasks
domoscargin opened this issue Aug 15, 2022 · 1 comment
Closed
2 of 3 tasks

Update documentation on tasks #2772

domoscargin opened this issue Aug 15, 2022 · 1 comment
Labels
documentation User requests new documentation or improvements to existing documentation tooling

Comments

@domoscargin
Copy link
Contributor

domoscargin commented Aug 15, 2022

What

Update docs/contributing/tasks.md and docs/contributing/coding-standards to remove references to gulp, and bring the descriptions of tasks up to date.

Why

We have made the decision to move away from Gulp and write our own build scripts.

Some of our guidance is already slightly out of sync with our current tasks, and will get more out of sync as we remove gulp from our tooling.

(There's a separate issue of how we prevent this guidance from getting out of sync in the future...)

Who needs to work on this

Developer, Technical Writer

Who needs to review this

Developer, Technical Writer

Done when

  • We've decided which script aliases and tasks we're going to provide guidance for
  • We've updated docs/contributing/tasks.md
  • We've removed any references to gulp in the documentation
@domoscargin domoscargin added documentation User requests new documentation or improvements to existing documentation tooling javascript squad labels Aug 15, 2022
@kellylee-gds kellylee-gds modified the milestone: Remove or improve Gulp Jan 31, 2023
@colinrotherham colinrotherham self-assigned this Mar 31, 2023
@colinrotherham colinrotherham moved this from Backlog 🗄 to In progress 📝 in GOV.UK Design System cycle board Mar 31, 2023
@colinrotherham
Copy link
Contributor

I'm going to close this as we've picked up documentation on the individual build task issues

Some named Gulp tasks do remain for developer convenience but they're limited to:

Project level

npx gulp build:package
npx gulp build:dist
npx gulp screenshots

Review app

npx --workspace app -- gulp build
npx --workspace app -- gulp dev
npx --workspace app -- gulp scripts
npx --workspace app -- gulp styles

They're only documented when not called by an npm script

For example npm run build:package calls gulp build:package

@stevenjmesser stevenjmesser moved this from In progress 📝 to Done 🏁 in GOV.UK Design System cycle board Apr 3, 2023
@colinrotherham colinrotherham removed their assignment Dec 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation User requests new documentation or improvements to existing documentation tooling
Projects
Development

No branches or pull requests

3 participants