rxjs-docs icon indicating copy to clipboard operation
rxjs-docs copied to clipboard

Translation: tools, input organization

Open kwonoj opened this issue 8 years ago • 6 comments

I'm separating this topic out of https://github.com/ReactiveX/rxjs-docs/issues/29, cause this is most fundamental thing need to be set before actual work and most important thing for daily work as well.

#29 includes good initial ideas to discuss out

organizing source of traslated document

  • [ ] put under current repo
  • [ ] separate repo for each translation
  • [ ] convert current one into monorepo?

type of source we'll use

  • this depends on what tools we'll use

translation pipeline management tools

  • [ ] crowdin (https://crowdin.com/)
  • [ ] smartling (https://www.smartling.com/) free edition
  • [ ] weblate (https://weblate.org/)
  • [ ] pontoon (https://pontoon.mozilla.org/)
  • [ ] gitlocalize (https://gitlocalize.com/)
  • [ ] transifex (https://www.transifex.com/)
  • [ ] just manually do everything

contributor process

  • also depends on what tools we'll use Main q: should we encourage any contributor works with githunb's PR flow / or better to make it happen even without knowning git / PR process?

kwonoj avatar Oct 11 '17 21:10 kwonoj

/cc @ladyleet

kwonoj avatar Oct 11 '17 21:10 kwonoj

My point of interests are

  • translation contributor need not know about things like cli, git, pr, etcs.
  • translation material though, should be manageable via github repo.
  • translation resources management should be easily doable (diff, tracking version, etcs) to orignal raw (English) material.
  • some sort of programmatic interface allows auto publish / deploy documents.
  • few other things I haven't thought of

kwonoj avatar Oct 11 '17 21:10 kwonoj

I can confirm that the Yarn team is using crowdin (http://i18n.yarnpkg.com/project/yarn). I've helped them in the past. The tool seemed to be easy to use. So I do agree to use such tools for "globalization" (g11n) instead of using git. PRs could be such mess when it comes to reviewing g11n content.

manekinekko avatar Oct 18 '17 20:10 manekinekko

Here are my thoughts on this

  1. has to be easy to contribute
  2. has to be easy to access like the vue translations on the docs.
  3. has to be easy to maintain.
  4. has to be able to be released incrementally (like, if there are no translations it does something or says "not avail yet" or something). because i want to be able to release translated docs immediately.
  5. maybe we can have a bar at the top of each translated and be like, this is X% translated - contribute now.
  6. we just need a proposed solution and path going forward that meets these requirements and any others from the core team and then let's just run with it.

ladyleet avatar Oct 27 '17 23:10 ladyleet

Another tool we can use: http://www.ngx-translate.com

Here is the demo of how it works/looks https://embed.plnkr.co/pYo6bFPRRxVPgRR8toDt/

We've successfully used it for several projects in Valor

omfgnuts avatar Oct 30 '17 10:10 omfgnuts

In case anyone interested, here's the PR for ngx-translate, i'll write a short instruction on how to use translations tomorrow :) https://github.com/ReactiveX/rxjs-docs/pull/144 And here is ngx-translate enabled fork https://github.com/musienkoyuriy/rxjs-docs/ feat-i18n-integration tree @ladyleet

omfgnuts avatar Nov 09 '17 18:11 omfgnuts