-
Notifications
You must be signed in to change notification settings - Fork 15.1k
Description
This is a Feature Request
Support of Translation & Localization Management Platform (TLMP) for docs
To effectively make and maintain translations, we need to adopt tools that were created for it.
There a bunch of solutions, like Transifex, Crowdin, and others.
After a quick research at the start of 2023, we chose Transifex for PoC as a free and reliable solution, but in the end, it's no matter what tool sig-docs chooses, it will be much better than the workflow that we have now via git&Github.
What would you like to be added
There are 3 ways, from better to worse:
- Full integration. Integrate any TLMP with
k/websites
and move localization work fully to the chosen TLMP, including docs reviews and CLA sign. Add TLMP Github integration and auto-merge changes sent by TLMP integration user (provided by TLMP or you can setup your own) - Particial integration. Translate and review in TLMP, but users still need to sign CLA in Github
- Fix the EasyCLA co-author issue, mentioned in Linux Foundation issue, test PR
- Create a script that will be take by API's last editors of each line for the changed file and add them as co-authors in git
- Auto-merge such changes if EasyCLA check passes, (review already done in TLMP)
- No integration. Same as p.2, but 2.3. replaced with:
3. Manually approve and merge such PRs in Github, if EasyCLA check passes.
Why is this needed
When you write docs or code in 1 language, you work only with the current state of docs - everything that you need to track is tracked by git.
When you translate something - you deal with 2 sources of truth: original and existent translation, which can be partial, outdated or placed in locations that have already been moved/removed from the original. + other edge cases. There is no easy way in git to check what changes in the original also should be revisited in translation, so mostly every translated doc became unsupported from the moment when it was merged - as sometimes simpler to redo a translation from scratch than to figure out what changes are needed.
Long story short: git is just the wrong tool for translations. It is as bad for this as using .zips for VCS or trying to send a letter by pigeon mail to another continent and hoping for 3 workday answer.
Also, tech-writers, students, or newbies which'd like to contribute, in most cases have no or little knowledge how git and GitHub works, they don't have a GitHub account, and so on. Those are just not intuitive tools for non-techie folks.
So, what good enough TLMP will provide:
- Tracking changes in the original and asking for new translations for these changes
- Provide suggested translation by Google Translate/DeepL/etc by 1 click, which should be reviewed at least twice: by a user who added that auto-translation and by the reviewer(s)
- Have built-in CLA support
- Have a Github integration
- Have an easy to understanding for translators interface
- Provide easy-to-find
not translated
, andnot reviewed
strings/files - Able to provide/keep a few translation suggestions for a single string for the reviewer choose
- Easy to signup and sign CLA from the start mechanism
- Conform with all LF and CNCF regulations (or change those regulations to conform with TLMP)
- ... ?
Comments
@sftim
asked to add it as an issue here, to be able to track work on it.
Related Linux Foundation issue
P.S. That started as a Ukrainian localization team initiative, but we were blocked from the legal perspective of merging back that kind of change from TLMP.