[DISCUSS] Contributing Chinese website and docs to Apache Flink

[Hequn Cheng]

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 <[hidden email]> 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 <
> [hidden email]>:
>
> > +1 ， Happy Chinese New Year! :)
> >
> > Best，Jincheng
> > From Singapore
> >
> > Jark Wu <[hidden email]>于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 <[hidden email]>  +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 <[hidden email]>  @Fabian Hueske <[hidden email]>  ?
> >>
> >> Btw, Happy Chinese New Year! :)
> >>
> >> Cheers, Jark
> >>
> >>
> >> On Fri, 1 Feb 2019 at 18:22, Tzu-Li (Gordon) Tai <[hidden email]>
> >> 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 <[hidden email]>
> 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 <
> [hidden email]
> >> >:
> >> > >
> >> > > > 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 (
> >> > > > [hidden email])
> >> > > > 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 <
> [hidden email]>
> >> > > 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
> >> > > > > >
> >> > > > >
> >> > > > >
> >> > > >
> >> > >
> >> >
> >>
> >
>

[Stephan Ewen]

Nice proposal

+1

On Tue, Feb 5, 2019 at 8:16 AM Hequn Cheng <[hidden email]> 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 <[hidden email]> 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 <
> > [hidden email]>:
> >
> > > +1 ， Happy Chinese New Year! :)
> > >
> > > Best，Jincheng
> > > From Singapore
> > >
> > > Jark Wu <[hidden email]>于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 <[hidden email]>  +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 <[hidden email]>  @Fabian Hueske <[hidden email]>  ?
> > >>
> > >> Btw, Happy Chinese New Year! :)
> > >>
> > >> Cheers, Jark
> > >>
> > >>
> > >> On Fri, 1 Feb 2019 at 18:22, Tzu-Li (Gordon) Tai <[hidden email]
> >
> > >> 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 <[hidden email]>
> > 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 <
> > [hidden email]
> > >> >:
> > >> > >
> > >> > > > 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 (
> > >> > > > [hidden email])
> > >> > > > 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 <
> > [hidden email]>
> > >> > > 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
> > >> > > > > >
> > >> > > > >
> > >> > > > >
> > >> > > >
> > >> > >
> > >> >
> > >>
> > >
> >
>

[Jark Wu-2]

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 <[hidden email]> wrote:

> Nice proposal
>
> +1
>
> On Tue, Feb 5, 2019 at 8:16 AM Hequn Cheng <[hidden email]> 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 <[hidden email]> 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 <
> > > [hidden email]>:
> > >
> > > > +1 ， Happy Chinese New Year! :)
> > > >
> > > > Best，Jincheng
> > > > From Singapore
> > > >
> > > > Jark Wu <[hidden email]>于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 <[hidden email]>  +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 <[hidden email]>  @Fabian Hueske <[hidden email]>
> ?
> > > >>
> > > >> Btw, Happy Chinese New Year! :)
> > > >>
> > > >> Cheers, Jark
> > > >>
> > > >>
> > > >> On Fri, 1 Feb 2019 at 18:22, Tzu-Li (Gordon) Tai <
> [hidden email]
> > >
> > > >> 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 <[hidden email]>
> > > 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 <
> > > [hidden email]
> > > >> >:
> > > >> > >
> > > >> > > > 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 (
> > > >> > > > [hidden email])
> > > >> > > > 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 <
> > > [hidden email]>
> > > >> > > 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
> > > >> > > > > >
> > > >> > > > >
> > > >> > > > >
> > > >> > > >
> > > >> > >
> > > >> >
> > > >>
> > > >
> > >
> >
>

[Rong Rong]

+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 <[hidden email]> 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 <[hidden email]> wrote:
>
> > Nice proposal
> >
> > +1
> >
> > On Tue, Feb 5, 2019 at 8:16 AM Hequn Cheng <[hidden email]> 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 <[hidden email]>
> 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 <
> > > > [hidden email]>:
> > > >
> > > > > +1 ， Happy Chinese New Year! :)
> > > > >
> > > > > Best，Jincheng
> > > > > From Singapore
> > > > >
> > > > > Jark Wu <[hidden email]>于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 <[hidden email]>  +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 <[hidden email]>  @Fabian Hueske <[hidden email]>
> > ?
> > > > >>
> > > > >> Btw, Happy Chinese New Year! :)
> > > > >>
> > > > >> Cheers, Jark
> > > > >>
> > > > >>
> > > > >> On Fri, 1 Feb 2019 at 18:22, Tzu-Li (Gordon) Tai <
> > [hidden email]
> > > >
> > > > >> 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 <[hidden email]
> >
> > > > 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 <
> > > > [hidden email]
> > > > >> >:
> > > > >> > >
> > > > >> > > > 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 (
> > > > >> > > > [hidden email])
> > > > >> > > > 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 <
> > > > [hidden email]>
> > > > >> > > 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
> > > > >> > > > > >
> > > > >> > > > >
> > > > >> > > > >
> > > > >> > > >
> > > > >> > >
> > > > >> >
> > > > >>
> > > > >
> > > >
> > >
> >
>

[Jark Wu-2]

Hi Rong,

You raised a good question. The terminology translation is a difficult
problem because different people may prefer different translations.
So I would like to start a terminology translation specification discussion
(maybe it should be another thread) to reach a consensus in the community.

Here is the draft:
https://docs.google.com/document/d/1zhGyPU4bVJ7mCIdUTsQr9lHLn4vltejhngG_SOV6g1w/edit?usp=sharing
Maybe we can put it into flink website when we reach an agreement.

Best,
Jark


On Thu, 7 Feb 2019 at 02:14, Rong Rong <[hidden email]> wrote:

> +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 <[hidden email]> 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 <[hidden email]> wrote:
> >
> > > Nice proposal
> > >
> > > +1
> > >
> > > On Tue, Feb 5, 2019 at 8:16 AM Hequn Cheng <[hidden email]>
> 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 <[hidden email]>
> > 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 <
> > > > > [hidden email]>:
> > > > >
> > > > > > +1 ， Happy Chinese New Year! :)
> > > > > >
> > > > > > Best，Jincheng
> > > > > > From Singapore
> > > > > >
> > > > > > Jark Wu <[hidden email]>于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 <[hidden email]>  +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 <[hidden email]>  @Fabian Hueske <
> [hidden email]>
> > > ?
> > > > > >>
> > > > > >> Btw, Happy Chinese New Year! :)
> > > > > >>
> > > > > >> Cheers, Jark
> > > > > >>
> > > > > >>
> > > > > >> On Fri, 1 Feb 2019 at 18:22, Tzu-Li (Gordon) Tai <
> > > [hidden email]
> > > > >
> > > > > >> 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 <
> [hidden email]
> > >
> > > > > 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 <
> > > > > [hidden email]
> > > > > >> >:
> > > > > >> > >
> > > > > >> > > > 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 (
> > > > > >> > > > [hidden email])
> > > > > >> > > > 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 <
> > > > > [hidden email]>
> > > > > >> > > 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
> > > > > >> > > > > >
> > > > > >> > > > >
> > > > > >> > > > >
> > > > > >> > > >
> > > > > >> > >
> > > > > >> >
> > > > > >>
> > > > > >
> > > > >
> > > >
> > >
> >
>

[Shaoxuan Wang]

Thanks for spending efforts to build a Flink web in Chinese, everyone.

Good job, Jark!

This looks look to me. I have only one concern about the synchronization of
the English and Chinese website. We can not expect the author of the
English doc to produce Chinese doc at the same time. If no one follows up
on the changes in English documents, it will not take long for the
difference between English and Chinese docs to become larger and larger. I
suggest we should assign the owners to the Chinese web, say 1-2 people (we
can have more people, then do monthly rotate). They regularly (weekly
or monthly) catch the new changes in English doc and synchronize/translate
them to the Chinese doc.

Regards,
Shaoxuan


On Mon, Feb 4, 2019 at 1:23 PM Jark Wu <[hidden email]> wrote:

> 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 <[hidden email]>  +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 <[hidden email]>  @Fabian Hueske <[hidden email]>  ?
>
> Btw, Happy Chinese New Year! :)
>
> Cheers, Jark
>
>
> On Fri, 1 Feb 2019 at 18:22, Tzu-Li (Gordon) Tai <[hidden email]>
> 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 <[hidden email]> 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 <[hidden email]>:
> > >
> > > > 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 (
> > > > [hidden email])
> > > > 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 <[hidden email]>
> > > 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
> > > > > >
> > > > >
> > > > >
> > > >
> > >
> >
>

