[FLINK-34278] Review and update documentation

• Type: Sub-task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.19.0
• Fix Version/s: 1.19.0
• Labels: pull-request-available
• Assignee: Unassigned
• Reporter: lincoln lee
• Created: 30/Jan/24 09:48
• Updated: 18/Mar/24 07:26
• Resolved: 18/Mar/24 07:26

Description

There are a few pages in the documentation that need to be reviewed and updated for each release.

• Ensure that there exists a release notes page for each non-bugfix release (e.g., 1.5.0) in ./docs/release-notes/, that it is up-to-date, and linked from the start page of the documentation.
• Upgrading Applications and Flink Versions: https://ci.apache.org/projects/flink/flink-docs-master/ops/upgrading.html
• ...

 

---

Expectations

• Update upgrade compatibility table (apache-flink:./docs/content/docs/ops/upgrading.md and apache-flink:./docs/content.zh/docs/ops/upgrading.md).
• Update Release Overview in Confluence
• (minor only) The documentation for the new major release is visible under https://nightlies.apache.org/flink/flink-docs-release-$SHORT_RELEASE_VERSION (after at least one doc build succeeded).
• (minor only) The documentation for the new major release does not contain "-SNAPSHOT" in its version title, and all links refer to the corresponding version docs instead of master.