capital-framework
capital-framework copied to clipboard
Document the Gulp tasks
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 theexportsOverridesection ofbower.jsoninto thedemofolder.concat
Concatenates dependency styles.copy
Copies dependency assets that have been routed to thedemofolder during thebower-installtask into thedocsfolder.
...
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:

Also I started outlining stuff here: https://github.com/cfpb/capital-framework/blob/gh-pages/_data/component-grunt-terms.yml
Or instead of this maybe we add comments to the tasks in the Gruntfile.
That diagram is incredibly helpful. Related to #151.
It's probably out of date
@himedlooff Is there a source AI file for that diagram somewhere?
- 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
Neato!
We've switched to gulp but this is still a good idea
gulp --tasks sort of covers this, and we document build and test in https://github.com/cfpb/capital-framework/blob/canary/CONTRIBUTING.md