Hi Jark It would be a great idea to contribute the Flink Chinese community website, which is quite popular among Chinese developers, back to Apache Flink. I think it could attract more Chinese users and developers.
Alluxio, a distributed storage system, also maintain an official Chinese version document under their open source repo (https://github.com/Alluxio/alluxio/tree/master/docs/cn) from 2016. However, it would be a bit tricky to review Chinese documentation related PR since not every one could read/write Chinese, not to mention some state-of-the-art English computer science vocabularies still have no well-accepted Chinese translations. In a nutshell, I think an official Chinese document is really a good idea, but we need to drive this more carefully. [https://avatars1.githubusercontent.com/u/16203694?s=400&v=4]<https://github.com/Alluxio/alluxio/tree/master/docs/cn> alluxio/docs/cn at master · Alluxio/alluxio · GitHub<https://github.com/Alluxio/alluxio/tree/master/docs/cn> You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. github.com Best Yun Tang ________________________________ From: Fabian Hueske <fhue...@gmail.com> Sent: Monday, January 28, 2019 21:48 To: dev Subject: Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink Hi Jark, Thank you for starting this discussion! I'm very happy about the various efforts to support the Chinese Flink community. Offering a translated website and documentation gives Flink a lot more reach and will help many users. I think integrating the website and documentation as subdirectories into the existing website and docs is a very good approach. Regarding the name, does it make sense to keep the URLs in sync with the newly created mailing list (user...@flink.apache.org), i.e., https://flink.apache.org/zh/ <https://flink.apache.org/cn/> etc? I think integrating the translated website/documentation into Apache Flink's repositories might also help to grow the number of Chinese non-code contributors. Translating resources is IMO a great way to contribute without writing source code. I'm very much looking forward to this. Best, Fabian Am Mo., 28. Jan. 2019 um 12:59 Uhr schrieb Jark Wu <imj...@gmail.com>: > Hi all, > > In the past year, the Chinese community is working on building a Chinese > translated Flink website (http://flink.apache.org) and documents ( > http://ci.apache.org/projects/flink/flink-docs-master/) in order to help > Chinese speaking users. This is http://flink-china.org and it has received > a lot of praise since online. > > In order to follow the Apache Way and grow Apache Flink community, we want > to contribute it to Apache Flink. It contains two parts to contribute: > (1) the Chinese translated version of the Flink website > (2) the Chinese translated version of the Flink documentation. > > But there are some questions are up to discuss: > > ## The Address of the translated version > > I think we can add a Chinese channel on official flink website, such as " > https://flink.apache.org/cn/";, which is similar as " > http://kylin.apache.org/cn/";. And use " > https://ci.apache.org/projects/flink/flink-docs-zh-master/"; to put the > Chinese translated docs. > > ## Add a link to the translated version > > It would be great if we can add links to each other in both Chinese version > and English version. For example, we can add a link to the translated > website on the sidebar of the Flink website. We can also add a dropdown > button for the Chinese document version under the "Pick Docs Version" in > Flink document. > > ## How to contribute the translation in a long term > > This is a more important problem. Because translation is a huge and > long-term work. We need a healthy mechanism to ensure the sustainability of > contributions and the quality of translations. > > I would suggest to put the Chinese version document in flink repo (such as > "doc-zh" folder) and update with the master. Once we modify the English > doc, we have to update the Chinese doc together, or create a JIRA (contains > git commit id refer to the English modification) to do that. This will > increase some workload when we update the doc. But this will keep the > Chinese doc up to date. We can attract more Chinese contributors to help > build the doc. And the modification is small enough and easy to review. > > Maybe there is a better solution and we can also learn how the other > projects do it. > > Any feedbacks are welcome! > > Best, > Jark Wu >
