Readme: Add section about how translations work

[tordans]

Closes #55

I had to search around for this – again – just now for bryceco/GoMap#562. I think this should be clarified right in the Readme.

[1ec5]

Pinging @bhousel @quincylvania for review; they appear to be the only folks who have permission to administer this translation pipeline end-to-end from this repository through NPM to Transifex.

[tordans]

Looking into this with the Feedback of Minh in #245 (comment), there are two more thinks I think we should look at

• The docs read as if anyone can translate. It that true? Just double checking if this is correct.
• How does the review process work? There was a GitHub issue a few weeks ago where someone requested access (cannot find it anymore). Should we explain this here in it's own section?
• As a follow up, we should also update https://github.com/openstreetmap/iD/blob/develop/CONTRIBUTING.md#translating with sub headlines and link to this new section for the part about presets.
• Are other information from https://github.com/openstreetmap/iD/blob/develop/CONTRIBUTING.md#translating relevant and should be added here? Like the {variable}-part?

[1ec5]

The docs read as if anyone can translate. It that true? Just double checking if this is correct.

Transifex has a button to ask to join the translation team for a given locale. In the past, the administrators of this Transifex project would approve requests routinely, only rejecting requests for overly specific locales.

How does the review process work?

Do you mean the review process for translations? Transifex does have a separate Reviewer role in order to mark translations as reviewed. This Transifex feature is generally only used for projects that rely on freelancers or contractors to provide initial translations. However, for Vietnamese, iD only pulls in reviewed translations: several years ago, someone used the Vietnamese locale as a dumping ground for their machine translation project, so this extra level of review prevented the machine translation from going live automatically.

Are other information from https://github.com/openstreetmap/iD/blob/develop/CONTRIBUTING.md#translating relevant and should be added here? Like the {variable}-part?

Nothing in interim/source_strings.yaml currently uses this placeholder syntax. There is the <…> syntax used for terms strings; Transifex renders each of those placeholder as a token with a tooltip when you hover over it.

[mbrzakovic]

Just seeing this is a duplicate of: #200. I think the additional info added here will be useful as well. When you find the time, please do make appropriate change.

[tordans]

@1ec5 thanks for those answers. I updated the PR. I left out a some of the parts you answered since – now that I know – I think they are not too relevant to be explained to everyone.

I added a bullet to answer the question "when will I see my translations in iD(…)".

Another review would be great.

@mbrzakovic Would it be possible to squash-merge this and remove the part from #200 as part of resolving conflicts (in the github web UI)? If not, I have to checkout and rebase once I find time … – I just rebased and squashed the changes.

[peternewman]

@mbrzakovic Would it be possible to squash-merge this and remove the part from #200 as part of resolving conflicts (in the github web UI)? If not, I have to checkout and rebase once I find time …

It's possible for the person doing the merge in GitHub to do the squash as part of the merge.

Or alternatively you can do it as part of a PR in your branch to do it all on the website.