[Jark Wu-2]

Hi Shaoxuan,

Thank you for your feedback.

If the author is not familiar with Chinese, he/she should create a
translation JIRA before the pull request is merged in.
The created JIRA can be attached a "chinese-translation" tag so that it can
be searched easily. Then a Chinese contributor can take this JIRA and
translate it after the original JIRA is merged.
In order to make this work, we will add a checklist to the review-bot to
check whether a translation JIRA is created or both English/Chinese docs
are updated.

The changes to the contribute process is included in the proposal doc:
https://docs.google.com/document/d/1R1-uDq-KawLB8afQYrczfcoQHjjIhq6tvUksxrfhBl0/edit#heading=h.7yn7issnkrey

Best,
Jark


On Mon, 11 Feb 2019 at 15:20, Shaoxuan Wang <[hidden email]> wrote:

> Thanks for spending efforts to build a Flink web in Chinese, everyone.
>
> Good job, Jark!
>
> This looks look to me. I have only one concern about the synchronization of
> the English and Chinese website. We can not expect the author of the
> English doc to produce Chinese doc at the same time. If no one follows up
> on the changes in English documents, it will not take long for the
> difference between English and Chinese docs to become larger and larger. I
> suggest we should assign the owners to the Chinese web, say 1-2 people (we
> can have more people, then do monthly rotate). They regularly (weekly
> or monthly) catch the new changes in English doc and synchronize/translate
> them to the Chinese doc.
>
> Regards,
> Shaoxuan
>
>
> On Mon, Feb 4, 2019 at 1:23 PM Jark Wu <[hidden email]> wrote:
>
> > 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 <[hidden email]>  +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 <[hidden email]>  @Fabian Hueske <[hidden email]>  ?
> >
> > Btw, Happy Chinese New Year! :)
> >
> > Cheers, Jark
> >
> >
> > On Fri, 1 Feb 2019 at 18:22, Tzu-Li (Gordon) Tai <[hidden email]>
> > 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 <[hidden email]>
> 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 <[hidden email]
> >:
> > > >
> > > > > 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 (
> > > > > [hidden email])
> > > > > 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 <[hidden email]
> >
> > > > 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
> > > > > > >
> > > > > >
> > > > > >
> > > > >
> > > >
> > >
> >
>

[xingcanc]

Hi,

Thank you for working on this.

I think assigning pages to someones and synchronizing them regularly may be a better idea.

1. We encourage contributors who are familiar with Chinese and would like to do the translation to provide Chinese doc updates in sync, but should not add extra burden (even like creating translation JIRA issues) to others.
2. Designated people could merge minor updates into one and ensure translation quality.
3. It would be better to add the Chinese doc translation step into the reviewing checklist and provide some rules for the synchronization work (e.g., the docs must be synced when a new version is to be released).

Best,
Xingcan

> On Feb 11, 2019, at 6:23 AM, Jark Wu <[hidden email]> wrote:
>
> Hi Shaoxuan,
>
> Thank you for your feedback.
>
> If the author is not familiar with Chinese, he/she should create a
> translation JIRA before the pull request is merged in.
> The created JIRA can be attached a "chinese-translation" tag so that it can
> be searched easily. Then a Chinese contributor can take this JIRA and
> translate it after the original JIRA is merged.
> In order to make this work, we will add a checklist to the review-bot to
> check whether a translation JIRA is created or both English/Chinese docs
> are updated.
>
> The changes to the contribute process is included in the proposal doc:
> https://docs.google.com/document/d/1R1-uDq-KawLB8afQYrczfcoQHjjIhq6tvUksxrfhBl0/edit#heading=h.7yn7issnkrey
>
> Best,
> Jark
>
>
> On Mon, 11 Feb 2019 at 15:20, Shaoxuan Wang <[hidden email]> wrote:
>
>> Thanks for spending efforts to build a Flink web in Chinese, everyone.
>>
>> Good job, Jark!
>>
>> This looks look to me. I have only one concern about the synchronization of
>> the English and Chinese website. We can not expect the author of the
>> English doc to produce Chinese doc at the same time. If no one follows up
>> on the changes in English documents, it will not take long for the
>> difference between English and Chinese docs to become larger and larger. I
>> suggest we should assign the owners to the Chinese web, say 1-2 people (we
>> can have more people, then do monthly rotate). They regularly (weekly
>> or monthly) catch the new changes in English doc and synchronize/translate
>> them to the Chinese doc.
>>
>> Regards,
>> Shaoxuan
>>
>>
>> On Mon, Feb 4, 2019 at 1:23 PM Jark Wu <[hidden email]> wrote:
>>
>>> 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 <[hidden email]>  +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 <[hidden email]>  @Fabian Hueske <[hidden email]>  ?
>>>
>>> Btw, Happy Chinese New Year! :)
>>>
>>> Cheers, Jark
>>>
>>>
>>> On Fri, 1 Feb 2019 at 18:22, Tzu-Li (Gordon) Tai <[hidden email]>
>>> 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 <[hidden email]>
>> 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 <[hidden email]
>>> :
>>>>>
>>>>>> 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 (
>>>>>> [hidden email])
>>>>>> 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 <[hidden email]
>>>
>>>>> 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
>>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>
>>>>>
>>>>
>>>
>>

[Rong Rong]

Hi all,

Thanks @Jark for creating the translation terminology document! I think the
idea of keeping some of the terminologies untranslated and keeping such
document in place is absolutely good.
I actually share the same concern with @Shaoxuan regarding the discrepancy
getting larger. The dilemma is always been whether we block a merge because
document translation, or create a follow up JIRA. Either way this will be
extra effort on Chinese-speaking contributors, however the former creates
less discrepancies.

I actually agree with @Xingcan that translation should not create extra
burden, and better adding Chinese doc translation guidelines for both
contributors and reviewers. For example, Kylin actually have a specific
section for multi-language support contribution[1]. It might be a good
starting point for a more well-rounded guideline?

Best,
Rong

[1] http://kylin.apache.org/development/howto_docs.html

On Mon, Feb 11, 2019 at 8:04 AM Xingcan Cui <[hidden email]> wrote:

> Hi,
>
> Thank you for working on this.
>
> I think assigning pages to someones and synchronizing them regularly may
> be a better idea.
>
> 1. We encourage contributors who are familiar with Chinese and would like
> to do the translation to provide Chinese doc updates in sync, but should
> not add extra burden (even like creating translation JIRA issues) to others.
> 2. Designated people could merge minor updates into one and ensure
> translation quality.
> 3. It would be better to add the Chinese doc translation step into the
> reviewing checklist and provide some rules for the synchronization work
> (e.g., the docs must be synced when a new version is to be released).
>
> Best,
> Xingcan
>
> > On Feb 11, 2019, at 6:23 AM, Jark Wu <[hidden email]> wrote:
> >
> > Hi Shaoxuan,
> >
> > Thank you for your feedback.
> >
> > If the author is not familiar with Chinese, he/she should create a
> > translation JIRA before the pull request is merged in.
> > The created JIRA can be attached a "chinese-translation" tag so that it
> can
> > be searched easily. Then a Chinese contributor can take this JIRA and
> > translate it after the original JIRA is merged.
> > In order to make this work, we will add a checklist to the review-bot to
> > check whether a translation JIRA is created or both English/Chinese docs
> > are updated.
> >
> > The changes to the contribute process is included in the proposal doc:
> >
> https://docs.google.com/document/d/1R1-uDq-KawLB8afQYrczfcoQHjjIhq6tvUksxrfhBl0/edit#heading=h.7yn7issnkrey
> >
> > Best,
> > Jark
> >
> >
> > On Mon, 11 Feb 2019 at 15:20, Shaoxuan Wang <[hidden email]> wrote:
> >
> >> Thanks for spending efforts to build a Flink web in Chinese, everyone.
> >>
> >> Good job, Jark!
> >>
> >> This looks look to me. I have only one concern about the
> synchronization of
> >> the English and Chinese website. We can not expect the author of the
> >> English doc to produce Chinese doc at the same time. If no one follows
> up
> >> on the changes in English documents, it will not take long for the
> >> difference between English and Chinese docs to become larger and
> larger. I
> >> suggest we should assign the owners to the Chinese web, say 1-2 people
> (we
> >> can have more people, then do monthly rotate). They regularly (weekly
> >> or monthly) catch the new changes in English doc and
> synchronize/translate
> >> them to the Chinese doc.
> >>
> >> Regards,
> >> Shaoxuan
> >>
> >>
> >> On Mon, Feb 4, 2019 at 1:23 PM Jark Wu <[hidden email]> wrote:
> >>
> >>> 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 <[hidden email]>  +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 <[hidden email]>  @Fabian Hueske <[hidden email]>  ?
> >>>
> >>> Btw, Happy Chinese New Year! :)
> >>>
> >>> Cheers, Jark
> >>>
> >>>
> >>> On Fri, 1 Feb 2019 at 18:22, Tzu-Li (Gordon) Tai <[hidden email]>
> >>> 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 <[hidden email]>
> >> 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 <[hidden email]
> >>> :
> >>>>>
> >>>>>> 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 (
> >>>>>> [hidden email])
> >>>>>> 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 <[hidden email]
> >>>
> >>>>> 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
> >>>>>>>>
> >>>>>>>
> >>>>>>>
> >>>>>>
> >>>>>
> >>>>
> >>>
> >>
>
>

