angular-ui/angular-ui.github.com

Automatically pull angular-ui components from Bower and/or repo

glebm opened this issue · 5 comments

This is about not having to update the demo site by copy pasting html by hand.

I propose we use a static site generator, such as middleman or jekyll, and pull the demo and component sources from Bower. These static generators allow including file sources, so we can directly include the demo from each component. This will be easier if angular-ui repos adopt a convention on demo filenaming.

We can pull either the latest release or the git repo from bower for stable/unstable demo site builds

Do you want to help us develop this out? This is currently the biggest issue I myself am facing and the critical reason AngularUI development is stuck. The project has undergone a restructure and I'm having trouble sorting out the docs to simply let everyone know.

Hi

I have given it a try using AngularJS, RequireJS, jQuery and the Git submodules...
Here is what I propose :

  • Each repo owns its documentation in a doc directory with a doc.html and a doc.js
  • Each doc.js returns a promise thus the main site knows when it's loaded.
  • The main site has a list of what to load in a simple json file.
  • The directives and filters are linked to a read-only address in the modules directory.

Repo test : https://github.com/douglasduteil/angular-ui.github.com
demo : http://douglasduteil.github.io/angular-ui.github.com
using the decentralized_doc_test0 branch of my ui-ace and the decentralized_doc_test0 branch of my ui-codemirror

What you think ?

Holy shit that's awesome.

So this looks like the right direction to go in and a solution I've been playing with for a while. One of the limitations I've had is trying to add controllers and directives, etc LATE. Another concern is that we need to be able to run the docs standalone on each project.

Also, we are no longer going to break things down into directives and filters, instead each plugin will be it's own module, and the modules that have 0 external dependencies will be additionally wrapped together into a ui.utils module.

Because of this new organizational breakdown, I'm not even sure if we're going to have 1 unified angular-ui demo page or if each module/repo will have it's own demo page. Secondly, I'm not sure if we're going to link to each repo individually from the top level navigation (where we link to ui-router and ui-bootstrap) or if we should retain the angular-ui project as a central switch station?

Thanks :)

Standalone doc.. It's messy but it works by linking stuff and emulating the main site.
Demo : http://douglasduteil.github.io/ui-d3/local-doc/.

This is great stuff!

If the standalone doc template (the one with "<!-- Le loading" comment) is in this repository, then each ui-* repo could pull that template from here, and not need to deal with the complexity of emulating the main site.

Would also be great to have guide page in the wiki how to set up pulling the template from submodules to make it easier for maintainers of ui-* repos to convert.