Hi Jincheng, I'm very excited to see the enthusiasm for documentation work but I am concerned about the communities long term ability to maintain this contribution. In particular, I'm concerned that this proposal duplicates a lot of content that will quickly get out of sync. So far the community does not have a great track record for maintaining documentation after its initial contribution.
In particular, I do not believe the following items need to be copied: DataTypes Built-in functions Connectors SQL Catalogs Configurations Another issue is that this proposal feels like it is documenting PyFlink separately from the rest of the project. Things like the cookbook and tutorial should be under the Try Flink section of the documentation. Seth On Mon, Aug 3, 2020 at 1:08 AM jincheng sun <sunjincheng...@gmail.com> wrote: > Would be great if you could join the contribution of PyFlink > documentation @Marta ! > Thanks for all of the positive feedback. I will start a formal vote then > later... > > Best, > Jincheng > > > Shuiqiang Chen <acqua....@gmail.com> 于2020年8月3日周一 上午9:56写道： > > > Hi jincheng, > > > > Thanks for the discussion. +1 for the FLIP. > > > > A well-organized documentation will greatly improve the efficiency and > > experience for developers. > > > > Best, > > Shuiqiang > > > > Hequn Cheng <he...@apache.org> 于2020年8月1日周六 上午8:42写道： > > > >> Hi Jincheng, > >> > >> Thanks a lot for raising the discussion. +1 for the FLIP. > >> > >> I think this will bring big benefits for the PyFlink users. Currently, > >> the Python TableAPI document is hidden deeply under the TableAPI&SQL tab > >> which makes it quite unreadable. Also, the PyFlink documentation is > mixed > >> with Java/Scala documentation. It is hard for users to have an overview > of > >> all the PyFlink documents. As more and more functionalities are added > into > >> PyFlink, I think it's time for us to refactor the document. > >> > >> Best, > >> Hequn > >> > >> > >> On Fri, Jul 31, 2020 at 3:43 PM Marta Paes Moreira <ma...@ververica.com > > > >> wrote: > >> > >>> Hi, Jincheng! > >>> > >>> Thanks for creating this detailed FLIP, it will make a big difference > in > >>> the experience of Python developers using Flink. I'm interested in > >>> contributing to this work, so I'll reach out to you offline! > >>> > >>> Also, thanks for sharing some information on the adoption of PyFlink, > >>> it's > >>> great to see that there are already production users. > >>> > >>> Marta > >>> > >>> On Fri, Jul 31, 2020 at 5:35 AM Xingbo Huang <hxbks...@gmail.com> > wrote: > >>> > >>> > Hi Jincheng, > >>> > > >>> > Thanks a lot for bringing up this discussion and the proposal. > >>> > > >>> > Big +1 for improving the structure of PyFlink doc. > >>> > > >>> > It will be very friendly to give PyFlink users a unified entrance to > >>> learn > >>> > PyFlink documents. > >>> > > >>> > Best, > >>> > Xingbo > >>> > > >>> > Dian Fu <dian0511...@gmail.com> 于2020年7月31日周五 上午11:00写道： > >>> > > >>> >> Hi Jincheng, > >>> >> > >>> >> Thanks a lot for bringing up this discussion and the proposal. +1 to > >>> >> improve the Python API doc. > >>> >> > >>> >> I have received many feedbacks from PyFlink beginners about > >>> >> the PyFlink doc, e.g. the materials are too few, the Python doc is > >>> mixed > >>> >> with the Java doc and it's not easy to find the docs he wants to > know. > >>> >> > >>> >> I think it would greatly improve the user experience if we can have > >>> one > >>> >> place which includes most knowledges PyFlink users should know. > >>> >> > >>> >> Regards, > >>> >> Dian > >>> >> > >>> >> 在 2020年7月31日，上午10:14，jincheng sun <sunjincheng...@gmail.com> 写道： > >>> >> > >>> >> Hi folks, > >>> >> > >>> >> Since the release of Flink 1.11, users of PyFlink have continued to > >>> grow. > >>> >> As far as I know there are many companies have used PyFlink for data > >>> >> analysis, operation and maintenance monitoring business has been put > >>> into > >>> >> production(Such as 聚美优品[1](Jumei), 浙江墨芷[2] (Mozhi) etc.). > According > >>> to > >>> >> the feedback we received, current documentation is not very friendly > >>> to > >>> >> PyFlink users. There are two shortcomings: > >>> >> > >>> >> - Python related content is mixed in the Java/Scala documentation, > >>> which > >>> >> makes it difficult for users who only focus on PyFlink to read. > >>> >> - There is already a "Python Table API" section in the Table API > >>> document > >>> >> to store PyFlink documents, but the number of articles is small and > >>> the > >>> >> content is fragmented. It is difficult for beginners to learn from > it. > >>> >> > >>> >> In addition, FLIP-130 introduced the Python DataStream API. Many > >>> >> documents will be added for those new APIs. In order to increase the > >>> >> readability and maintainability of the PyFlink document, Wei Zhong > >>> and me > >>> >> have discussed offline and would like to rework it via this FLIP. > >>> >> > >>> >> We will rework the document around the following three objectives: > >>> >> > >>> >> - Add a separate section for Python API under the "Application > >>> >> Development" section. > >>> >> - Restructure current Python documentation to a brand new structure > to > >>> >> ensure complete content and friendly to beginners. > >>> >> - Improve the documents shared by Python/Java/Scala to make it more > >>> >> friendly to Python users and without affecting Java/Scala users. > >>> >> > >>> >> More detail can be found in the FLIP-133: > >>> >> > >>> > https://cwiki.apache.org/confluence/display/FLINK/FLIP-133%3A+Rework+PyFlink+Documentation > >>> >> > >>> >> Best, > >>> >> Jincheng > >>> >> > >>> >> [1] https://mp.weixin.qq.com/s/zVsBIs1ZEFe4atYUYtZpRg > >>> >> [2] https://mp.weixin.qq.com/s/R4p_a2TWGpESBWr3pLtM2g > >>> >> > >>> >> > >>> >> > >>> > >> >
