[DISCUSS] Contributing Chinese website and docs to Apache Flink

classic Classic list List threaded Threaded
40 messages Options
12
Reply | Threaded
Open this post in threaded view
|

[DISCUSS] Contributing Chinese website and docs to Apache Flink

Jark Wu-2
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
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

Fabian Hueske-2
Hi Jark,

Thank you for starting this discussion!
I'm very happy about the various efforts to support the Chinese Flink
community.
Offering a translated website and documentation gives Flink a lot more
reach and will help many users.

I think integrating the website and documentation as subdirectories into
the existing website and docs is a very good approach.
Regarding the name, does it make sense to keep the URLs in sync with the
newly created mailing list ([hidden email]), i.e.,
https://flink.apache.org/zh/ <https://flink.apache.org/cn/> etc?

I think integrating the translated website/documentation into Apache
Flink's repositories might also help to grow the number of Chinese non-code
contributors.
Translating resources is IMO a great way to contribute without writing
source code.

I'm very much looking forward to this.

Best, Fabian

Am Mo., 28. Jan. 2019 um 12:59 Uhr schrieb Jark Wu <[hidden email]>:

> 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
>
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

Yun Tang
Hi Jark

It would be a great idea to contribute the Flink Chinese community website, which is quite popular among Chinese developers, back to Apache Flink. I think it could attract more Chinese users and developers.

