Investigating translating documentation
nzakas opened this issue · comments
One thing that we've been missing in our documentation is translations. Other open source projects have managed to figure this out, and now that we have a budget, it's possible to get paid translations. In my mind, the key questions to get answered are:
- Which languages would we want translations for?
- How would we manage translations (storing and updating)?
- How would those translations be represented, searched, and used on the website?
I'm opening this issue to track progress on this investigation and gather feedback.
Asking some other open source projects about how the manage translations, these services have been recommended to me:
- Crowdin - GitHub decided to use them for Electron (details).
- Transifex - Recommended by another person.
- weblate - used by OpenSUSE.
Just leaving this here for so I don't this info. :)
For what it's worth, I'm writing release notes about new features in Japanese in https://qiita.com/mysticatea.
Relevant discussion (since some of these frameworks have built in support): eslint/archive-website#536
Example: Docusaurus
To be honest, my primary question is, are translations really needed at this point? Is there any evidence that shows that a lot of non-English speaking developers can't read English documentation and google translate is not sufficient?
Is there any evidence that shows that a lot of non-English speaking developers can't read English documentation
One evidence is, the share percentage of Vue.js and React is pretty different between the English region and non-English regions because Vue.js provides the official high-quality documentation in native languages.
google translate is not sufficient?
It's a great service.
If Google translate didn't exist, I couldn't be active in the OSS community.
So I had investigated Google Translate's Website Widget, but sadly, it has been retired: https://translate.google.com/about/website/
Hello @nzakas, I'm willing to do the translation into Tamil language. Could you please guide me with this?
@Archulan thanks for your interest. We're not yet ready to begin accepting translations. Please turn on notifications for this issue to stay up to date with our progress.
Hey @nzakas I'd really love to help translating this into Hindi language. Do let me know how to begin.
@swetankraj We really appreciate you wanting to help out! As @nzakas mentions above, we don't have a system for translations in place at the moment, but we'd love your help once we figure that out.
For posterity, here's a post detailing how someone solved this with Eleventy (the static site framework we use for our website).
@kaicataldo I'll take a look at that. Thank you!
I am looking forward to your translation!
I'm Japanese, so I can help you with Japanese translation. I will help you when the system is ready.
@shu-pf thanks for your interest! We are in the middle of doing a website redesign, and after we finish that, we will look at translations again.
I am working in a Japanese company where no one really reads English, so I can confirm translation in Japanese would be of a huge help.
As an aside, I find that https://www.deepl.com/translator is much better than Google Translate. (And for some reason it is very good at translating tech-related words!).
I am more than willing to help for the translation of documents, but not being a native Japanese I cannot guarantee a "native" quality 😜
Count on me when system is ready for spanish translation!
Thanks @luifermoron! I’m working on figuring this out. I should hopefully have more info soon.
Hi everyone! I’m excited to share that our new website is now setup to accept translations. The site is currently at https://new.eslint.org and is our “marketing site.”
The documentation site will be separate and I’ll follow up when it is ready for translation.
If you would be willing to help by translating the marketing site, here are the instructions:
https://github.com/eslint/new.eslint.org#translations
I just noticed that CrowdIn has a free option for open source projects. I’ll investigate that some more.
Just tested https://eslint.org/ and seems like we already support the following languages:
- English
- German
- Spanish
- French
- Hindi
- Japanese
- Portuguese
- Mandarin
The original points were:
- Which languages would we want translations for?
- How would we manage translations (storing and updating)?
- How would those translations be represented, searched, and used on the website?
Do we want to keep this issue open until:
- Find a translation management software?
- We add more languages?
By the way, here are a few more translation management software (TMS) solutions that seem to be free for open source software:
Yes, let's leave this open. I think we probably need to rethink our translation strategy for documentation as the one translation we've already done has been very manual and there is probably a streamlined process we can figure out with some time.