← Back to team overview

dhis2-devs team mailing list archive

Re: Developer manual

 

Hi Jason

This a most welcome development which will definitely revolutionize Web API
driven web development. One issue which I recommend you to note would be:

There have been so many changes in the Web API from 2.14 to 2.16 from the
perspective of building apps on top of dhis2 such that there is always the
risk of apps breaking when the underlying dhis2 backend is upgraded. So not
sure how easy it will be to deal with such challenges in the upcoming
manual. Maybe some tips and tricks (relevant to the dhis2 version in use)
will suffice.
 Hi there. Based on some good feedback last week during the Oslo DHIS2
Academy, I have made a first cut of a developer manual. As I see it, this
basically involves slicing out all of the stuff really aimed more at
developers (and in some cases implementers) and less so, users. The chapter
on the WebAPI is being constantly expanded by the core developers, but in
many cases, far exceeds the level of information required by most users.
Some of the developers/implementers which I spoke with last week wanted
more information in the developers manual. So, I think moving the really
technical stuff to a dedicated developer manual would be a good idea, and
allow even more detailed technical stuff to be written, without necessarily
addressing the needs of the  users.

I have , for the time being, left the sections (Technical architecture, Web
API, Apps, and the appendix on R) in the main manual, but I think
(depending on feedback from the community) that we can slice these out of
the main user manual, and put them in a dedicated developer document.

Thoughts?

Regards,
Jason


_______________________________________________
Mailing list: https://launchpad.net/~dhis2-devs
Post to     : dhis2-devs@xxxxxxxxxxxxxxxxxxx
Unsubscribe : https://launchpad.net/~dhis2-devs
More help   : https://help.launchpad.net/ListHelp

Follow ups

References