[
https://issues.apache.org/jira/browse/FLINK-18775?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
sunjincheng updated FLINK-18775:
--------------------------------
Description:
Since the release of Flink 1.11, users of PyFlink have continued to grow.
According to the feedback we received, current Flink 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|https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=158866298]
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, we would like to rework it via this umbrella JIRA.
The detail can be found in
[FLIP-133|https://cwiki.apache.org/confluence/display/FLINK/FLIP-133%3A+Rework+PyFlink+Documentation]
was:
Since the release of Flink 1.11, users of PyFlink have continued to grow.
According to the feedback we received, current Flink 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|https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=158866298]
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, we would like to rework it via this umbrella JIRA.
The detail can be found in
[FLIP-133|[https://cwiki.apache.org/confluence/display/FLINK/FLIP-133%3A+Rework+PyFlink+Documentation]]
> Rework PyFlink Documentation
> ----------------------------
>
> Key: FLINK-18775
> URL: https://issues.apache.org/jira/browse/FLINK-18775
> Project: Flink
> Issue Type: Improvement
> Components: API / Python, Documentation
> Affects Versions: 1.11.0, 1.11.1
> Reporter: sunjincheng
> Assignee: sunjincheng
> Priority: Major
> Labels: beginner
> Fix For: 1.11.0, 1.12.0, 1.11.1, 1.11.2
>
>
> Since the release of Flink 1.11, users of PyFlink have continued to grow.
> According to the feedback we received, current Flink 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|https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=158866298]
> 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, we would like to rework it via this umbrella JIRA.
>
> The detail can be found in
> [FLIP-133|https://cwiki.apache.org/confluence/display/FLINK/FLIP-133%3A+Rework+PyFlink+Documentation]
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