[Jark Wu-2]

Hi @Xingcan,

> I think assigning pages to someones and synchronizing them regularly may
be a better idea.
> 1. We encourage contributors who are familiar with Chinese and would like
to do the translation to provide Chinese doc updates in sync, but should
not add extra burden (even like creating translation JIRA issues) to others.
I agree that we shouldn't add extra burden to others. But we already have
200+ pages, and the number is increasing. It's hard and not scaleable to
assign pages to some people. From my point of view, there are several
problems.
For example, how to rescale/assign when new contributors join in or new
pages are created, how to track/log which date/commit every page was last
updated to, how to avoid missing sync when someone is busy or unable to
contact.
IMO, the doc is not updated frequently and creating a followup JIRA is a
minor burden, it's a good way to track all the differences to sync (not
depend on someones to regularly sync) and easy to scale the works to the
community.

> 3. It would be better to add the Chinese doc translation step into the
reviewing checklist and provide some rules for the synchronization work
(e.g., the docs must be synced when a new version is to be released).
+1. But I don't think the Chinese doc needs to be tied to a release. Since
docs are build and published every day. We can incrementally improve it
even after version released.

Hi @Rong Rong <[hidden email]> ,

>  update both English&Chinese in one PR VS create a follow up JIRA
I agree with you the former creates less discrepancies. But I'm not sure
whether it will work well.
Because sometimes, the changes to the document could be large, e.g. add
several new pages or restructure content.
It will be difficult to collaborate with others in one PR and will add
extreme burden to the non-Chinese-language contributors .
Btw, we should always encourage the author to update both side in one PR if
he/she is familiar with Chinese.
I think *tracking* all the differences is more important than keeping
*no/small* differences.
If we have enough contributors working on translation, the new differences
can be addressed in days.

> adding Chinese doc translation guidelines for both contributors and
reviewers.
+1. I have created a JIRA (FLINK-11581) to do that.

Regards,
Jark


On Tue, 12 Feb 2019 at 10:06, Rong Rong <[hidden email]> wrote:

> Hi all,
>
> Thanks @Jark for creating the translation terminology document! I think the
> idea of keeping some of the terminologies untranslated and keeping such
> document in place is absolutely good.
> I actually share the same concern with @Shaoxuan regarding the discrepancy
> getting larger. The dilemma is always been whether we block a merge because
> document translation, or create a follow up JIRA. Either way this will be
> extra effort on Chinese-speaking contributors, however the former creates
> less discrepancies.
>
> I actually agree with @Xingcan that translation should not create extra
> burden, and better adding Chinese doc translation guidelines for both
> contributors and reviewers. For example, Kylin actually have a specific
> section for multi-language support contribution[1]. It might be a good
> starting point for a more well-rounded guideline?
>
> Best,
> Rong
>
> [1] http://kylin.apache.org/development/howto_docs.html
>
> On Mon, Feb 11, 2019 at 8:04 AM Xingcan Cui <[hidden email]> wrote:
>
> > Hi,
> >
> > Thank you for working on this.
> >
> > I think assigning pages to someones and synchronizing them regularly may
> > be a better idea.
> >
> > 1. We encourage contributors who are familiar with Chinese and would like
> > to do the translation to provide Chinese doc updates in sync, but should
> > not add extra burden (even like creating translation JIRA issues) to
> others.
> > 2. Designated people could merge minor updates into one and ensure
> > translation quality.
> > 3. It would be better to add the Chinese doc translation step into the
> > reviewing checklist and provide some rules for the synchronization work
> > (e.g., the docs must be synced when a new version is to be released).
> >
> > Best,
> > Xingcan
> >
> > > On Feb 11, 2019, at 6:23 AM, Jark Wu <[hidden email]> wrote:
> > >
> > > Hi Shaoxuan,
> > >
> > > Thank you for your feedback.
> > >
> > > If the author is not familiar with Chinese, he/she should create a
> > > translation JIRA before the pull request is merged in.
> > > The created JIRA can be attached a "chinese-translation" tag so that it
> > can
> > > be searched easily. Then a Chinese contributor can take this JIRA and
> > > translate it after the original JIRA is merged.
> > > In order to make this work, we will add a checklist to the review-bot
> to
> > > check whether a translation JIRA is created or both English/Chinese
> docs
> > > are updated.
> > >
> > > The changes to the contribute process is included in the proposal doc:
> > >
> >
> https://docs.google.com/document/d/1R1-uDq-KawLB8afQYrczfcoQHjjIhq6tvUksxrfhBl0/edit#heading=h.7yn7issnkrey
> > >
> > > Best,
> > > Jark
> > >
> > >
> > > On Mon, 11 Feb 2019 at 15:20, Shaoxuan Wang <[hidden email]>
> wrote:
> > >
> > >> Thanks for spending efforts to build a Flink web in Chinese, everyone.
> > >>
> > >> Good job, Jark!
> > >>
> > >> This looks look to me. I have only one concern about the
> > synchronization of
> > >> the English and Chinese website. We can not expect the author of the
> > >> English doc to produce Chinese doc at the same time. If no one follows
> > up
> > >> on the changes in English documents, it will not take long for the
> > >> difference between English and Chinese docs to become larger and
> > larger. I
> > >> suggest we should assign the owners to the Chinese web, say 1-2 people
> > (we
> > >> can have more people, then do monthly rotate). They regularly (weekly
> > >> or monthly) catch the new changes in English doc and
> > synchronize/translate
> > >> them to the Chinese doc.
> > >>
> > >> Regards,
> > >> Shaoxuan
> > >>
> > >>
> > >> On Mon, Feb 4, 2019 at 1:23 PM Jark Wu <[hidden email]> wrote:
> > >>
> > >>> 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 <[hidden email]>  +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 <[hidden email]>  @Fabian Hueske <[hidden email]>  ?
> > >>>
> > >>> Btw, Happy Chinese New Year! :)
> > >>>
> > >>> Cheers, Jark
> > >>>
> > >>>
> > >>> On Fri, 1 Feb 2019 at 18:22, Tzu-Li (Gordon) Tai <
> [hidden email]>
> > >>> 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 <[hidden email]>
> > >> 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 <
> [hidden email]
> > >>> :
> > >>>>>
> > >>>>>> 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 (
> > >>>>>> [hidden email])
> > >>>>>> 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 <
> [hidden email]
> > >>>
> > >>>>> 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
> > >>>>>>>>
> > >>>>>>>
> > >>>>>>>
> > >>>>>>
> > >>>>>
> > >>>>
> > >>>
> > >>
> >
> >
>

[Tzu-Li (Gordon) Tai]

Hi,

While I 100% agree with @Xingcan that we should try to avoid adding extra
burden for contributors, at the very least, creating JIRA issues for adding
missing Chinese / English document updates must be done.

In the past, even with English documentation only, we already had the
problem of merging new features / API changes without updating the document
within the same contribution.
Over time, these missing document updates pile up and are only ever fixed
near the end of our release testing phases.
It would be much better if documentation for new features or changes to the
API are documented upfront and available already at the release testing
phase.
Not only would these open up more opportunities for non-developers to try
out the release, but also more eyes to help proofread new documents before
officially releasing.

I would like to see that this situation of "lagging documentation updates
until release" improves at the same time while we start introducing Chinese
docs, otherwise I think the situation will only deteriorate with the new
complications.
While I'm still leaning more towards my previous suggestion to strictly
require that both Chinese / English documents are updated in a single
contribution if either side is touched (),
I'm willing to withdraw that, given how it will definitely add more burden
for contributors and lengthens the contribution process (i.e. PRs being
blocked on something out of their control due to language barriers).

