openMF/mifosx — pull request #631 by vorburger (2013-10-12 13:23:19+00:00)
Title: GSoC UGD API Doc proposal (for discussion & review)

Hi guys,

here is finally the PR for the GSoC UGD API Doc... basically https://github.com/weigel/mifosx/commit/b2e6054053d8576e493860e3fbfd1c7b9a52e90e from Andreas, plus some additional intro. blurb and minor change from me. This is for your kind consideration, discussion & review - unless you can pull as-is. Points in particular:

* it occurred to me only on reading this API Doc, a little late admittedly, that the "Template" terminology we've chosen for the back-end of UGD overlaps with what you call Template in the existing API - which has nothing to do with this of course.. this could be confusing to users? It's perhaps a little late to change that.. opinions? Concrete suggestions how to (re)name which? - Maybe you could pull this doc in as-is into develop so that at least there is SOME doc - and then have a separate thread on renaming.. what - entire API, URLs, packages, and doc? I won't have time for this, but could pick it up with Andreas later - depending on how you feel about this double use of "Template" in Mifos X. If it's a non-issue for you, please say so and let's ignore it.

* how do you make our new section show up on top ribbon and in bottom Beta API Matrix? May be trivial - I simply haven't look closely. Will you do that?

Best,
Michael