Skip to content
This repository was archived by the owner on Sep 20, 2019. It is now read-only.

Commit e0e40f2

Browse files
committed
docs(workflow): workflow about website proccess and build tools
1 parent ef7d702 commit e0e40f2

File tree

3 files changed

+43
-0
lines changed

3 files changed

+43
-0
lines changed

doc/workflow/build-tool/grunt.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Grunt Documentation
2+
===================
3+
4+
Starting place for documentation specific to this projects grunt build process.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Next-Gen Build Tool Framework
2+
=============================
3+
4+
Currently grunt is the de-facto way of doing things on this project. However, grunt is quite outdated when compared to
5+
gulp, brunch.io, and etc.
6+
7+
Point is if someone has a stick up their butt to do this we should migrate this project targeting angular 1.X before moving to or
8+
supporting angular 2.X .
9+
10+
11+
@nmccready is quite familiar with grunt, gulpjs, and brunch.io . But he feels that the project is not quite worth the effort in migrating yet.
12+
13+
14+
Therefore if someone else who has experience in gulp, or brunch.io and has a fire in their belly to take this on for fun please raide your hand. :)

doc/workflow/website.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Website Workflow Documentation
2+
==============================
3+
4+
The branches *master* and *gh-pages* are now one in the same except that gh-pages has bower_components (--force) saved to the branch.
5+
6+
Reasoning:
7+
8+
- less confusion where and how gh-pages are deployed
9+
- code and docs exist in the same branch. There are **NO** **Excuses** to not update documentation now with things being in the same place.
10+
- documentation is now under the same version control and pull process and history of this libraries releases
11+
12+
13+
To run just the website via grunt do:
14+
15+
- `grunt website`
16+
17+
- Open browser to [localhost:8888](http://localhost:8888).
18+
19+
- When done: PR or push code up.
20+
21+
- merge master into gh-pages (via PR acceptance or manual git cli merge)
22+
23+
- If there are new bower_components or new bower dependencies `bower install` and then `git add -A bower_components --force`.
24+
25+
- Finally PR or push up modified bower_components or include in previous PR above

0 commit comments

Comments
 (0)