So, to wrap up, I propose the following action points (actually most of
which already mentioned earlier by other people):
- Adjust our PR review bot to include a "updated required English
documentation" & "opened a JIRA for Chinese documentation translation sync"
checks. A PR should not be merged without these checks being approved.
- Add a "zh-doc" label (names TBD) to our JIRA, which should be tagged on
Chinese documentation sync JIRAs opened in the previous step.
- Educate and encourage Chinese-speaking developers to search for these
labels in our contribution guidelines [1] & project WIKI [2].

Cheers,
Gordon

[1] https://flink.apache.org/contribute-documentation.html
[2]
https://cwiki.apache.org/confluence/display/FLINK/Pull+Request+Management

On Tue, Feb 12, 2019 at 10:06 AM Rong Rong <[hidden email]> wrote:

> Hi all,
>
> Thanks @Jark for creating the translation terminology document! I think the
> idea of keeping some of the terminologies untranslated and keeping such
> document in place is absolutely good.
> I actually share the same concern with @Shaoxuan regarding the discrepancy
> getting larger. The dilemma is always been whether we block a merge because
> document translation, or create a follow up JIRA. Either way this will be
> extra effort on Chinese-speaking contributors, however the former creates
> less discrepancies.
>
> I actually agree with @Xingcan that translation should not create extra
> burden, and better adding Chinese doc translation guidelines for both
> contributors and reviewers. For example, Kylin actually have a specific
> section for multi-language support contribution[1]. It might be a good
> starting point for a more well-rounded guideline?
>
> Best,
> Rong
>
> [1] http://kylin.apache.org/development/howto_docs.html
>
> On Mon, Feb 11, 2019 at 8:04 AM Xingcan Cui <[hidden email]> wrote:
>
> > Hi,
> >
> > Thank you for working on this.
> >
> > I think assigning pages to someones and synchronizing them regularly may
> > be a better idea.
> >
> > 1. We encourage contributors who are familiar with Chinese and would like
> > to do the translation to provide Chinese doc updates in sync, but should
> > not add extra burden (even like creating translation JIRA issues) to
> others.
> > 2. Designated people could merge minor updates into one and ensure
> > translation quality.
> > 3. It would be better to add the Chinese doc translation step into the
> > reviewing checklist and provide some rules for the synchronization work
> > (e.g., the docs must be synced when a new version is to be released).
> >
> > Best,
> > Xingcan
> >
> > > On Feb 11, 2019, at 6:23 AM, Jark Wu <[hidden email]> wrote:
> > >
> > > Hi Shaoxuan,
> > >
> > > Thank you for your feedback.
> > >
> > > If the author is not familiar with Chinese, he/she should create a
> > > translation JIRA before the pull request is merged in.
> > > The created JIRA can be attached a "chinese-translation" tag so that it
> > can
> > > be searched easily. Then a Chinese contributor can take this JIRA and
> > > translate it after the original JIRA is merged.
> > > In order to make this work, we will add a checklist to the review-bot
> to
> > > check whether a translation JIRA is created or both English/Chinese
> docs
> > > are updated.
> > >
> > > The changes to the contribute process is included in the proposal doc:
> > >
> >
> https://docs.google.com/document/d/1R1-uDq-KawLB8afQYrczfcoQHjjIhq6tvUksxrfhBl0/edit#heading=h.7yn7issnkrey
> > >
> > > Best,
> > > Jark
> > >
> > >
> > > On Mon, 11 Feb 2019 at 15:20, Shaoxuan Wang <[hidden email]>
> wrote:
> > >
> > >> Thanks for spending efforts to build a Flink web in Chinese, everyone.
> > >>
> > >> Good job, Jark!
> > >>
> > >> This looks look to me. I have only one concern about the
> > synchronization of
> > >> the English and Chinese website. We can not expect the author of the
> > >> English doc to produce Chinese doc at the same time. If no one follows
> > up
> > >> on the changes in English documents, it will not take long for the
> > >> difference between English and Chinese docs to become larger and
> > larger. I
> > >> suggest we should assign the owners to the Chinese web, say 1-2 people
> > (we
> > >> can have more people, then do monthly rotate). They regularly (weekly
> > >> or monthly) catch the new changes in English doc and
> > synchronize/translate
> > >> them to the Chinese doc.
> > >>
> > >> Regards,
> > >> Shaoxuan
> > >>
> > >>
> > >> On Mon, Feb 4, 2019 at 1:23 PM Jark Wu <[hidden email]> wrote:
> > >>
> > >>> 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 <[hidden email]>  +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 <[hidden email]>  @Fabian Hueske <[hidden email]>  ?
> > >>>
> > >>> Btw, Happy Chinese New Year! :)
> > >>>
> > >>> Cheers, Jark
> > >>>
> > >>>
> > >>> On Fri, 1 Feb 2019 at 18:22, Tzu-Li (Gordon) Tai <
> [hidden email]>
> > >>> 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 <[hidden email]>
> > >> 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 <
> [hidden email]
> > >>> :
> > >>>>>
> > >>>>>> 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 (
> > >>>>>> [hidden email])
> > >>>>>> 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 <
> [hidden email]
> > >>>
> > >>>>> 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
> > >>>>>>>>
> > >>>>>>>
> > >>>>>>>
> > >>>>>>
> > >>>>>
> > >>>>
> > >>>
> > >>
> >
> >
>

[Jark Wu-2]

Hi Gordon,

I totally agree with your proposal.

A minor comment: "updated required English documentation" should be
"updated required Chinese documentation" ?

Btw, I like the "zh-doc" label!

Regards,
Jark

On Tue, 12 Feb 2019 at 14:48, Tzu-Li (Gordon) Tai <[hidden email]>
wrote:

