+1. Thanks for the proposal @Jark. I think utilizing review-bot will definitely be a good plus. I remember @Robert mentioned that there was an auto checklist functionality, maybe we can utilize that to flag/tag a specific PR is ready for documentation parity review?
I would also like to follow up on a good question @Yun Tang brought up: sometimes an accurate translation from state-of-the-art English terminology is not available yet in Chinese. I was wondering what would be the best practices for reviewers or committers: creating a follow up JIRA is definitely one good solution but in the long run the differences might pile up. Looking forward to contributing to this effort! Thanks, Rong On Tue, Feb 5, 2019 at 4:10 AM Jark Wu <imj...@gmail.com> wrote: > Hi all, > > Thanks for the positive feedback we received so far. > > I have created two umbrella JIRA for tracking the efforts: > > For flink-web: https://issues.apache.org/jira/browse/FLINK-11526 > For flink-docs: https://issues.apache.org/jira/browse/FLINK-11529 > > I'm working on the framework changes for flink-web first. > > Please feel free to further join the contribution and translation. > > Best, > Jark > > On Tue, 5 Feb 2019 at 18:27, Stephan Ewen <se...@apache.org> wrote: > > > Nice proposal > > > > +1 > > > > On Tue, Feb 5, 2019 at 8:16 AM Hequn Cheng <chenghe...@gmail.com> wrote: > > > > > Hi, > > > > > > big +1 for this! > > > Thank you Jark for writing the great document. I totally agree with the > > > proposal. It not only keep the English document same as before but also > > > proposes a way to integrate with Chinese ones. > > > > > > Best, Hequn > > > > > > > > > > > > On Mon, Feb 4, 2019 at 6:18 PM Fabian Hueske <fhue...@gmail.com> > wrote: > > > > > > > Happy Chinese New Year! > > > > > > > > Thank you Jark for working on a prototype and writing up the this > great > > > > proposal. > > > > +1 for the suggested approach > > > > > > > > Best, > > > > Fabian > > > > > > > > Am Mo., 4. Feb. 2019 um 11:05 Uhr schrieb jincheng sun < > > > > sunjincheng...@gmail.com>: > > > > > > > > > +1 ， Happy Chinese New Year! :) > > > > > > > > > > Best，Jincheng > > > > > From Singapore > > > > > > > > > > Jark Wu <imj...@gmail.com>于2019年2月4日 周一13:23写道： > > > > > > > > > >> Hi all, > > > > >> > > > > >> I have drafted the proposal: > > > > >> > > > > >> > > > > > > > > > > https://docs.google.com/document/d/1R1-uDq-KawLB8afQYrczfcoQHjjIhq6tvUksxrfhBl0/edit# > > > > >> Please feel free to give any feedbacks! > > > > >> > > > > >> I have also created a prototype to integrate Chinese for > flink-web, > > > here > > > > >> is > > > > >> the branch: > > https://github.com/wuchong/flink-web/tree/multi-language > > > > >> > > > > >> @Fabian Hueske <fhue...@gmail.com> +1 to start contribute > > flink-web > > > > >> first. > > > > >> > > > > >> @Gordon That's a good idea to add the document checklist to the > > review > > > > >> process. I have included this in the proposal. What do you think > > > @Robert > > > > >> Metzger <rmetz...@apache.org> @Fabian Hueske <fhue...@gmail.com> > > ? > > > > >> > > > > >> Btw, Happy Chinese New Year! :) > > > > >> > > > > >> Cheers, Jark > > > > >> > > > > >> > > > > >> On Fri, 1 Feb 2019 at 18:22, Tzu-Li (Gordon) Tai < > > tzuli...@apache.org > > > > > > > > >> wrote: > > > > >> > > > > >> > Hi, > > > > >> > > > > > >> > Great seeing efforts in pushing this forward, Jark! > > > > >> > > > > > >> > A bit late in the party here, but I just want to also point out > > > that: > > > > >> > > > > > >> > - +1 to https://flink.apache.org/zh/ as the website address > > > > >> > - Add to the contribution checklist in PRs that both English / > > > Chinese > > > > >> docs > > > > >> > have been updated accordingly. > > > > >> > > > > > >> > I want to point out that, if a contribution touches either the > > > English > > > > >> or > > > > >> > Chinese documentation, then both sides should be updated before > > the > > > > >> > contribution can be merged. > > > > >> > Otherwise, in the long run, it'll be very hard to keep track > which > > > > >> parts of > > > > >> > the documentation requires update. > > > > >> > > > > > >> > For this to work, we might need a list of known Chinese-speaking > > > > >> > contributors who would be willing to work on the Chinese docs > > > > available > > > > >> > somewhere (maybe in the project community Wiki?), so that an > > English > > > > >> > contributor knows who they can reach out to for helping with the > > > > >> > translation. > > > > >> > The same goes for the other way around. > > > > >> > > > > > >> > Cheers, > > > > >> > Gordon > > > > >> > > > > > >> > On Fri, Feb 1, 2019 at 5:39 PM Fabian Hueske <fhue...@gmail.com > > > > > > wrote: > > > > >> > > > > > >> > > Hi Jark, > > > > >> > > > > > > >> > > Thanks for working out a plan to integrate the Chinese > > > translation! > > > > >> > > > > > > >> > > I would propose to first contribute and integrate the Chinese > > > > version > > > > >> of > > > > >> > > the main page (flink.apache.org). > > > > >> > > It is much smaller than the docs and a smaller scope might > help > > to > > > > >> find > > > > >> > > tricks to ease the integration of the documentation. > > > > >> > > > > > > >> > > Looking forward to the proposal, > > > > >> > > Fabian > > > > >> > > > > > > >> > > > > > > >> > > > > > > >> > > > > > > >> > > > > > > >> > > Am Di., 29. Jan. 2019 um 13:37 Uhr schrieb Jark Wu < > > > > imj...@gmail.com > > > > >> >: > > > > >> > > > > > > >> > > > Hi, > > > > >> > > > > > > > >> > > > Thank you all for welcoming this proposal. > > > > >> > > > I will draft a detailed proposal about how to do contribute > it > > > > step > > > > >> by > > > > >> > > step > > > > >> > > > in the next few days, and create umbrella JIRA once the > > proposal > > > > is > > > > >> > > > accepted. > > > > >> > > > > > > > >> > > > @Fabian @JIngcheng Regarding the name, I'm fine with > > > > >> > > > https://flink.apache.org/zh/. > > > > >> > > > > > > > >> > > > @Yun Tang Thanks for pointing Alluxio out as a reference. I > > > agree > > > > >> with > > > > >> > > that > > > > >> > > > reviewing Chinese documentation is not easy for the > community. > > > > >> > > > But I think this wouldn't be a big problem as the community > > > > already > > > > >> has > > > > >> > > > many Chinese-speaking committers and more Chinese > contributors > > > are > > > > >> > > joining > > > > >> > > > in. > > > > >> > > > > > > > >> > > > @Dian Fu Adding a step to the review process is a good > idea! > > > > >> > > > Maybe we can automatically add an item of "Chinese document > > > sync" > > > > >> when > > > > >> > > the > > > > >> > > > document is modified with the help of the newly introduced > > > > >> review-bot. > > > > >> > > > > > > > >> > > > Hi @Jörn Franke > > > > >> > > > > Keep also in mind the other direction eg a new/modified > > > version > > > > of > > > > >> > the > > > > >> > > > Chinese documentation needs to be reflected in the English > > one. > > > > >> > > > I think we should always modify English doc first, and then > > > > >> translate > > > > >> > the > > > > >> > > > changes to Chinese document. > > > > >> > > > > > > > >> > > > Hi @Chesnay > > > > >> > > > > Is the build-system for flink-china.org identical to > > > flink-web? > > > > >> > > > The build-system of flink-china.org is wrote by Yadong ( > > > > >> > > > vthink...@gmail.com) > > > > >> > > > which is not using Jekyll. You can access the code of > > > > >> flink-china.org > > > > >> > > > via: > > > > >> > > > https://github.com/flink-china/doc > > > > >> > > > > > > > >> > > > Best, > > > > >> > > > Jark > > > > >> > > > > > > > >> > > > On Tue, 29 Jan 2019 at 18:21, Chesnay Schepler < > > > > ches...@apache.org> > > > > >> > > wrote: > > > > >> > > > > > > > >> > > > > Is the build-system for flink-china.org identical to > > > flink-web? > > > > >> > > > > > > > > >> > > > > On 28.01.2019 12:48, Jark Wu wrote: > > > > >> > > > > > 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 > > > > >> > > > > > > > > > >> > > > > > > > > >> > > > > > > > > >> > > > > > > > >> > > > > > > >> > > > > > >> > > > > > > > > > > > > > > >
