[MapQuery] documentation time :)

[Steven Ottens]

Hi Volker,

Thanks, just trying to get a release out of the door before foss4g so people will know it exists and might be interested in my talk on mapquery ;)

Now we have a more or less functioning doc framework I was looking in the next step:
Auto generate tests, docs and examples after commits.

I was thinking: if we could somehow trigger the build tools after a commit to /mapquery/mapquery we could put the result of the build tools in /mapquery/mapquery.github.com and push them to github. Github will then update mapquery.org and we're set.

It will not be instantaneous but reasonably fast. Also we will have our entire website, tests, docs and examples in git. So people can both fork them and see their history and find out where it went wrong.

The question is, does anyone has an idea how to trigger actions after a commit to github? 
Preferably all on GitHub, but I can imagine that they don't want to build other stuff, so we can do it another server (mine or osgeo or something)

Steven

On Jul 5, 2011, at 6:22 PM, Volker Mische wrote:

> Hi Steven,
> 
> thanks for all your hard work, you really rock! I hope I'll have the
> time to play with the doc tools soon.
> 
> Cheers,
>  Volker
> 
> On 07/05/2011 06:04 PM, Steven M. Ottens wrote:
>> New version of the docs at
>> http://mapquery.geodan.nl
>> 
>> people can reproduce and enhance on them with:
>> https://github.com/stvno/mapquery
>> https://github.com/stvno/jodoc-js
>> 
>> ciao
>> s
>> 
>> On 7/4/2011 5:35 PM, Steven M. Ottens wrote:
>>> Hi all,
>>> 
>>> I played a bit with joDoc and came up with this:
>>> http://mapquery.geodan.nl/jquery.mapquery.core.js.html
>>> <http://mapquery.geodan.nl/jquery.mapquery.core.js.html#MapQuery.Core>
>>> based on
>>> https://github.com/stvno/mapquery/blob/master/src/jquery.mapquery.core.js
>>> 
>>> I've take inspiration from jQuery API docs and polymaps
>>> http://polymaps.org/docs/map.html The current stylesheet is the
>>> default joDoc one and obviously needs a bit of love to make the docs
>>> more readable. Also I would like to autogenerate internal hyperlink
>>> (similar to the once on top of the polymaps link).
>>> 
>>> And last but not least I'm having troubles with layer options like
>>> types. We do want to put them somewhere, but the current position
>>> isn't very nice.
>>> 
>>> Please have a look and give feedback
>>> 
>>> Regards,
>>> Steven
>>> 
>>> 
>>> On 6/30/2011 5:25 PM, Steven M. Ottens wrote:
>>>> Hi all,
>>>> 
>>>> I've finished adding new widgets to MapQuery for the moment. I
>>>> created examples for all the widgets (except for mqLayerControl). We
>>>> now have the proposed list for the 0.1 release:
>>>> -zoombuttons
>>>> -zoomslider
>>>> -overviewmap
>>>> -layercontrol (in this case mqLayerManager)
>>>> -popup with (get)featureinfo
>>>> +mouseposition
>>>> I'd like to leave mqLayerControl outside a possible first release
>>>> since it's pretty much the same as mqLayerManager, but hasn't gotten
>>>> much love and is a bit old fashioned (eg doesn't listen to most
>>>> events). Since mqLayerManager and mqLayerControl are so much the same
>>>> we might want to merge them in the future, eg make it possible to
>>>> enable/disable certain features of the mqLayerManager.
>>>> 
>>>> The main issue now is: we need documentation. I prefer to generate
>>>> most of the API docs from code. Which means we need to put it in some
>>>> kind of format and have a system to generate a nice set of HTML
>>>> files. Volker mentioned two systems:
>>>> -docco: http://jashkenas.github.com/docco/
>>>> -joDoc: https://github.com/davebalmer/joDoc/
>>>> <https://github.com/davebalmer/joDoc>
>>>> 
>>>> So the questions are:
>>>> -Have people used other systems to generate docs for javascript?
>>>> -Any preferences?
>>>> -Do the current widgets and examples make sense?
>>>> -Is something vital missing?
>>>> -Anyone time to write docs?
>>>> -Anyone time to write tests?
>>>> 
>>>> regards,
>>>> Steven
>>>> 
>>>> ps. I've got an ubuntu server which we can use for the moment to
>>>> generate and host docs and 'autobuilds' until someone figured out how
>>>> to do this on github itself. So any system should run ubuntu (10.04
>>>> LTS) without too much hassle at least.
>>>> 
>>>> 
>>>> _______________________________________________
>>>> MapQuery mailing list
>>>> MapQuery at lists.osgeo.org
>>>> http://lists.osgeo.org/mailman/listinfo/mapquery
>>> 
>>> 
>>> _______________________________________________
>>> MapQuery mailing list
>>> MapQuery at lists.osgeo.org
>>> http://lists.osgeo.org/mailman/listinfo/mapquery
>> 
>> 
>> 
>> _______________________________________________
>> MapQuery mailing list
>> MapQuery at lists.osgeo.org
>> http://lists.osgeo.org/mailman/listinfo/mapquery
>