> Hi,
>
> While I 100% agree with @Xingcan that we should try to avoid adding extra
> burden for contributors, at the very least, creating JIRA issues for adding
> missing Chinese / English document updates must be done.
>
> In the past, even with English documentation only, we already had the
> problem of merging new features / API changes without updating the document
> within the same contribution.
> Over time, these missing document updates pile up and are only ever fixed
> near the end of our release testing phases.
> It would be much better if documentation for new features or changes to the
> API are documented upfront and available already at the release testing
> phase.
> Not only would these open up more opportunities for non-developers to try
> out the release, but also more eyes to help proofread new documents before
> officially releasing.
>
> I would like to see that this situation of "lagging documentation updates
> until release" improves at the same time while we start introducing Chinese
> docs, otherwise I think the situation will only deteriorate with the new
> complications.
> While I'm still leaning more towards my previous suggestion to strictly
> require that both Chinese / English documents are updated in a single
> contribution if either side is touched (),
> I'm willing to withdraw that, given how it will definitely add more burden
> for contributors and lengthens the contribution process (i.e. PRs being
> blocked on something out of their control due to language barriers).
>
> So, to wrap up, I propose the following action points (actually most of
> which already mentioned earlier by other people):
> - Adjust our PR review bot to include a "updated required English
> documentation" & "opened a JIRA for Chinese documentation translation sync"
> checks. A PR should not be merged without these checks being approved.
> - Add a "zh-doc" label (names TBD) to our JIRA, which should be tagged on
> Chinese documentation sync JIRAs opened in the previous step.
> - Educate and encourage Chinese-speaking developers to search for these
> labels in our contribution guidelines [1] & project WIKI [2].
>
> Cheers,
> Gordon
>
> [1] https://flink.apache.org/contribute-documentation.html
> [2]
> https://cwiki.apache.org/confluence/display/FLINK/Pull+Request+Management
>
> On Tue, Feb 12, 2019 at 10:06 AM Rong Rong <[hidden email]> wrote:
>
> > Hi all,
> >
> > Thanks @Jark for creating the translation terminology document! I think
> the
> > idea of keeping some of the terminologies untranslated and keeping such
> > document in place is absolutely good.
> > I actually share the same concern with @Shaoxuan regarding the
> discrepancy
> > getting larger. The dilemma is always been whether we block a merge
> because
> > document translation, or create a follow up JIRA. Either way this will be
> > extra effort on Chinese-speaking contributors, however the former creates
> > less discrepancies.
> >
> > I actually agree with @Xingcan that translation should not create extra
> > burden, and better adding Chinese doc translation guidelines for both
> > contributors and reviewers. For example, Kylin actually have a specific
> > section for multi-language support contribution[1]. It might be a good
> > starting point for a more well-rounded guideline?
> >
> > Best,
> > Rong
> >
> > [1] http://kylin.apache.org/development/howto_docs.html
> >
> > On Mon, Feb 11, 2019 at 8:04 AM Xingcan Cui <[hidden email]> wrote:
> >
> > > Hi,
> > >
> > > Thank you for working on this.
> > >
> > > I think assigning pages to someones and synchronizing them regularly
> may
> > > be a better idea.
> > >
> > > 1. We encourage contributors who are familiar with Chinese and would
> like
> > > to do the translation to provide Chinese doc updates in sync, but
> should
> > > not add extra burden (even like creating translation JIRA issues) to
> > others.
> > > 2. Designated people could merge minor updates into one and ensure
> > > translation quality.
> > > 3. It would be better to add the Chinese doc translation step into the
> > > reviewing checklist and provide some rules for the synchronization work
> > > (e.g., the docs must be synced when a new version is to be released).
> > >
> > > Best,
> > > Xingcan
> > >
> > > > On Feb 11, 2019, at 6:23 AM, Jark Wu <[hidden email]> wrote:
> > > >
> > > > Hi Shaoxuan,
> > > >
> > > > Thank you for your feedback.
> > > >
> > > > If the author is not familiar with Chinese, he/she should create a
> > > > translation JIRA before the pull request is merged in.
> > > > The created JIRA can be attached a "chinese-translation" tag so that
> it
> > > can
> > > > be searched easily. Then a Chinese contributor can take this JIRA and
> > > > translate it after the original JIRA is merged.
> > > > In order to make this work, we will add a checklist to the review-bot
> > to
> > > > check whether a translation JIRA is created or both English/Chinese
> > docs
> > > > are updated.
> > > >
> > > > The changes to the contribute process is included in the proposal
> doc:
> > > >
> > >
> >
> https://docs.google.com/document/d/1R1-uDq-KawLB8afQYrczfcoQHjjIhq6tvUksxrfhBl0/edit#heading=h.7yn7issnkrey
> > > >
> > > > Best,
> > > > Jark
> > > >
> > > >
> > > > On Mon, 11 Feb 2019 at 15:20, Shaoxuan Wang <[hidden email]>
> > wrote:
> > > >
> > > >> Thanks for spending efforts to build a Flink web in Chinese,
> everyone.
> > > >>
> > > >> Good job, Jark!
> > > >>
> > > >> This looks look to me. I have only one concern about the
> > > synchronization of
> > > >> the English and Chinese website. We can not expect the author of the
> > > >> English doc to produce Chinese doc at the same time. If no one
> follows
> > > up
> > > >> on the changes in English documents, it will not take long for the
> > > >> difference between English and Chinese docs to become larger and
> > > larger. I
> > > >> suggest we should assign the owners to the Chinese web, say 1-2
> people
> > > (we
> > > >> can have more people, then do monthly rotate). They regularly
> (weekly
> > > >> or monthly) catch the new changes in English doc and
> > > synchronize/translate
> > > >> them to the Chinese doc.
> > > >>
> > > >> Regards,
> > > >> Shaoxuan
> > > >>
> > > >>
> > > >> On Mon, Feb 4, 2019 at 1:23 PM Jark Wu <[hidden email]> wrote:
> > > >>
> > > >>> 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 <[hidden email]>  +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 <[hidden email]>  @Fabian Hueske <[hidden email]>
> ?
> > > >>>
> > > >>> Btw, Happy Chinese New Year! :)
> > > >>>
> > > >>> Cheers, Jark
> > > >>>
> > > >>>
> > > >>> On Fri, 1 Feb 2019 at 18:22, Tzu-Li (Gordon) Tai <
> > [hidden email]>
> > > >>> 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 <[hidden email]>
> > > >> 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 <
> > [hidden email]
> > > >>> :
> > > >>>>>
> > > >>>>>> 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 (
> > > >>>>>> [hidden email])
> > > >>>>>> 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 <
> > [hidden email]
> > > >>>
> > > >>>>> 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
> > > >>>>>>>>
> > > >>>>>>>
> > > >>>>>>>
> > > >>>>>>
> > > >>>>>
> > > >>>>
> > > >>>
> > > >>
> > >
> > >
> >
>

[Tzu-Li (Gordon) Tai]

On Tue, Feb 12, 2019 at 3:17 PM Jark Wu <[hidden email]> wrote:

> Hi Gordon,
>
> I totally agree with your proposal.
>
> A minor comment: "updated required English documentation" should be
> "updated required Chinese documentation" ?
>

Actually, that was what I meant to say.
My intention is that at least the English documentation should always be
updated. If the contributor is non-Chinese speaking, then a JIRA should be
opened to keep track of syncing the Chinese docs.

Cheers,
Gordon

> Btw, I like the "zh-doc" label!
>
> Regards,
> Jark
>
> On Tue, 12 Feb 2019 at 14:48, Tzu-Li (Gordon) Tai <[hidden email]>
> wrote:
>
> > Hi,
> >
> > While I 100% agree with @Xingcan that we should try to avoid adding extra
> > burden for contributors, at the very least, creating JIRA issues for
> adding
> > missing Chinese / English document updates must be done.
> >
> > In the past, even with English documentation only, we already had the
> > problem of merging new features / API changes without updating the
> document
> > within the same contribution.
> > Over time, these missing document updates pile up and are only ever fixed
> > near the end of our release testing phases.
> > It would be much better if documentation for new features or changes to
> the
> > API are documented upfront and available already at the release testing
> > phase.
> > Not only would these open up more opportunities for non-developers to try
> > out the release, but also more eyes to help proofread new documents
> before
> > officially releasing.
> >
> > I would like to see that this situation of "lagging documentation updates
> > until release" improves at the same time while we start introducing
> Chinese
> > docs, otherwise I think the situation will only deteriorate with the new
> > complications.
> > While I'm still leaning more towards my previous suggestion to strictly
> > require that both Chinese / English documents are updated in a single
> > contribution if either side is touched (),
> > I'm willing to withdraw that, given how it will definitely add more
> burden
> > for contributors and lengthens the contribution process (i.e. PRs being
> > blocked on something out of their control due to language barriers).
> >
> > So, to wrap up, I propose the following action points (actually most of
> > which already mentioned earlier by other people):
> > - Adjust our PR review bot to include a "updated required English
> > documentation" & "opened a JIRA for Chinese documentation translation
> sync"
> > checks. A PR should not be merged without these checks being approved.
> > - Add a "zh-doc" label (names TBD) to our JIRA, which should be tagged on
> > Chinese documentation sync JIRAs opened in the previous step.
> > - Educate and encourage Chinese-speaking developers to search for these
> > labels in our contribution guidelines [1] & project WIKI [2].
> >
> > Cheers,
> > Gordon
> >
> > [1] https://flink.apache.org/contribute-documentation.html
> > [2]
> >
> https://cwiki.apache.org/confluence/display/FLINK/Pull+Request+Management
> >
> > On Tue, Feb 12, 2019 at 10:06 AM Rong Rong <[hidden email]> wrote:
> >
> > > Hi all,
> > >
> > > Thanks @Jark for creating the translation terminology document! I think
> > the
> > > idea of keeping some of the terminologies untranslated and keeping such
> > > document in place is absolutely good.
> > > I actually share the same concern with @Shaoxuan regarding the
> > discrepancy
> > > getting larger. The dilemma is always been whether we block a merge
> > because
> > > document translation, or create a follow up JIRA. Either way this will
> be
> > > extra effort on Chinese-speaking contributors, however the former
> creates
> > > less discrepancies.
> > >
> > > I actually agree with @Xingcan that translation should not create extra
> > > burden, and better adding Chinese doc translation guidelines for both
> > > contributors and reviewers. For example, Kylin actually have a specific
> > > section for multi-language support contribution[1]. It might be a good
> > > starting point for a more well-rounded guideline?
> > >
> > > Best,
> > > Rong
> > >
> > > [1] http://kylin.apache.org/development/howto_docs.html
> > >
> > > On Mon, Feb 11, 2019 at 8:04 AM Xingcan Cui <[hidden email]>
> wrote:
> > >
> > > > Hi,
> > > >
> > > > Thank you for working on this.
> > > >
> > > > I think assigning pages to someones and synchronizing them regularly
> > may
> > > > be a better idea.
> > > >
> > > > 1. We encourage contributors who are familiar with Chinese and would
> > like
> > > > to do the translation to provide Chinese doc updates in sync, but
> > should
> > > > not add extra burden (even like creating translation JIRA issues) to
> > > others.
> > > > 2. Designated people could merge minor updates into one and ensure
> > > > translation quality.
> > > > 3. It would be better to add the Chinese doc translation step into
> the
> > > > reviewing checklist and provide some rules for the synchronization
> work
> > > > (e.g., the docs must be synced when a new version is to be released).
> > > >
> > > > Best,
> > > > Xingcan
> > > >
> > > > > On Feb 11, 2019, at 6:23 AM, Jark Wu <[hidden email]> wrote:
> > > > >
> > > > > Hi Shaoxuan,
> > > > >
> > > > > Thank you for your feedback.
> > > > >
> > > > > If the author is not familiar with Chinese, he/she should create a
> > > > > translation JIRA before the pull request is merged in.
> > > > > The created JIRA can be attached a "chinese-translation" tag so
> that
> > it
> > > > can
> > > > > be searched easily. Then a Chinese contributor can take this JIRA
> and
> > > > > translate it after the original JIRA is merged.
> > > > > In order to make this work, we will add a checklist to the
> review-bot
> > > to
> > > > > check whether a translation JIRA is created or both English/Chinese
> > > docs
> > > > > are updated.
> > > > >
> > > > > The changes to the contribute process is included in the proposal
> > doc:
> > > > >
> > > >
> > >
> >
> https://docs.google.com/document/d/1R1-uDq-KawLB8afQYrczfcoQHjjIhq6tvUksxrfhBl0/edit#heading=h.7yn7issnkrey
> > > > >
> > > > > Best,
> > > > > Jark
> > > > >
> > > > >
> > > > > On Mon, 11 Feb 2019 at 15:20, Shaoxuan Wang <[hidden email]>
> > > wrote:
> > > > >
> > > > >> Thanks for spending efforts to build a Flink web in Chinese,
> > everyone.
> > > > >>
> > > > >> Good job, Jark!
> > > > >>
> > > > >> This looks look to me. I have only one concern about the
> > > > synchronization of
> > > > >> the English and Chinese website. We can not expect the author of
> the
> > > > >> English doc to produce Chinese doc at the same time. If no one
> > follows
> > > > up
> > > > >> on the changes in English documents, it will not take long for the
> > > > >> difference between English and Chinese docs to become larger and
> > > > larger. I
> > > > >> suggest we should assign the owners to the Chinese web, say 1-2
> > people
> > > > (we
> > > > >> can have more people, then do monthly rotate). They regularly
> > (weekly
> > > > >> or monthly) catch the new changes in English doc and
> > > > synchronize/translate
> > > > >> them to the Chinese doc.
> > > > >>
> > > > >> Regards,
> > > > >> Shaoxuan
> > > > >>
> > > > >>
> > > > >> On Mon, Feb 4, 2019 at 1:23 PM Jark Wu <[hidden email]> wrote:
> > > > >>
> > > > >>> 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 <[hidden email]>  +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 <[hidden email]>  @Fabian Hueske <[hidden email]
> >
> > ?
> > > > >>>
> > > > >>> Btw, Happy Chinese New Year! :)
> > > > >>>
> > > > >>> Cheers, Jark
> > > > >>>
> > > > >>>
> > > > >>> On Fri, 1 Feb 2019 at 18:22, Tzu-Li (Gordon) Tai <
> > > [hidden email]>
> > > > >>> 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 <[hidden email]
> >
> > > > >> 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 <
> > > [hidden email]
> > > > >>> :
> > > > >>>>>
> > > > >>>>>> 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 (
> > > > >>>>>> [hidden email])
> > > > >>>>>> 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 <
> > > [hidden email]
> > > > >>>
> > > > >>>>> 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
> > > > >>>>>>>>
> > > > >>>>>>>
> > > > >>>>>>>
> > > > >>>>>>
> > > > >>>>>
> > > > >>>>
> > > > >>>
> > > > >>
> > > >
> > > >
> > >
> >
>

