Uploaded image for project: 'Flink'
  1. Flink
  2. FLINK-18775

Rework PyFlink Documentation

    XMLWordPrintableJSON

    Details

      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

        Attachments

          Issue Links

          1.
          Create the new document structure for Python documentation according to FLIP-133 Sub-task Closed Wei Zhong
          2.
          Add a "Environment Setup" section to the "Installation" document Sub-task Closed Huang Xingbo
          3.
          Add a Table API tutorial link(linked to try-flink/python_table_api.md) under the "Python API" -> "GettingStart" -> "Tutorial" section Sub-task Closed Hequn Cheng
          4.
          Add a "10 minutes to Table API" document under the "Python API" -> "User Guide" -> "Table API" section Sub-task Closed Wei Zhong
          5.
          Add a "TableEnvironment" document under the "Python API" -> "User Guide" -> "Table API" section Sub-task Closed Wei Zhong
          6.
          Add a "Operations" link(linked to dev/table/tableApi.md) under the "Python API" -> "User Guide" -> "Table API" section Sub-task Closed Dian Fu
          7.
          Add a "Built-in Functions" link (linked to dev/table/functions/systemFunctions.md) under the "Python API" -> "User Guide" -> "Table API" section Sub-task Closed Wei Zhong
          8.
          Add a "Connectors" document under the "Python API" -> "User Guide" -> "Table API" section Sub-task Closed Hequn Cheng
          9.
          Add a "SQL" link (linked to dev/table/sql/index.md) under the "Python API" -> "User Guide" -> "Table API" section Sub-task Closed Huang Xingbo
          10.
          Add a "Catalogs" link (linked to dev/table/catalogs.md) under the "Python API" -> "User Guide" -> "Table API" section Sub-task Closed Dian Fu
          11.
          Add a "CEP" document under the "Python API" -> "User Guide" -> "Table API" section Sub-task Closed Unassigned
          12.
          Add a "Environment Variables" document under the "Python API" -> "User Guide" -> "Table API" section Sub-task Closed Wei Zhong
          13.
          Add a "Debugging" document under the "Python API" -> "User Guide" -> "Table API" section Sub-task Resolved Huang Xingbo
          14.
          Add a "API Docs" link (linked to the generated sphinx docs) under the "Python API" section Sub-task Closed Unassigned
          15.
          Add a "Overview" document under the "Python API" section Sub-task Closed Wei Zhong
          16.
          Flatten current PyFlink documentation structure Sub-task Closed Wei Zhong
          17.
          Add documentation about how to use Python UDF in the Java Table API Sub-task Closed Wei Zhong

            Activity

              People

              • Assignee:
                zhongwei Wei Zhong
                Reporter:
                sunjincheng121 sunjincheng
              • Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: