Setup automated builds for documentation

[andrewconnell]

Model process after what the Angular Material guys have done. See https://github.com/angular/material/tree/master/docs

[suhasdeshpande]

I will start putting together a docsApp that is pretty much like material.

[andrewconnell]

Can you share a bit more before running with this? This is something we certainly want to automate as part of our releases & would like to make sure it integrates the output into our main site @ ngofficeuifabric.com.

[suhasdeshpande]

I am going to take a stab at this. Angular material site uses https://github.com/angular/dgeni to parse all the comments and creates templates based on descriptors used in your comments. Demos are renedered as iframe. We can re-use their processors and customize the templates to use office-fabric instead of material. Regarding deployment, I am guessing it won't be difficult to integrate with your main site. How about I start working on it and keep my PR open for you guys to suggest / guide me in the process?

[andrewconnell]

If you want to go with that approach, please do include "WIP" in the title of the PR. This is also tied to #10.

I'm cool with this approach... so the docs + demo site will be one in the same? That's definitely preferred. I suspect a good number of our directives need updated docs as I'm not sure if we have enough content in there. if it comes out looking like the material design site (in terms of functionality & usability). This works for me and looking forward to what you come up with.

When working on this, if we need to modify some stuff with each directive, let's chat first.

One thing to keep in mind: we do want to make sure this process is 100% scriptable. In the end we will want to include an update of the doc/demo site whenever we cut a new release.

[suhasdeshpande]

100% scriptable. One small question, I am really new to TS. Actually never used it yet. For doucmentation, we will need to write or customize ngDocs dgeni package . Is it okay to write processors/services for that in es6?

[andrewconnell]

Hmm… the whole project is TypeScript at this time, zero JS. Having a big exception like this when it isn’t necessary isn’t ideal. If you can’t do it in TS, if you did it in JS, we could port it before we merge it into the master branch. Happy to help along the way if you want to try to do it as TS… maybe a good learning tool? :)

[suhasdeshpande]

Ok Cool. I wonder why I don't get any notification when you comment. Anyhow, sorry for late response. I have been trying to wramp up on TS.

[andrewconnell]

Touching base on this issue... how's it going @suhasdeshpande ?

[andrewconnell]

Reassigning to me as previous owner hasn't checked in or updated process in some time...