[FLINK-28140] Improve the documentation by adding Python examples

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.16.0, 1.15.2
• Component/s: API / Python, Documentation
• Labels: pull-request-available
• Assignee: pengmd
• Reporter: Dian Fu
• Created: 20/Jun/22 12:34
• Updated: 30/Jul/22 06:44
• Resolved: 30/Jul/22 06:44

Description

There are still quite a few documentations only having Java/Scala examples. The aim of this JIRA is to improve these kinds of documentation by adding Python examples.

Here is a list of documentations needed to improve:

• https://nightlies.apache.org/flink/flink-docs-master/docs/dev/table/common/
• Done https://nightlies.apache.org/flink/flink-docs-master/docs/dev/table/data_stream_api/
• https://nightlies.apache.org/flink/flink-docs-master/docs/dev/table/concepts/time_attributes/
• https://nightlies.apache.org/flink/flink-docs-master/docs/dev/table/concepts/temporal_table_function/
• Done https://nightlies.apache.org/flink/flink-docs-master/docs/dev/table/timezone/
• Done https://nightlies.apache.org/flink/flink-docs-master/docs/dev/table/tableapi/
• https://nightlies.apache.org/flink/flink-docs-master/docs/dev/table/modules/
• Done https://nightlies.apache.org/flink/flink-docs-master/docs/dev/datastream/event-time/generating_watermarks/
• https://nightlies.apache.org/flink/flink-docs-master/docs/dev/datastream/sources/
• https://nightlies.apache.org/flink/flink-docs-master/docs/dev/datastream/application_parameters/
• Done https://nightlies.apache.org/flink/flink-docs-master/docs/dev/datastream/execution/execution_configuration/
• Done https://nightlies.apache.org/flink/flink-docs-master/docs/dev/datastream/execution/parallel/
• Done https://nightlies.apache.org/flink/flink-docs-master/docs/ops/state/state_backends/
• Done https://nightlies.apache.org/flink/flink-docs-master/docs/ops/state/task_failure_recovery/
• https://nightlies.apache.org/flink/flink-docs-master/docs/ops/metrics/
• https://nightlies.apache.org/flink/flink-docs-master/docs/connectors/datastream/formats/
• https://nightlies.apache.org/flink/flink-docs-master/docs/connectors/datastream/kafka/
• https://nightlies.apache.org/flink/flink-docs-master/docs/connectors/datastream/rabbitmq/
• https://nightlies.apache.org/flink/flink-docs-master/docs/connectors/datastream/jdbc/

Note: we could improve these documentation in separate PRs to ease contribute and review~

Issue Links

• links to: GitHub Pull Request #20121
• links to: GitHub Pull Request #20194
• links to: GitHub Pull Request #20290
• links to: GitHub Pull Request #20385