[Learnosm-coord] Fwd: translation workflow for LearnOSM

Tue Nov 25 07:22:47 UTC 2014

Hi guys,

My two cents:

- I like the idea of a header at the start of yet-to-be-translated files.
We'll need a standard header text in each of the languages.  This is far
better than the way things are otherwise - if someone goes to a page in
English and then clicks on another language link, learnOSM will return a
404 error if that page doesn't exist.  Better to have some assurance that
the translation is underway.  I think that this approach should be applied
also for translations that need updating.  For example, Walking Papers has
been changed to Field Papers with some extensive modifications, but all the
translations have not caught up.  So a little text at the top saying, "this
is not up to date.  visit the English version for the latest version.  or
help us translate..." would be good.

- Is anyone else able to / already doing running Jekyll locally?  I'm happy
to hand over P.R. privileges to someone who can focus more on it, but it
should be someone who knows how learnOSM is setup and can make sure things
don't break.  It's usually wise to check pull requests locally before
merging into the main branch.

- Agreed to do issues list on github

Best,
Jeff

On Mon, Nov 24, 2014 at 2:00 PM, Nick Allen <nick.allen.54 at gmail.com> wrote:

>  Claire,
>
> I'm well, hope you are to.
>
> Sorry, I hadn't realised the reply from Jeff was 'off list'. I've now
> circulated it.
>
> I'm one of the team delivering a mapathon this evening in London & will be
> running round this afternoon getting ready to travel there. May not be
> present for much of the meeting, so am adding my thoughts to the hackpad &
> this email.
>
> I've pasted my proposal into the hackpad - took me longer to format it
> there than it did on the original!
>
> If the working group is happy with the workflow, I am happy to be one of
> the git-hubbers who manages the system. Things I think we need to decide
> about;
> 1. Who else will help to manage it,
> 2. Do we run the system using the issues list on git-hub - makes it easy
> to see who is doing what, but may end up with a lot of issues on the list,
> especially if an original document is updated while a translation is taking
> place. I think it is still my preferred option even though it may be
> difficult. We can always try it, and then amend if we need to.
> 3. When a translation starts, if we use a 'draft' filename then it remains
> invisible until the file is renamed. Personally I think give it the full
> file name right from the start, but put an opening line in it explaining
> that it is a document in the process of being translated. At least that way
> some of the information is available as soon as Jeff (who else is there who
> can merge the pull requests?) or whoever, agrees the pull request.
> 4.  Although my initial message said to create a section in LearnOSM, this
> simply needs to be an amendment to
> https://github.com/hotosm/learnosm/blob/gh-pages/CONTRIBUTING.md & could
> be carried out using the method proposed for the translation workflow
> itself.
> 5. Once we've agreed these & done stage 4, we just need a volunteer or two
> for translating. I don't know if anything came of Blakes messages, or
> https://lists.openstreetmap.org/pipermail/learnosm-coord/2014-October/000031.html
> or if we need to do a message on the general OSM mailing list - there may
> have been some in there - can't remember!
>
> Probably easier if I link this message off the coordination mailing list
> rather than paste it all into hackpad again!
>
> Nick
>
>
>  On 24/11/14 08:23, Claire Halleux wrote:
>
> Hello Nick,
> Hope you are doing good !
> Any news from Jeff on your side?
>  Today is supposed to be Training WG meeting day.
>  Agenda for today is still kind of empty. Please let me know or add
> directly on the hackpad any item you would have:
> https://hackpad.com/Training-WG-Meeting-November-24-2014-u6VFosnUuyb
> Thanks!
>
>  Claire
>
>   Claire Halleux
>  Volunteer and Member of the Board
> +243 99 256 9980 (Kinshasa, DRC)
>  Humanitarian OpenStreetMap Team
>
>  http://www.hotosm.org/
> http://wiki.openstreetmap.org/wiki/2014_DRC_Ebola_Response
>
> On Thu, Nov 20, 2014 at 8:21 PM, Nick Allen <nick.allen.54 at gmail.com>
> wrote:
>
>>  Jeff,
>>
>> I guess this got lost in the ether first time round - is this worth
>> investigating?
>>
>> Nick
>>
>>
>> -------- Forwarded Message --------  Subject: translation workflow for
>> LearnOSM  Date: Wed, 12 Nov 2014 01:33:12 +0000  From: Nick Allen
>> <nick.allen.54 at gmail.com> <nick.allen.54 at gmail.com>  To: Jeff Haack
>> <jeff.haack at gmail.com> <jeff.haack at gmail.com>
>>
>> Jeff,
>>
>> The recent updates to LearnOSM have highlighted that there may be a
>> simpler way to carry out the translation process. This document
>> https://help.github.com/articles/editing-files-in-another-user-s-repository/
>> outlines a very simple method of editing an existing document & submitting
>> a pull request. I don't think this was available when the original process
>> was designed.
>>
>> I wondered, could we use a workflow such as;
>>
>> 1. When a volunteer translator makes contact agree a section/chapter for
>> translation,
>> 2. Ensure the chapter of LearnOSM is up to date (probably from English).
>> 3. Create a copy of the original document in the new language folder,
>> renaming it *draft........* (Do we need it as draft?)
>> 4. Translator gets a github account & is directed to the file for
>> translation - *draft.......*
>> 5. Translator replaces the original text in the document with new
>> language pull requests as they go - as per above document.
>> 6. Translator can view a rough Jekyll view of their document by clicking
>> on it in the repository - for instance this
>> https://github.com/Nick-Tallguy/learnosm/blob/gh-pages/_posts/en/coordination/0500-10-23-tasking-manager.md
>> appears quite well on the site & saves the translator having to install
>> jekyll or using any other software programme.
>> 7. While translator is carrying out steps 4, 5 & 6,  git-hubber obtains
>> screenshots in correct language & puts them in appropriate folder, updating
>> the links in the document that translator is working on.
>>
>> Variations to consider
>>
>>    - Whether to do this off the original hotosm/learnosm repository or
>>    the repository of the git-hubber who is assisting.
>>    - Don't give the file the translator is working from a draft.....
>>    name. Instead have it as a live document, and the first line of text of it
>>    reads 'This document is in the process of translation, and should be used
>>    with caution until the process is complete' - has the advantage that some
>>    of the information is available earlier & the translator can see their
>>    progress more easily.
>>    - Do we need the translator to use 'markdown' - the formatting could
>>    be carried out by the git-hubber
>>
>>
>> If you agree there is any merit in this system, I would be willing to
>> create a section in LearnOSM with pretty pictures etc outlining the
>> process, and we could then try it out with a translator - alternative is a
>> translator works from a guidance document similar to this email as an
>> initial trial.
>>
>> The issues list in git-hub could be used to show ongoing progress, such
>> as 'Tasking manager section translation to French ongoing with Tallguy-Nick
>> & Pierre.....' - that way anyone else can see progress.
>>
>> We'd need some kind of spreadsheet or database to show overall progress -
>> would need a system capable of dealing with amendments to the original
>> document leading to amendments required to the translated document. I
>> suspect you already have some kind of system for keeping track of things.
>>
>> I'm willing to help with the process as much as I can - lots of help some
>> weeks, and no help at all others. I expect you have the same problems. I
>> think there are others in the HOT Training working group who would also be
>> willing to help, but not sure of their progress in learning about the
>> git-hub system, certainly CloCKWerx has been very helpful & might continue
>> if we speak nicely to him.
>>
>> Your thoughts appreciated.
>> --
>>
>> Nick
>>
>> Volunteer 'Tallguy' for
>> https://wiki.openstreetmap.org/wiki/Humanitarian_OSM_Team
>>
>> http://www.openstreetmap.org/user/Tallguy
>>
>> Treasurer, website & Bonus Ball admin for
>> http://www.6thswanleyscouts.org.uk/ (treasurer at 6thswanleyscouts.org.uk)
>>
>>
>>
>> _______________________________________________
>> Learnosm-coord mailing list
>> Learnosm-coord at openstreetmap.org
>> https://lists.openstreetmap.org/listinfo/learnosm-coord
>>
>>
>
>
> --
>
> Nick
>
> Volunteer 'Tallguy' for
> https://wiki.openstreetmap.org/wiki/Humanitarian_OSM_Team
>
> http://www.openstreetmap.org/user/Tallguy
>
> Treasurer, website & Bonus Ball admin for
> http://www.6thswanleyscouts.org.uk/ (treasurer at 6thswanleyscouts.org.uk)
>
> _______________________________________________
> Learnosm-coord mailing list
> Learnosm-coord at openstreetmap.org
> https://lists.openstreetmap.org/listinfo/learnosm-coord
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstreetmap.org/pipermail/learnosm-coord/attachments/20141125/aad343ce/attachment.html>