Hi Jark, Thanks for starting the discussion!
I think integrating the website and documentation as subdirectories into the existing website and docs is a very good approach too. And when submitting a pull request, we should notice the author whether they changed the documents, If yes, should create a jira for the Chinese documents. ------------------ ???????? ------------------ ??????: "fudian.fd"<fudian...@alibaba-inc.com>; ????????: 2019??1??29??(??????) ????1:30 ??????: "dev"<dev@flink.apache.org>; ????: Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink Hi Jark, Thanks a lot for starting the discussion! It would be great to have an official Flink Chinese doc. For the long term maintaining problem, I think creating a JIRA when the English documentation is updated is a good idea. Should we add one item such as "Does this pull request updated the documentation? If yes, is the Chinese documentation is updated?" in the pull-request-template to remind the contributors to create the JIRA if Chinese documentation should be updated? Regards, Dian > ?? 2019??1??29????????11:13??jincheng sun <sunjincheng...@gmail.com> ?????? > > Thanks Jark starting this discussion! > > Hi Fabian, very glad to hear that you like this proposal. > As far as I know?? `zh` is the language, `cn` is the territory, such as: > `zh-cn` representative > Simplified Chinese (China) , `zh-tw` representative Traditional Chinese > (Taiwan), So i like the naming the mailing list and website as follows: > > maillist: user...@flink.apache.org > website: https://flink.apache.org/zh/ > > BTW: > I completely agree with translating resources is a great way to contribute > without writing source code. > Welcome and thank every contributors to the translation resources?? > > Best, Jincheng > > Fabian Hueske <fhue...@gmail.com> ??2019??1??28?????? ????9:49?????? > >> 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 >>> >>