Alluxio, a distributed storage system, also maintain an official Chinese version document under their open source repo (https://github.com/Alluxio/alluxio/tree/master/docs/cn) from 2016. However, it would be a bit tricky to review Chinese documentation related PR since not every one could read/write Chinese, not to mention some state-of-the-art English computer science vocabularies still have no well-accepted Chinese translations. In a nutshell, I think an official Chinese document is really a good idea, but we need to drive this more carefully.
[https://avatars1.githubusercontent.com/u/16203694?s=400&v=4]<https://github.com/Alluxio/alluxio/tree/master/docs/cn>

alluxio/docs/cn at master · Alluxio/alluxio · GitHub<https://github.com/Alluxio/alluxio/tree/master/docs/cn>
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
github.com

Best
Yun Tang
________________________________
From: Fabian Hueske <[hidden email]>
Sent: Monday, January 28, 2019 21:48
To: dev
Subject: Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

Hi Jark,

Thank you for starting this discussion!
I'm very happy about the various efforts to support the Chinese Flink
community.
Offering a translated website and documentation gives Flink a lot more
reach and will help many users.

I think integrating the website and documentation as subdirectories into
the existing website and docs is a very good approach.
Regarding the name, does it make sense to keep the URLs in sync with the
newly created mailing list ([hidden email]), i.e.,
https://flink.apache.org/zh/ <https://flink.apache.org/cn/> etc?

I think integrating the translated website/documentation into Apache
Flink's repositories might also help to grow the number of Chinese non-code
contributors.
Translating resources is IMO a great way to contribute without writing
source code.

I'm very much looking forward to this.

Best, Fabian

Am Mo., 28. Jan. 2019 um 12:59 Uhr schrieb Jark Wu <[hidden email]>:

> 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
>
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

qianjin xu
That's good. I want to be involved.
best
qianjin

Yun Tang <[hidden email]> 于2019年1月29日周二 上午1:00写道:

> Hi Jark
>
> It would be a great idea to contribute the Flink Chinese community
> website, which is quite popular among Chinese developers, back to Apache
> Flink. I think it could attract more Chinese users and developers.
>
> Alluxio, a distributed storage system, also maintain an official Chinese
> version document under their open source repo (
> https://github.com/Alluxio/alluxio/tree/master/docs/cn) from 2016.
> However, it would be a bit tricky to review Chinese documentation related
> PR since not every one could read/write Chinese, not to mention some
> state-of-the-art English computer science vocabularies still have no
> well-accepted Chinese translations. In a nutshell, I think an official
> Chinese document is really a good idea, but we need to drive this more
> carefully.
> [https://avatars1.githubusercontent.com/u/16203694?s=400&v=4]<
> https://github.com/Alluxio/alluxio/tree/master/docs/cn>
>
> alluxio/docs/cn at master · Alluxio/alluxio · GitHub<
> https://github.com/Alluxio/alluxio/tree/master/docs/cn>
> You signed in with another tab or window. Reload to refresh your session.
> You signed out in another tab or window. Reload to refresh your session.
> github.com
>
> Best
> Yun Tang
> ________________________________
> From: Fabian Hueske <[hidden email]>
> Sent: Monday, January 28, 2019 21:48
> To: dev
> Subject: Re: [DISCUSS] Contributing Chinese website and docs to Apache
> Flink
>
> Hi Jark,
>
> Thank you for starting this discussion!
> I'm very happy about the various efforts to support the Chinese Flink
> community.
> Offering a translated website and documentation gives Flink a lot more
> reach and will help many users.
>
> I think integrating the website and documentation as subdirectories into
> the existing website and docs is a very good approach.
> Regarding the name, does it make sense to keep the URLs in sync with the
> newly created mailing list ([hidden email]), i.e.,
> https://flink.apache.org/zh/ <https://flink.apache.org/cn/> etc?
>
> I think integrating the translated website/documentation into Apache
> Flink's repositories might also help to grow the number of Chinese non-code
> contributors.
> Translating resources is IMO a great way to contribute without writing
> source code.
>
> I'm very much looking forward to this.
>
> Best, Fabian
>
> Am Mo., 28. Jan. 2019 um 12:59 Uhr schrieb Jark Wu <[hidden email]>:
>
> > 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
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

Congxian Qiu
Hi Jark,

Thank you for starting this discussion!

I think it's great to have an official Chinese doc website, there are so
many Chinese developers can benefit from it.  Also, we should think
carefully for the long term maintain the Chinese docs, how to make sure the
docs are the latest and accurate is also important.

Best,
Congxian


qianjin xu <[hidden email]> 于2019年1月29日周二 上午10:27写道:

> That's good. I want to be involved.
> best
> qianjin
>
> Yun Tang <[hidden email]> 于2019年1月29日周二 上午1:00写道:
>
> > Hi Jark
> >
> > It would be a great idea to contribute the Flink Chinese community
> > website, which is quite popular among Chinese developers, back to Apache
> > Flink. I think it could attract more Chinese users and developers.
> >
> > Alluxio, a distributed storage system, also maintain an official Chinese
> > version document under their open source repo (
> > https://github.com/Alluxio/alluxio/tree/master/docs/cn) from 2016.
> > However, it would be a bit tricky to review Chinese documentation related
> > PR since not every one could read/write Chinese, not to mention some
> > state-of-the-art English computer science vocabularies still have no
> > well-accepted Chinese translations. In a nutshell, I think an official
> > Chinese document is really a good idea, but we need to drive this more
> > carefully.
> > [https://avatars1.githubusercontent.com/u/16203694?s=400&v=4]<
> > https://github.com/Alluxio/alluxio/tree/master/docs/cn>
> >
> > alluxio/docs/cn at master · Alluxio/alluxio · GitHub<
> > https://github.com/Alluxio/alluxio/tree/master/docs/cn>
> > You signed in with another tab or window. Reload to refresh your session.
> > You signed out in another tab or window. Reload to refresh your session.
> > github.com
> >
> > Best
> > Yun Tang
> > ________________________________
> > From: Fabian Hueske <[hidden email]>
> > Sent: Monday, January 28, 2019 21:48
> > To: dev
> > Subject: Re: [DISCUSS] Contributing Chinese website and docs to Apache
> > Flink
> >
> > Hi Jark,
> >
> > Thank you for starting this discussion!
> > I'm very happy about the various efforts to support the Chinese Flink
> > community.
> > Offering a translated website and documentation gives Flink a lot more
> > reach and will help many users.
> >
> > I think integrating the website and documentation as subdirectories into
> > the existing website and docs is a very good approach.
> > Regarding the name, does it make sense to keep the URLs in sync with the
> > newly created mailing list ([hidden email]), i.e.,
> > https://flink.apache.org/zh/ <https://flink.apache.org/cn/> etc?
> >
> > I think integrating the translated website/documentation into Apache
> > Flink's repositories might also help to grow the number of Chinese
> non-code
> > contributors.
> > Translating resources is IMO a great way to contribute without writing
> > source code.
> >
> > I'm very much looking forward to this.
> >
> > Best, Fabian
> >
> > Am Mo., 28. Jan. 2019 um 12:59 Uhr schrieb Jark Wu <[hidden email]>:
> >
> > > 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
> > >
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

jincheng sun
In reply to this post by Fabian Hueske-2
Thanks Jark starting this discussion!

Hi Fabian, very glad to hear that you like this proposal.
As far as I know, `zh` is the language, `cn` is the territory, such as:
`zh-cn` representative
Simplified Chinese (China) ,  `zh-tw` representative Traditional Chinese
(Taiwan), So i like the naming the mailing list and website as follows:

maillist: [hidden email]
website: https://flink.apache.org/zh/

BTW:
I completely agree with translating resources is a great way to contribute
without writing source code.
Welcome and thank every contributors to the translation resources!

Best, Jincheng

Fabian Hueske <[hidden email]> 于2019年1月28日周一 下午9:49写道:

> Hi Jark,
>
> Thank you for starting this discussion!
> I'm very happy about the various efforts to support the Chinese Flink
> community.
> Offering a translated website and documentation gives Flink a lot more
> reach and will help many users.
>
> I think integrating the website and documentation as subdirectories into
> the existing website and docs is a very good approach.
> Regarding the name, does it make sense to keep the URLs in sync with the
> newly created mailing list ([hidden email]), i.e.,
> https://flink.apache.org/zh/ <https://flink.apache.org/cn/> etc?
>
> I think integrating the translated website/documentation into Apache
> Flink's repositories might also help to grow the number of Chinese non-code
> contributors.
> Translating resources is IMO a great way to contribute without writing
> source code.
>
> I'm very much looking forward to this.
>
> Best, Fabian
>
> Am Mo., 28. Jan. 2019 um 12:59 Uhr schrieb Jark Wu <[hidden email]>:
>
> > 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
> >
>
JMX
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

JMX
In reply to this post by Jark Wu-2
Hi Jark,
    I am glad to see your exciting email about contributing to Flink Chinese
Community. Remebering the days to solve outstanding issues in Spark
Officical Documents, the project was developped slowly, I am looking forward
to more and more contributions to Flink Chinese Community. Of course, I am
glad to join in the activities. I hope that we could help more and more
Chinese developers to develop their projects more and more quickly and
smoothly by Flink. It is a very meaningful thing!

Best,
Hunk



--
Sent from: http://apache-flink-mailing-list-archive.1008284.n3.nabble.com/
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

fudian.fd
In reply to this post by jincheng sun
Hi Jark,

Thanks a lot for starting the discussion! It would be great to have an official Flink Chinese doc.  For the long term maintaining problem, I think creating a JIRA when the English documentation is updated is a good idea. Should we add one item such as "Does this pull request updated the documentation? If yes, is the Chinese documentation is updated?" in the pull-request-template to remind the contributors to create the JIRA if Chinese documentation should be updated?

Regards,
Dian

> 在 2019年1月29日,上午11:13,jincheng sun <[hidden email]> 写道:
>
> Thanks Jark starting this discussion!
>
> Hi Fabian, very glad to hear that you like this proposal.
> As far as I know, `zh` is the language, `cn` is the territory, such as:
> `zh-cn` representative
> Simplified Chinese (China) ,  `zh-tw` representative Traditional Chinese
> (Taiwan), So i like the naming the mailing list and website as follows:
>
> maillist: [hidden email]
> website: https://flink.apache.org/zh/
>
> BTW:
> I completely agree with translating resources is a great way to contribute
> without writing source code.
> Welcome and thank every contributors to the translation resources!
>
> Best, Jincheng
>
> Fabian Hueske <[hidden email]> 于2019年1月28日周一 下午9:49写道:
>
>> Hi Jark,
>>
>> Thank you for starting this discussion!
>> I'm very happy about the various efforts to support the Chinese Flink
>> community.
>> Offering a translated website and documentation gives Flink a lot more
>> reach and will help many users.
>>
>> I think integrating the website and documentation as subdirectories into
>> the existing website and docs is a very good approach.
>> Regarding the name, does it make sense to keep the URLs in sync with the
>> newly created mailing list ([hidden email]), i.e.,
>> https://flink.apache.org/zh/ <https://flink.apache.org/cn/> etc?
>>
>> I think integrating the translated website/documentation into Apache
>> Flink's repositories might also help to grow the number of Chinese non-code
>> contributors.
>> Translating resources is IMO a great way to contribute without writing
>> source code.
>>
>> I'm very much looking forward to this.
>>
>> Best, Fabian
>>
>> Am Mo., 28. Jan. 2019 um 12:59 Uhr schrieb Jark Wu <[hidden email]>:
>>
>>> 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
>>>
>>


smime.p7s (3K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

SteNicholas
In reply to this post by Jark Wu-2
Hi Jark,

Thank you for starting this discussion.I am very willing to participate in
flink document translation.

Best,
Nicholas




--
Sent from: http://apache-flink-mailing-list-archive.1008284.n3.nabble.com/
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

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.

> Am 29.01.2019 um 06:35 schrieb SteNicholas <[hidden email]>:
>
> Hi Jark,
>
> Thank you for starting this discussion.I am very willing to participate in
> flink document translation.
>
> Best,
> Nicholas
>
>
>
>
> --
> Sent from: http://apache-flink-mailing-list-archive.1008284.n3.nabble.com/
Reply | Threaded
Open this post in threaded view
|

回复: [DISCUSS] Contributing Chinese website and docs to Apache Flink

蜗牛
In reply to this post by fudian.fd
Hi Jark,
Thanks for starting the discussion!


I think integrating the website and documentation as subdirectories into
the existing website and docs is a very good approach too.


And when submitting a pull request, we should notice the author whether they changed the documents, If yes, should create a jira for the Chinese documents.


------------------ 原始邮件 ------------------
发件人: "fudian.fd"<[hidden email]>;
发送时间: 2019年1月29日(星期二) 中午1:30
收件人: "dev"<[hidden email]>;

主题: Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink



Hi Jark,

Thanks a lot for starting the discussion! It would be great to have an official Flink Chinese doc.  For the long term maintaining problem, I think creating a JIRA when the English documentation is updated is a good idea. Should we add one item such as "Does this pull request updated the documentation? If yes, is the Chinese documentation is updated?" in the pull-request-template to remind the contributors to create the JIRA if Chinese documentation should be updated?

Regards,
Dian

> 在 2019年1月29日,上午11:13,jincheng sun <[hidden email]> 写道:
>
> Thanks Jark starting this discussion!
>
> Hi Fabian, very glad to hear that you like this proposal.
> As far as I know, `zh` is the language, `cn` is the territory, such as:
> `zh-cn` representative
> Simplified Chinese (China) ,  `zh-tw` representative Traditional Chinese
> (Taiwan), So i like the naming the mailing list and website as follows:
>
> maillist: [hidden email]
> website: https://flink.apache.org/zh/
>
> BTW:
> I completely agree with translating resources is a great way to contribute
> without writing source code.
> Welcome and thank every contributors to the translation resources!
>
> Best, Jincheng
>
> Fabian Hueske <[hidden email]> 于2019年1月28日周一 下午9:49写道:
>
>> Hi Jark,
>>
>> Thank you for starting this discussion!
>> I'm very happy about the various efforts to support the Chinese Flink
>> community.
>> Offering a translated website and documentation gives Flink a lot more
>> reach and will help many users.
>>
>> I think integrating the website and documentation as subdirectories into
>> the existing website and docs is a very good approach.
>> Regarding the name, does it make sense to keep the URLs in sync with the
>> newly created mailing list ([hidden email]), i.e.,
>> https://flink.apache.org/zh/ <https://flink.apache.org/cn/> etc?
>>
>> I think integrating the translated website/documentation into Apache
>> Flink's repositories might also help to grow the number of Chinese non-code
>> contributors.
>> Translating resources is IMO a great way to contribute without writing
>> source code.
>>
>> I'm very much looking forward to this.
>>
>> Best, Fabian
>>
>> Am Mo., 28. Jan. 2019 um 12:59 Uhr schrieb Jark Wu <[hidden email]>:
>>
>>> 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
>>>
>>
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

Chesnay Schepler-3
In reply to this post by Jark Wu-2
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
>

Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

Jark Wu-2
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
> >
>
>
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

Fabian Hueske-2
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
> > >
> >
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

Tzu-Li (Gordon) Tai
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
> > > >
> > >
> > >
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

Jark Wu-2
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
> > > > >
> > > >
> > > >
> > >
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

Robert Metzger
Hey Jark,

Happy New Year :)

thanks a lot for the proposal and the prototype. I fully agree with your
proposal and I think it's good to go!

Regarding the review-bot: We can add another item for documentation in both
English and Chinese, once the framework for the Flink docs has been merged.


On Mon, Feb 4, 2019 at 6:12 AM 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
>> > > > >
>> > > >
>> > > >
>> > >
>> >
>>
>
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

Till Rohrmann
+1 for the proposal.

Cheers,
Till

On Mon, Feb 4, 2019 at 9:50 AM Robert Metzger <[hidden email]> wrote:

> Hey Jark,
>
> Happy New Year :)
>
> thanks a lot for the proposal and the prototype. I fully agree with your
> proposal and I think it's good to go!
>
> Regarding the review-bot: We can add another item for documentation in both
> English and Chinese, once the framework for the Flink docs has been merged.
>
>
> On Mon, Feb 4, 2019 at 6:12 AM 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
> >> > > > >
> >> > > >
> >> > > >
> >> > >
> >> >
> >>
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

jincheng sun
In reply to this post by Jark Wu-2
+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
> > > > > >
> > > > >
> > > > >
> > > >
> > >
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: [DISCUSS] Contributing Chinese website and docs to Apache Flink

Fabian Hueske-2
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
>> > > > > >
>> > > > >
>> > > > >
>> > > >
>> > >
>> >
>>
>
12