[Sijie Guo]

Hi,

Sorry for interrupting the thread. But this topic sounds interesting to me.
It might be worth for you guys checking out docusaurus
https://docusaurus.io/docs/en/translation . Docusaurus is a documentation
framework open sourced by Facebook. It has handled versioning and
localization (via crowdin) pretty good. Apache Pulsar is using it for its
website and documentation.

- Sijie

On Mon, Jan 28, 2019 at 7:59 PM Jark Wu <[hidden email]> 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
>

[Fabian Hueske-2]

Hi everyone,

+1 to what Gordon and Jark proposed.
We should make use of the review bot to ensure that new features are
documented at least in English.
If the Chinese docs are not updated, a Jira issue must be created.

@Sijie, thank for the pointer to Docusaurus! IMO, this looks very
interesting and should be worth exploring.

Thanks, Fabian



Am Di., 12. Feb. 2019 um 09:06 Uhr schrieb Sijie Guo <[hidden email]>:

> Hi,
>
> Sorry for interrupting the thread. But this topic sounds interesting to me.
> It might be worth for you guys checking out docusaurus
> https://docusaurus.io/docs/en/translation . Docusaurus is a documentation
> framework open sourced by Facebook. It has handled versioning and
> localization (via crowdin) pretty good. Apache Pulsar is using it for its
> website and documentation.
>
> - Sijie
>
> On Mon, Jan 28, 2019 at 7:59 PM Jark Wu <[hidden email]> 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
> >
>

[Jark Wu-2]

Hi @Sijie,

Thank you for the valuable information. I will explore Docusaurus and
feedback here.

Best,
Jark

On Tue, 12 Feb 2019 at 18:18, Fabian Hueske <[hidden email]> wrote:

> Hi everyone,
>
> +1 to what Gordon and Jark proposed.
> We should make use of the review bot to ensure that new features are
> documented at least in English.
> If the Chinese docs are not updated, a Jira issue must be created.
>
> @Sijie, thank for the pointer to Docusaurus! IMO, this looks very
> interesting and should be worth exploring.
>
> Thanks, Fabian
>
>
>
> Am Di., 12. Feb. 2019 um 09:06 Uhr schrieb Sijie Guo <[hidden email]>:
>
> > Hi,
> >
> > Sorry for interrupting the thread. But this topic sounds interesting to
> me.
> > It might be worth for you guys checking out docusaurus
> > https://docusaurus.io/docs/en/translation . Docusaurus is a
> documentation
> > framework open sourced by Facebook. It has handled versioning and
> > localization (via crowdin) pretty good. Apache Pulsar is using it for its
> > website and documentation.
> >
> > - Sijie
> >
> > On Mon, Jan 28, 2019 at 7:59 PM Jark Wu <[hidden email]> 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
> > >
> >
>

[xingcanc]

Hi,

I agree with the proposal, Gordon and Jark, and I think it's a good solution for major doc changes. We also created separated JIRAs for English documentation in the past.

For minor doc changes, I think it’s better to encourage Chinese-speaking contributors to participate in the reviewing process and help translate the few lines in sync.

Best,
Xingcan

> On Feb 12, 2019, at 7:04 AM, Jark Wu <[hidden email]> wrote:
>
> Hi @Sijie,
>
> Thank you for the valuable information. I will explore Docusaurus and
> feedback here.
>
> Best,
> Jark
>
> On Tue, 12 Feb 2019 at 18:18, Fabian Hueske <[hidden email]> wrote:
>
>> Hi everyone,
>>
>> +1 to what Gordon and Jark proposed.
>> We should make use of the review bot to ensure that new features are
>> documented at least in English.
>> If the Chinese docs are not updated, a Jira issue must be created.
>>
>> @Sijie, thank for the pointer to Docusaurus! IMO, this looks very
>> interesting and should be worth exploring.
>>
>> Thanks, Fabian
>>
>>
>>
>> Am Di., 12. Feb. 2019 um 09:06 Uhr schrieb Sijie Guo <[hidden email]>:
>>
>>> Hi,
>>>
>>> Sorry for interrupting the thread. But this topic sounds interesting to
>> me.
>>> It might be worth for you guys checking out docusaurus
>>> https://docusaurus.io/docs/en/translation . Docusaurus is a
>> documentation
>>> framework open sourced by Facebook. It has handled versioning and
>>> localization (via crowdin) pretty good. Apache Pulsar is using it for its
>>> website and documentation.
>>>
>>> - Sijie
>>>
>>> On Mon, Jan 28, 2019 at 7:59 PM Jark Wu <[hidden email]> 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
>>>>
>>>
>>

[Jark Wu-2]

Hi all,

Qianjing Xu and I have been exploring Docusaurus and crowdin in recent days
to see how can Flink fit into them to support multi-language.

