dhis2-documenters team mailing list archive

[Philip Larsen Donnelly <phil@xxxxxxxxx>]

Thanks for your understanding! :)

The organisation I'm thinking of is a bit closer to
- content/users/en/...
- content/users/fr/...

In particular, two things I'm trying to achieve are:
1. Resources are linked directly from .md file. The current rule is to have
then in a subdirectory of the file's path. Doing a "../" at the start of
the relative links would probably be acceptable.
2. Resources should be shared between locales, without having to create
symlinks to honour point 1. (Hence the need for "../" above).



On Fri, 7 Dec 2018 at 17:09, Martin Van Aken <martin@xxxxxxxxxxxxxxxx>
wrote:

> Hi Philip,
> No worries about the delays, I know what release times are -
> congratulations getting the 2.31 out!
>
> What you propose is perfect for me - at least I've a way to start the
> work, and we can discuss/improve the production pipeline about the way.
> For the file organisation, instead of postfixing the file name, we could
> create a parralel folder structure like:
>
> - content/en/users/...
> - content/fr/users/...
>
> WDYT? - this looks easier for me to make work with build tools as it would
> be easy to pass a locale to them.
>
> Let me know when the 2.29 branch is ready, I'll get the translation under
> way.
>
> Thanks a lot!
>
>
> Martin
>
> On Fri, Dec 7, 2018 at 3:39 PM Philip Larsen Donnelly <phil@xxxxxxxxx>
> wrote:
>
>> Hi again Martin,
>>
>> I started to try out a re-organisation of the repository to better
>> support translations, but I'm afraid I then got side-tracked with our
>> latest release.
>>
>> I think the easiest way for you to start would be simply to make of copy
>> (clone) of the markdown docs repository and branch off of the 2.29 branch,
>> then replace each chapter as you work on it by adding a _FR suffix, for
>> example, in both the index file and the actual referenced file (of course).
>> So, if you started with, say, "using-the-data-entry-app.md", then your
>> dhis2_end_user_manual_INDEX_FR.md file should look like:
>>
>> <!--DHIS2-SECTION-ID:index-->
>>
>> !INCLUDE "content/common/about-this-guide.md"
>> !INCLUDE "content/user/about-demo-server-live-package-and-database-design.md"!INCLUDE "content/user/using-the-data-entry-app_FR.md"
>> !INCLUDE "content/user/control-data-quality.md"
>> !INCLUDE "content/user/using-reporting-functionality.md"
>> !INCLUDE "content/user/analyze-data-in-pivot-tables.md"
>> !INCLUDE "content/user/data-visualizer.md"
>> !INCLUDE "content/user/using-the-data-visualizer-app.md"
>> !INCLUDE "content/user/using-the-gis-app.md"
>> !INCLUDE "content/user/using-the-maps-app.md"
>> !INCLUDE "content/user/managing-dashboards.md"
>> !INCLUDE "content/user/messaging.md"
>> !INCLUDE "content/user/set-user-account-preferences.md"
>>
>> Then you can work on the content/user/using-the-data-entry-app_FR.md
>> file, and so on. You can of course change them all at once, but I think you
>> get the point!
>>
>> That will at least give us something that works, and shares the
>> resources. The new index file will have to be added to the build script to
>> actually build it! - but there are many good markdown editors/previewers,
>> so you don't need to build the full documents yourself immediately to see
>> the results.
>>
>> I will try to finalise the new structure, and at some point we can merge
>> in your files and I can map them to the new structure, and you can continue
>> with that?
>>
>> Do you think that would be OK?
>>
>> What sort of timescales are you looking at for starting/completing?
>>
>> Just one note on the 2.29 docs! - someone recently pointed out a problem
>> with several missing chapters in the 2.29 branch. I temporarily put our
>> previous documentation back in place for that release. *I'll try to fix
>> that problem by early next week, then you will have a safe point to branch
>> from!*
>>
>> Kind regards,
>> Phil
>>
>> *Philip Larsen Donnelly*
>> QA and Release Manager
>> DHIS2
>> Department of Informatics
>> University of Oslo
>>
>>
>> Den fre. 7. des. 2018 kl. 13:53 skrev Martin Van Aken <
>> martin@xxxxxxxxxxxxxxxx>:
>>
>>>  Hi Jason & Philip,
>>> Pushing this up again - to explain my interest, we are on the verge to
>>> pay for a FR translation of the user doc (2.29). I have two options:
>>> - Do that on a word/PDF and share with my customer
>>> - Do it on the proper source and contribute it back
>>>
>>> The first option is easier, but would look as a missed opportunity. If
>>> you have a way to procude the .md on a 2.29 branch that would be super
>>> helpful - for us, but also we think for the community.
>>>
>>> Let me know what you think,
>>>
>>> Martin
>>>
>>> On Mon, Oct 29, 2018 at 12:27 PM Philip Anthony Larsen Donnelly <
>>> phil@xxxxxxxxx> wrote:
>>>
>>>> Hi Martin,
>>>>
>>>> In answer to your questions:
>>>> 1) Not yet. We have converted only the master branch initially. Future
>>>> versions will of course be branches, but we were considering whether or not
>>>> we spend effort converting older released versions. The ability to take
>>>> translation input for previous releases is a good argument for doing so.
>>>> I'll look into the effort of getting a 2.29 en version in markdown. It
>>>> shouldn't be too difficult.
>>>> 2) The build script is a little bit "hacked" together right now. We
>>>> could tweak it to include e.g. French fairly easily. We need to think about
>>>> the best way to share resources. (We may change to use a more robust build
>>>> tool in the future)
>>>>
>>>> If you let me know your thoughts on schedule, I can work with you to
>>>> see what we can do to coordinate the effort.
>>>>
>>>> Thanks and kind regards,
>>>> Phil
>>>>
>>>> *Philip Larsen Donnelly*
>>>> QA and Release Manager
>>>> DHIS2
>>>> Department of Informatics
>>>> University of Oslo
>>>>
>>>>
>>>> On Mon, 29 Oct 2018 at 11:59, Martin Van Aken <martin@xxxxxxxxxxxxxxxx>
>>>> wrote:
>>>>
>>>>> Hi Jason,
>>>>> Thanks for the update.
>>>>>
>>>>> I'm starting on someting small (2.29, end user manual only), but if
>>>>> this can be made to work on your main repo & pipeline, I see a lot of value
>>>>> (for other french speaking customers).
>>>>> Migration is not a big problem for us.
>>>>>
>>>>> Q1: Is that repository versionned? Having a branch per version (as in
>>>>> the other repo) looks like a good idea to me.
>>>>> Q2: The build process looks to be "hardcoded" for "en" too, if I want
>>>>> to update, any clue on how to make the build script "language
>>>>> independement" (or to include french) ?
>>>>>
>>>>> Martin
>>>>>
>>>>> On Mon, Oct 29, 2018 at 10:58 AM Jason Pickering <
>>>>> jason.p.pickering@xxxxxxxxx> wrote:
>>>>>
>>>>>> Hi Martin,
>>>>>>
>>>>>> We have migrated the documentation from DocBook format to Markdown
>>>>>> format. The new docs are available here
>>>>>> <https://github.com/dhis2/dhis2-markdown-docs>.
>>>>>>
>>>>>> The old documentation had been partially translated to French and is
>>>>>> still available here <https://github.com/dhis2/dhis2-docs-fr>.
>>>>>> However, it was more or less abandoned and has not been updated in quite
>>>>>> some time.
>>>>>>
>>>>>> So, as for next steps, I am not really sure how you would like to
>>>>>> proceed. We could potentially try and migrate the old French docs to the
>>>>>> new Markdown format (which we did for the English docs), but I don't know
>>>>>> if its worth it at this point. Perhaps a fresh start with the current
>>>>>> documentation framework would be better? Let me know what you think  and we
>>>>>> can try and help out.
>>>>>>
>>>>>> Best regards,
>>>>>> Jason
>>>>>>
>>>>>> On Mon, Oct 29, 2018 at 4:20 AM Martin Van Aken <
>>>>>> martin@xxxxxxxxxxxxxxxx> wrote:
>>>>>>
>>>>>>> Hi!
>>>>>>> For a customer, we'll translate a part of the DHIS2 documentation in
>>>>>>> French (for now the End User Manual of the 2.29). We would like to
>>>>>>> contribute this back so I'm using the XML pipeline of DHIS2 for this.
>>>>>>>
>>>>>>> My problem is that the current pom.xml looks hardcoded toward the
>>>>>>> "en" language, and while the source has folders per language, I don't see
>>>>>>> anything like that on the target folder.
>>>>>>>
>>>>>>> I could make a copy of the pom.xml and make a "pom-fr.xml" but that
>>>>>>> does not look a good idea to me.
>>>>>>>
>>>>>>> Any suggestions?
>>>>>>>
>>>>>>> Martin
>>>>>>>
>>>>>>> --
>>>>>>> *Martin Van Aken - **Freelance Enthusiast Developer*
>>>>>>>
>>>>>>> Mobile : +32 486 899 652
>>>>>>>
>>>>>>> Follow me on Twitter : @martinvanaken
>>>>>>> <http://twitter.com/martinvanaken>
>>>>>>> Call me on Skype : vanakenm
>>>>>>> Hang out with me : martin@xxxxxxxxxxxxxxxx
>>>>>>> Contact me on LinkedIn : http://www.linkedin.com/in/martinvanaken
>>>>>>> Company website : www.joyouscoding.com
>>>>>>> _______________________________________________
>>>>>>> Mailing list: https://launchpad.net/~dhis2-documenters
>>>>>>> Post to     : dhis2-documenters@xxxxxxxxxxxxxxxxxxx
>>>>>>> Unsubscribe : https://launchpad.net/~dhis2-documenters
>>>>>>> More help   : https://help.launchpad.net/ListHelp
>>>>>>>
>>>>>>
>>>>>>
>>>>>> --
>>>>>> Jason P. Pickering
>>>>>> email: jason.p.pickering@xxxxxxxxx
>>>>>> tel:+46764147049
>>>>>>
>>>>>
>>>>>
>>>>> --
>>>>> *Martin Van Aken - **Freelance Enthusiast Developer*
>>>>>
>>>>> Mobile : +32 486 899 652
>>>>>
>>>>> Follow me on Twitter : @martinvanaken
>>>>> <http://twitter.com/martinvanaken>
>>>>> Call me on Skype : vanakenm
>>>>> Hang out with me : martin@xxxxxxxxxxxxxxxx
>>>>> Contact me on LinkedIn : http://www.linkedin.com/in/martinvanaken
>>>>> Company website : www.joyouscoding.com
>>>>>
>>>>
>>>
>>> --
>>> *Martin Van Aken - **Freelance Enthusiast Developer*
>>>
>>> Mobile : +32 486 899 652
>>>
>>> Follow me on Twitter : @martinvanaken <http://twitter.com/martinvanaken>
>>> Call me on Skype : vanakenm
>>> Hang out with me : martin@xxxxxxxxxxxxxxxx
>>> Contact me on LinkedIn : http://www.linkedin.com/in/martinvanaken
>>> Company website : www.joyouscoding.com
>>>
>>
>
> --
> *Martin Van Aken - **Freelance Enthusiast Developer*
>
> Mobile : +32 486 899 652
>
> Follow me on Twitter : @martinvanaken <http://twitter.com/martinvanaken>
> Call me on Skype : vanakenm
> Hang out with me : martin@xxxxxxxxxxxxxxxx
> Contact me on LinkedIn : http://www.linkedin.com/in/martinvanaken
> Company website : www.joyouscoding.com
>
-- 
*Philip Larsen Donnelly*
QA and Release Manager
DHIS2
Department of Informatics
University of Oslo