You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@flink.apache.org by "Weijie Guo (Jira)" <ji...@apache.org> on 2024/06/24 04:32:00 UTC

[jira] [Created] (FLINK-35678) CLONE - Review and update documentation

Weijie Guo created FLINK-35678:
----------------------------------

             Summary: CLONE - Review and update documentation
                 Key: FLINK-35678
                 URL: https://issues.apache.org/jira/browse/FLINK-35678
             Project: Flink
          Issue Type: Sub-task
    Affects Versions: 1.19.0
            Reporter: Weijie Guo
             Fix For: 1.19.0


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]
 * ...

 
----
h3. Expectations
 * Update upgrade compatibility table ([apache-flink:./docs/content/docs/ops/upgrading.md|https://github.com/apache/flink/blob/master/docs/content/docs/ops/upgrading.md#compatibility-table] and [apache-flink:./docs/content.zh/docs/ops/upgrading.md|https://github.com/apache/flink/blob/master/docs/content.zh/docs/ops/upgrading.md#compatibility-table]).
 * Update [Release Overview in Confluence|https://cwiki.apache.org/confluence/display/FLINK/Release+Management+and+Feature+Plan]
 * (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|https://github.com/apache/flink/actions/workflows/docs.yml] 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{}}}.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)