← Back to team overview

dhis2-devs team mailing list archive

Re: DHIS2 Documentation for Metadata Sync and Versioning

 

Hi Vanya,

thanks for taking the time to document this.

Just some suggestions for your question on where to put what:


> As we understand that there are 3 manuals
>
> - Developer guide
> - User guide
> - Implementor guide
>
> When we do the documentation are we targeting all these guides?
>
> Some key aspects that we believe are documentation worthy are:
>
> - The new API 's (versioning and sync).
>

Developer guide (API docs)


> - The new task (Metadata sync task)
> - Metadata Versioning and Metadata Sync as a concept.
> - Best practices around the Metadata versioning setup.
>
- Optimization of the initial setup of new field instances given the
> central-field deployment strategy
>

I suggest a new chapter in the user manual called "Metadata
synchronization" for these.

http://dhis2.github.io/dhis2-docs/master/en/user/html/dhis2_user_manual_en.html


> - The changes to the existing "Settings" app [which is pretty much part of
> setting up the Synchronization settings and the ability to create new
> versions by enabling versioning ]
>

Add to settings chapter in user guide:

http://dhis2.github.io/dhis2-docs/master/en/user/html/ch23.html


> - The changes to the "Data Administration" app where we can now also
> schedule the metadata sync at the time of choice.
>
> Add to data administration chapter in user guide:

http://dhis2.github.io/dhis2-docs/master/en/user/html/ch22.html




> It would be good if you could help us get started.
>
>
regards,

Lars


> --
> With Regards
> Vanya
> ThoughtWorks Technologies
> Hyderabad
>
> --Stay Hungry Stay Foolish!!
>



-- 
Lars Helge Øverland
Lead developer, DHIS 2
University of Oslo
Skype: larshelgeoverland
lars@xxxxxxxxx
http://www.dhis2.org <https://www.dhis2.org/>

Follow ups

References