capital-framework icon indicating copy to clipboard operation
capital-framework copied to clipboard

Document the Gulp tasks

Open himedlooff opened this issue 11 years ago • 10 comments

It would be nice to describe what the tasks are doing so others can modify/tweak this repo for their own projects. For example in the Workflow section of the readme, step three says:

grunt vendor – Pulls in Bower components.

This is good enough for the readme but there needs to be further explanation. For example this task also routes vendor assets for you, concatenates all of the cf components, rewrites img and font asset locations, etc. This is useful information to know and documented on our docs site.

Ideas for explaining the tasks

  • bower-install
    Downloads dependencies and routes dependency assets that are flagged in the exportsOverride section of bower.json into the demo folder.
  • concat
    Concatenates dependency styles.
  • copy
    Copies dependency assets that have been routed to the demo folder during the bower-install task into the docs folder.

...

himedlooff avatar Mar 05 '14 20:03 himedlooff

I've started working on diagraming this instead of using words, might be easier to digest and easier to pick and choose what you want to review.

Preview:

grunt-tasks-diagram

himedlooff avatar Apr 17 '14 14:04 himedlooff

Also I started outlining stuff here: https://github.com/cfpb/capital-framework/blob/gh-pages/_data/component-grunt-terms.yml

himedlooff avatar Oct 29 '14 21:10 himedlooff

Or instead of this maybe we add comments to the tasks in the Gruntfile.

himedlooff avatar Oct 29 '14 21:10 himedlooff

That diagram is incredibly helpful. Related to #151.

contolini avatar Apr 23 '15 15:04 contolini

It's probably out of date

himedlooff avatar Apr 23 '15 17:04 himedlooff

@himedlooff Is there a source AI file for that diagram somewhere?

anselmbradford avatar May 12 '15 17:05 anselmbradford

  • Download this XML file https://gist.github.com/himedlooff/118c0f3895607fbbf900
  • Go to https://www.draw.io/
  • Choose "Save diagrams to: Device"
  • Choose "Open existing diagram"
  • Choose the XML file

himedlooff avatar May 13 '15 20:05 himedlooff

Neato!

anselmbradford avatar May 13 '15 21:05 anselmbradford

We've switched to gulp but this is still a good idea

jimmynotjim avatar Jan 12 '17 21:01 jimmynotjim

gulp --tasks sort of covers this, and we document build and test in https://github.com/cfpb/capital-framework/blob/canary/CONTRIBUTING.md

anselmbradford avatar Dec 06 '18 18:12 anselmbradford