search

vyperlang / vyper

Pythonic Smart Contract Language for the EVM
https://vyperlang.org
Other
4.84k stars 789 forks source link

VIP: Add multi-language support to documentation #811

Open hskang9 opened 6 years ago

hskang9 commented 6 years ago

What's your issue about?

Current documentation is only on English, and I want to add multi-language support feature. Also, I want to build user group in South Korea as well.

How can it be fixed?

Use gettext for translated documentation. This is good for long-term maintenance.

here are the reasons thanks to Markus Zapke-Gründemann with the conference video on youtube:

Writing multi-language documentation using Sphinx - Markus Zapke-Gründemann

  1. Untranslated strings are displayed in the source language

  2. Markup is not duplicated(e.g two markup files index.rst, index-ko.rst have to exist in case of metalsmith multi-language support, and if index.rst changes, index-ko.rst also have to change.)

  3. Professional localization tool can be used(e.g. transifex)

  4. Contributions possible without using a version control system(VCS)(e.g. github, gitlab)

Cute Animal Picture

image

jacqueswww commented 6 years ago

Good idea!

ben-kaufman commented 6 years ago

I think it's a great idea but I think we should mark it as a post-beta issue. Currently, the documentation still needs lots of changes so translating now will be inefficient. What do you think?

@jacqueswww if you agree please mark as post-beta.

fubuloubu commented 6 years ago

Great point, it needs to be better before translation

hskang9 commented 6 years ago

@ben-kaufman I am not saying that we are translating the documentation now. I am saying that we need to build infrastructure(multi-language support) so that other developers can participate translating in their own language later. In this case, I want to apply gettext for it.