[FLINK-18775] Rework PyFlink Documentation

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.11.0, 1.11.1
• Fix Version/s: 1.12.0
• Component/s: API / Python, Documentation
• Labels: beginner
• Assignee: Wei Zhong
• Reporter: sunjincheng
• Created: 31/Jul/20 01:10
• Updated: 17/Dec/20 05:43
• Resolved: 17/Dec/20 05:42

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:

1. Python related content is mixed in the Java/Scala documentation, which makes it difficult for users who only focus on PyFlink to read.
2. 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, we would like to rework it via this umbrella JIRA.

 

The detail can be found in FLIP-133

Issue Links

• mentioned in: Page Loading...

Sub-Tasks

• Create the new document structure for Python documentation according to FLIP-133: Closed
• Add a "Environment Setup" section to the "Installation" document: Closed
• Add a Table API tutorial link(linked to try-flink/python_table_api.md) under the "Python API" -> "GettingStart" -> "Tutorial" section: Closed
• Add a "10 minutes to Table API" document under the "Python API" -> "User Guide" -> "Table API" section: Closed
• Add a "TableEnvironment" document under the "Python API" -> "User Guide" -> "Table API" section: Closed
• Add a "Operations" link(linked to dev/table/tableApi.md) under the "Python API" -> "User Guide" -> "Table API" section: Closed
• Add a "Built-in Functions" link (linked to dev/table/functions/systemFunctions.md) under the "Python API" -> "User Guide" -> "Table API" section: Closed
• Add a "Connectors" document under the "Python API" -> "User Guide" -> "Table API" section: Closed
• Add a "SQL" link (linked to dev/table/sql/index.md) under the "Python API" -> "User Guide" -> "Table API" section: Closed
• Add a "Catalogs" link (linked to dev/table/catalogs.md) under the "Python API" -> "User Guide" -> "Table API" section: Closed
• Add a "CEP" document under the "Python API" -> "User Guide" -> "Table API" section: Closed
• Add a "Environment Variables" document under the "Python API" -> "User Guide" -> "Table API" section: Closed
• Add a "Debugging" document under the "Python API" -> "User Guide" -> "Table API" section: Resolved
• Add a "API Docs" link (linked to the generated sphinx docs) under the "Python API" section: Closed
• Add a "Overview" document under the "Python API" section: Closed
• Flatten current PyFlink documentation structure: Closed
• Add documentation about how to use Python UDF in the Java Table API: Closed