← Back to team overview

dhis2-devs team mailing list archive

Re: DHIS2 Documentation for Metadata Sync and Versioning

 

Hi

We have forked dhis2-docs repo to get started with the documentation for
the new features. However when we try to build the just cloned repo with
apache maven as mentioned in
http://dhis2.github.io/dhis2-docs/2.22/en/implementer/html/apas09.html

we are getting below error
----------
[ERROR] Failed to execute goal
com.agilejava.docbkx:docbkx-maven-plugin:2.0.17:generate-html
(chunked-html-docs-implementer) on project dhis-documentation-docbook:
Failed to transform dhis2_implementation_guide_en.xml.
org.xml.sax.SAXParseException; systemId:
file:///Users/aamerm/Documents/oca/dhis2docs/dhis2-docs/src/docbkx/en/dhis2_implementation_guide_en.xml;
lineNumber: 35; columnNumber: 68; An 'include' failed, and no 'fallback'
element was found. -> [Help 1]
---------------

Are there any other steps apart from the ones mentioned in readme. Please
suggest.

Thanks
Aamer.

<http://dhis2.github.io/dhis2-docs/2.22/en/implementer/html/apas09.html>

On Tue, Jun 7, 2016 at 10:48 AM, Vanya Seth <vanyas@xxxxxxxxxxxxxxxx> wrote:

> Thanks for the information Lars.
>
> Regards
> Vanya
>
> On Tue, Jun 7, 2016 at 7:26 AM, Lars Helge Øverland <lars@xxxxxxxxx>
> wrote:
>
>> 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/>
>>
>>
>
>
> --
> With Regards
> ThoughtWorks Technologies
> Hyderabad
>
> --Stay Hungry Stay Foolish!!
>

Follow ups

References