Here is the summary from our side:
(we didn't learn deeply, so we may miss something or misunderstand. Please
correct us if we are wrong)

# What is Docusaurus and crowdin ?
Docusaurus [1] is a documentation framework which supports document
versioning and localization (via crowdin). IMO, Docusaurus is something
similar to Jekyll.
Crowdin[2] is a localization management platform. Users can upload contents
(e.g. markdown source files) to crowdin and translate, collaborate, manage
process on crowdin.
The English contents is kept in the original repository, and the multiple
language translated contents is kept in crowdin. We need to download the
translated contents from crowdin and build them into localization website.
Apache Pulsar is using them for website and documentation as @Sijie
mentioned above.
Here is the Pulsar project on crowdin [3].
And here is a test project for Flink I created [4].

# How can Flink fit into them?
I'm afraid that Flink is hard to fit into Docusaurus unless we rework our
website/docs from Jekyll to Docusaurus.

How about Jekyll + Crowdin?
We need a build job to make it work. The build job is triggered when a
commit merged into master.
The build job does the following things:
1) upload the lastest contents (English markdown source files) from git to
crowdin.
    - If the source content is changed, the corresponding translation will
lose and need re-translation.
2) download the translated contents
3) build website and publish

But it seems that Crowdin doesn't fit well with Jekyll.
Crowdin will break contents into multiple lines to translate according his
syntax. This results to the layout broken.
For example, the translated metric page is not rendered as expect:
this is the original `metric.md`:
https://user-images.githubusercontent.com/5378924/52795366-9a22f080-30ac-11e9-9cfd-4de82041aa77.png
this is the file downloaded from crowdin:
https://user-images.githubusercontent.com/5378924/52795379-9f803b00-30ac-11e9-9700-0a4077b5882d.png
this is the page after rendered:
https://user-images.githubusercontent.com/5378924/52795389-a5761c00-30ac-11e9-9821-35c705a8d65b.png

So it seems that currently crowdin works less well when the markdown
contains HTML and Liquid codes.

# Conclusion (Docusaurus/crowdin or previous proposal)
I'm leaning more towards the previous proposal [5]. Not only because
crowdin works less well for Flink currently.
But also it introduces much new things and tools to learn for contributors.
Furthermore the previous proposed translate process works good when we
experiment it in Flink website.

What do you think?

Regards,
Jark

[1]: https://docusaurus.io/en/
[2]: https://crowdin.com/
[3]: https://crowdin.com/project/apache-pulsar/zh-CN#
[4]: https://crowdin.com/project/flink-test/zh-CN#
[5]:
https://docs.google.com/document/d/1R1-uDq-KawLB8afQYrczfcoQHjjIhq6tvUksxrfhBl0/edit#


On Tue, 12 Feb 2019 at 23:48, Xingcan Cui <[hidden email]> wrote:

> Hi,
>
> I agree with the proposal, Gordon and Jark, and I think it's a good
> solution for major doc changes. We also created separated JIRAs for English
> documentation in the past.
>
> For minor doc changes, I think it’s better to encourage Chinese-speaking
> contributors to participate in the reviewing process and help translate the
> few lines in sync.
>
> Best,
> Xingcan
>
> > On Feb 12, 2019, at 7:04 AM, Jark Wu <[hidden email]> wrote:
> >
> > Hi @Sijie,
> >
> > Thank you for the valuable information. I will explore Docusaurus and
> > feedback here.
> >
> > Best,
> > Jark
> >
> > On Tue, 12 Feb 2019 at 18:18, Fabian Hueske <[hidden email]> wrote:
> >
> >> Hi everyone,
> >>
> >> +1 to what Gordon and Jark proposed.
> >> We should make use of the review bot to ensure that new features are
> >> documented at least in English.
> >> If the Chinese docs are not updated, a Jira issue must be created.
> >>
> >> @Sijie, thank for the pointer to Docusaurus! IMO, this looks very
> >> interesting and should be worth exploring.
> >>
> >> Thanks, Fabian
> >>
> >>
> >>
> >> Am Di., 12. Feb. 2019 um 09:06 Uhr schrieb Sijie Guo <[hidden email]
> >:
> >>
> >>> Hi,
> >>>
> >>> Sorry for interrupting the thread. But this topic sounds interesting to
> >> me.
> >>> It might be worth for you guys checking out docusaurus
> >>> https://docusaurus.io/docs/en/translation . Docusaurus is a
> >> documentation
> >>> framework open sourced by Facebook. It has handled versioning and
> >>> localization (via crowdin) pretty good. Apache Pulsar is using it for
> its
> >>> website and documentation.
> >>>
> >>> - Sijie
> >>>
> >>> On Mon, Jan 28, 2019 at 7:59 PM Jark Wu <[hidden email]> 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
> >>>>
> >>>
> >>
>
>

[Fabian Hueske-2]

Hi Jark,

Thanks so much for evaluating Docusaurus and Crowdin and writing up this
report!
It seems that staying with the current approach and avoiding the effort of
porting the documentation is the best solution for now.

We might want to reconsider Docusaurus if we want to restructure the
documentation completely at some point.

Thanks,
Fabian

Am Do., 14. Feb. 2019 um 16:41 Uhr schrieb Jark Wu <[hidden email]>:

> Hi all,
>
> Qianjing Xu and I have been exploring Docusaurus and crowdin in recent days
> to see how can Flink fit into them to support multi-language.
>
> Here is the summary from our side:
> (we didn't learn deeply, so we may miss something or misunderstand. Please
> correct us if we are wrong)
>
> # What is Docusaurus and crowdin ?
> Docusaurus [1] is a documentation framework which supports document
> versioning and localization (via crowdin). IMO, Docusaurus is something
> similar to Jekyll.
> Crowdin[2] is a localization management platform. Users can upload contents
> (e.g. markdown source files) to crowdin and translate, collaborate, manage
> process on crowdin.
> The English contents is kept in the original repository, and the multiple
> language translated contents is kept in crowdin. We need to download the
> translated contents from crowdin and build them into localization website.
> Apache Pulsar is using them for website and documentation as @Sijie
> mentioned above.
> Here is the Pulsar project on crowdin [3].
> And here is a test project for Flink I created [4].
>
> # How can Flink fit into them?
> I'm afraid that Flink is hard to fit into Docusaurus unless we rework our
> website/docs from Jekyll to Docusaurus.
>
> How about Jekyll + Crowdin?
> We need a build job to make it work. The build job is triggered when a
> commit merged into master.
> The build job does the following things:
> 1) upload the lastest contents (English markdown source files) from git to
> crowdin.
>     - If the source content is changed, the corresponding translation will
> lose and need re-translation.
> 2) download the translated contents
> 3) build website and publish
>
> But it seems that Crowdin doesn't fit well with Jekyll.
> Crowdin will break contents into multiple lines to translate according his
> syntax. This results to the layout broken.
> For example, the translated metric page is not rendered as expect:
> this is the original `metric.md`:
>
> https://user-images.githubusercontent.com/5378924/52795366-9a22f080-30ac-11e9-9cfd-4de82041aa77.png
> this is the file downloaded from crowdin:
>
> https://user-images.githubusercontent.com/5378924/52795379-9f803b00-30ac-11e9-9700-0a4077b5882d.png
> this is the page after rendered:
>
> https://user-images.githubusercontent.com/5378924/52795389-a5761c00-30ac-11e9-9821-35c705a8d65b.png
>
> So it seems that currently crowdin works less well when the markdown
> contains HTML and Liquid codes.
>
> # Conclusion (Docusaurus/crowdin or previous proposal)
> I'm leaning more towards the previous proposal [5]. Not only because
> crowdin works less well for Flink currently.
> But also it introduces much new things and tools to learn for contributors.
> Furthermore the previous proposed translate process works good when we
> experiment it in Flink website.
>
> What do you think?
>
> Regards,
> Jark
>
> [1]: https://docusaurus.io/en/
> [2]: https://crowdin.com/
> [3]: https://crowdin.com/project/apache-pulsar/zh-CN#
> [4]: https://crowdin.com/project/flink-test/zh-CN#
> [5]:
>
> https://docs.google.com/document/d/1R1-uDq-KawLB8afQYrczfcoQHjjIhq6tvUksxrfhBl0/edit#
>
>
> On Tue, 12 Feb 2019 at 23:48, Xingcan Cui <[hidden email]> wrote:
>
> > Hi,
> >
> > I agree with the proposal, Gordon and Jark, and I think it's a good
> > solution for major doc changes. We also created separated JIRAs for
> English
> > documentation in the past.
> >
> > For minor doc changes, I think it’s better to encourage Chinese-speaking
> > contributors to participate in the reviewing process and help translate
> the
> > few lines in sync.
> >
> > Best,
> > Xingcan
> >
> > > On Feb 12, 2019, at 7:04 AM, Jark Wu <[hidden email]> wrote:
> > >
> > > Hi @Sijie,
> > >
> > > Thank you for the valuable information. I will explore Docusaurus and
> > > feedback here.
> > >
> > > Best,
> > > Jark
> > >
> > > On Tue, 12 Feb 2019 at 18:18, Fabian Hueske <[hidden email]> wrote:
> > >
> > >> Hi everyone,
> > >>
> > >> +1 to what Gordon and Jark proposed.
> > >> We should make use of the review bot to ensure that new features are
> > >> documented at least in English.
> > >> If the Chinese docs are not updated, a Jira issue must be created.
> > >>
> > >> @Sijie, thank for the pointer to Docusaurus! IMO, this looks very
> > >> interesting and should be worth exploring.
> > >>
> > >> Thanks, Fabian
> > >>
> > >>
> > >>
> > >> Am Di., 12. Feb. 2019 um 09:06 Uhr schrieb Sijie Guo <
> [hidden email]
> > >:
> > >>
> > >>> Hi,
> > >>>
> > >>> Sorry for interrupting the thread. But this topic sounds interesting
> to
> > >> me.
> > >>> It might be worth for you guys checking out docusaurus
> > >>> https://docusaurus.io/docs/en/translation . Docusaurus is a
> > >> documentation
> > >>> framework open sourced by Facebook. It has handled versioning and
> > >>> localization (via crowdin) pretty good. Apache Pulsar is using it for
> > its
> > >>> website and documentation.
> > >>>
> > >>> - Sijie
> > >>>
> > >>> On Mon, Jan 28, 2019 at 7:59 PM Jark Wu <[hidden email]> 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
> > >>>>
> > >>>
> > >>
> >
> >
>

