Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In JIRA, inside version management, hover over the current release and a settings menu will appear. Click Release, and select today’s date.

Update and properly integrate the connector documentation in the Flink documentation

  1. Make sure that in the correct Flink release branch (e.g. release-1.19, release-1.18 etc) in https://github.com/apache/flink/blob/master/docs/setup_docs.sh#L45-L57 there's a line that shows:

    Code Block
    integrate_connector_docs yourConnectorRepoName yourReleasedConnectorBranch

    When the documentation is being build, it will also download the documentation from the connector repository from the specified branch, so that it will be integrated into the Flink documentation

  2. Make sure that the file in docs/data/yourConnector.yml is been updated properly (correct connector version, correct compatibility with Flink major.minor version, potential SQL variants). See https://github.com/apache/flink-connector-kafka/blob/v3.0/docs/data/kafka.yml as an example. This file is being used to determine if the Flink documentation is requested for a released Flink version, if it should display the download link for your connector (because it was released/available) or not (e.g. it's not available yet for that Flink version)

Update the nightly builds

Update .github/workflows/weekly.yml in the main  branch for the connector repository to make sure that:

...