[Jark Wu-2]

Hi Fabian,

Yes, I think so.
We can find a way to move the translated content to crowdin to reuse the
translation effort if we want to migrate to Docusaurus in the future.

Regards,
Jark

On Fri, 15 Feb 2019 at 15:19, Fabian Hueske <[hidden email]> wrote:

> Hi Jark,
>
> Thanks so much for evaluating Docusaurus and Crowdin and writing up this
> report!
> It seems that staying with the current approach and avoiding the effort of
> porting the documentation is the best solution for now.
>
> We might want to reconsider Docusaurus if we want to restructure the
> documentation completely at some point.
>
> Thanks,
> Fabian
>
> Am Do., 14. Feb. 2019 um 16:41 Uhr schrieb Jark Wu <[hidden email]>:
>
> > Hi all,
> >
> > Qianjing Xu and I have been exploring Docusaurus and crowdin in recent
> days
> > to see how can Flink fit into them to support multi-language.
> >
> > Here is the summary from our side:
> > (we didn't learn deeply, so we may miss something or misunderstand.
> Please
> > correct us if we are wrong)
> >
> > # What is Docusaurus and crowdin ?
> > Docusaurus [1] is a documentation framework which supports document
> > versioning and localization (via crowdin). IMO, Docusaurus is something
> > similar to Jekyll.
> > Crowdin[2] is a localization management platform. Users can upload
> contents
> > (e.g. markdown source files) to crowdin and translate, collaborate,
> manage
> > process on crowdin.
> > The English contents is kept in the original repository, and the multiple
> > language translated contents is kept in crowdin. We need to download the
> > translated contents from crowdin and build them into localization
> website.
> > Apache Pulsar is using them for website and documentation as @Sijie
> > mentioned above.
> > Here is the Pulsar project on crowdin [3].
> > And here is a test project for Flink I created [4].
> >
> > # How can Flink fit into them?
> > I'm afraid that Flink is hard to fit into Docusaurus unless we rework our
> > website/docs from Jekyll to Docusaurus.
> >
> > How about Jekyll + Crowdin?
> > We need a build job to make it work. The build job is triggered when a
> > commit merged into master.
> > The build job does the following things:
> > 1) upload the lastest contents (English markdown source files) from git
> to
> > crowdin.
> >     - If the source content is changed, the corresponding translation
> will
> > lose and need re-translation.
> > 2) download the translated contents
> > 3) build website and publish
> >
> > But it seems that Crowdin doesn't fit well with Jekyll.
> > Crowdin will break contents into multiple lines to translate according
> his
> > syntax. This results to the layout broken.
> > For example, the translated metric page is not rendered as expect:
> > this is the original `metric.md`:
> >
> >
> https://user-images.githubusercontent.com/5378924/52795366-9a22f080-30ac-11e9-9cfd-4de82041aa77.png
> > this is the file downloaded from crowdin:
> >
> >
> https://user-images.githubusercontent.com/5378924/52795379-9f803b00-30ac-11e9-9700-0a4077b5882d.png
> > this is the page after rendered:
> >
> >
> https://user-images.githubusercontent.com/5378924/52795389-a5761c00-30ac-11e9-9821-35c705a8d65b.png
> >
> > So it seems that currently crowdin works less well when the markdown
> > contains HTML and Liquid codes.
> >
> > # Conclusion (Docusaurus/crowdin or previous proposal)
> > I'm leaning more towards the previous proposal [5]. Not only because
> > crowdin works less well for Flink currently.
> > But also it introduces much new things and tools to learn for
> contributors.
> > Furthermore the previous proposed translate process works good when we
> > experiment it in Flink website.
> >
> > What do you think?
> >
> > Regards,
> > Jark
> >
> > [1]: https://docusaurus.io/en/
> > [2]: https://crowdin.com/
> > [3]: https://crowdin.com/project/apache-pulsar/zh-CN#
> > [4]: https://crowdin.com/project/flink-test/zh-CN#
> > [5]:
> >
> >
> https://docs.google.com/document/d/1R1-uDq-KawLB8afQYrczfcoQHjjIhq6tvUksxrfhBl0/edit#
> >
> >
> > On Tue, 12 Feb 2019 at 23:48, Xingcan Cui <[hidden email]> wrote:
> >
> > > Hi,
> > >
> > > I agree with the proposal, Gordon and Jark, and I think it's a good
> > > solution for major doc changes. We also created separated JIRAs for
> > English
> > > documentation in the past.
> > >
> > > For minor doc changes, I think it’s better to encourage
> Chinese-speaking
> > > contributors to participate in the reviewing process and help translate
> > the
> > > few lines in sync.
> > >
> > > Best,
> > > Xingcan
> > >
> > > > On Feb 12, 2019, at 7:04 AM, Jark Wu <[hidden email]> wrote:
> > > >
> > > > Hi @Sijie,
> > > >
> > > > Thank you for the valuable information. I will explore Docusaurus and
> > > > feedback here.
> > > >
> > > > Best,
> > > > Jark
> > > >
> > > > On Tue, 12 Feb 2019 at 18:18, Fabian Hueske <[hidden email]>
> wrote:
> > > >
> > > >> Hi everyone,
> > > >>
> > > >> +1 to what Gordon and Jark proposed.
> > > >> We should make use of the review bot to ensure that new features are
> > > >> documented at least in English.
> > > >> If the Chinese docs are not updated, a Jira issue must be created.
> > > >>
> > > >> @Sijie, thank for the pointer to Docusaurus! IMO, this looks very
> > > >> interesting and should be worth exploring.
> > > >>
> > > >> Thanks, Fabian
> > > >>
> > > >>
> > > >>
> > > >> Am Di., 12. Feb. 2019 um 09:06 Uhr schrieb Sijie Guo <
> > [hidden email]
> > > >:
> > > >>
> > > >>> Hi,
> > > >>>
> > > >>> Sorry for interrupting the thread. But this topic sounds
> interesting
> > to
> > > >> me.
> > > >>> It might be worth for you guys checking out docusaurus
> > > >>> https://docusaurus.io/docs/en/translation . Docusaurus is a
> > > >> documentation
> > > >>> framework open sourced by Facebook. It has handled versioning and
> > > >>> localization (via crowdin) pretty good. Apache Pulsar is using it
> for
> > > its
> > > >>> website and documentation.
> > > >>>
> > > >>> - Sijie
> > > >>>
> > > >>> On Mon, Jan 28, 2019 at 7:59 PM Jark Wu <[hidden email]> 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
> > > >>>>
> > > >>>
> > > >>
> > >
> > >
> >
>