Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: 1.3.0
    • Fix Version/s: 1.3.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      Umbrella issue to track required updates to the documentation for the 1.3 release.

        Issue Links

          Activity

          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

          https://github.com/apache/flink/pull/4211

          Show
          githubbot ASF GitHub Bot added a comment - Github user asfgit closed the pull request at: https://github.com/apache/flink/pull/4211
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user tzulitai commented on the issue:

          https://github.com/apache/flink/pull/4211

          Merging ...

          Show
          githubbot ASF GitHub Bot added a comment - Github user tzulitai commented on the issue: https://github.com/apache/flink/pull/4211 Merging ...
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user tzulitai commented on the issue:

          https://github.com/apache/flink/pull/4211

          Thanks for the reviews. I'll comment out the TBA sections before merging this.
          I'll leave this PR open for another ~1 day, and then merge it if there are no other objections.

          Show
          githubbot ASF GitHub Bot added a comment - Github user tzulitai commented on the issue: https://github.com/apache/flink/pull/4211 Thanks for the reviews. I'll comment out the TBA sections before merging this. I'll leave this PR open for another ~1 day, and then merge it if there are no other objections.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user aljoscha commented on the issue:

          https://github.com/apache/flink/pull/4211

          +1

          The changes in the parts that I know about look good.

          The TBA sections have to go before pushing, I think.

          Show
          githubbot ASF GitHub Bot added a comment - Github user aljoscha commented on the issue: https://github.com/apache/flink/pull/4211 +1 The changes in the parts that I know about look good. The TBA sections have to go before pushing, I think.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user rmetzger commented on a diff in the pull request:

          https://github.com/apache/flink/pull/4211#discussion_r124589466

          — Diff: docs/dev/migration.md —
          @@ -25,6 +25,62 @@ under the License.

          • This will be replaced by the TOC
            {:toc}

          +## Migrating from Flink 1.2 to Flink 1.3
          +
          +There are a few APIs that have been changed since Flink 1.2. Most of the changes are documented in their
          +specific documentations. The following is a consolidated list of API changes and links to details for migration when
          +upgrading to Flink 1.3.
          +
          +### `TypeSerializer` interface changes
          +
          +This would be relevant mostly for users implementing custom `TypeSerializer`s for their state.
          +
          +Since Flink 1.3, two additional methods have been added that are related to serializer compatibility
          +across savepoint restores. Please see
          +[Handling serializer upgrades and compatibility](../stream/state.html#handling-serializer-upgrades-and-compatibility)
          +for further details on how to implement these methods.
          +
          +### `ProcessFunction` is always a `RichFunction`
          +
          +In Flink 1.2, `ProcessFunction` and its rich variant `RichProcessFunction` was introduced.
          +Since Flink 1.3, `RichProcessFunction` was removed and `ProcessFunction` is now always a `RichFunction` with access to
          +the lifecycle methods and runtime context.
          +
          +### Flink CEP library API changes
          +
          +The CEP library in Flink 1.3 ships with a number of new features which have led to some changes in the API.
          +Please visit the [CEP Migration docs](../libs/cep.html#migrating-from-an-older-flink-version) for details.
          +
          +### Table API Changes
          +
          +TBA
          +
          +### Queryable State client construction changes
          +
          +TBA
          — End diff –

          I don't think these TBA sections are a good idea in the documentation.

          Maybe we should comment them out before committing them, so that they don't show up in the page

          Show
          githubbot ASF GitHub Bot added a comment - Github user rmetzger commented on a diff in the pull request: https://github.com/apache/flink/pull/4211#discussion_r124589466 — Diff: docs/dev/migration.md — @@ -25,6 +25,62 @@ under the License. This will be replaced by the TOC {:toc} +## Migrating from Flink 1.2 to Flink 1.3 + +There are a few APIs that have been changed since Flink 1.2. Most of the changes are documented in their +specific documentations. The following is a consolidated list of API changes and links to details for migration when +upgrading to Flink 1.3. + +### `TypeSerializer` interface changes + +This would be relevant mostly for users implementing custom `TypeSerializer`s for their state. + +Since Flink 1.3, two additional methods have been added that are related to serializer compatibility +across savepoint restores. Please see + [Handling serializer upgrades and compatibility] (../stream/state.html#handling-serializer-upgrades-and-compatibility) +for further details on how to implement these methods. + +### `ProcessFunction` is always a `RichFunction` + +In Flink 1.2, `ProcessFunction` and its rich variant `RichProcessFunction` was introduced. +Since Flink 1.3, `RichProcessFunction` was removed and `ProcessFunction` is now always a `RichFunction` with access to +the lifecycle methods and runtime context. + +### Flink CEP library API changes + +The CEP library in Flink 1.3 ships with a number of new features which have led to some changes in the API. +Please visit the [CEP Migration docs] (../libs/cep.html#migrating-from-an-older-flink-version) for details. + +### Table API Changes + + TBA + +### Queryable State client construction changes + + TBA — End diff – I don't think these TBA sections are a good idea in the documentation. Maybe we should comment them out before committing them, so that they don't show up in the page
          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user tzulitai opened a pull request:

          https://github.com/apache/flink/pull/4211

          FLINK-6674 FLINK-6680 [docs] Update migration docs for 1.3

          This PR updates / bootstraps changes to the migration docs required for 1.3, namely [API Migration Guides](https://ci.apache.org/projects/flink/flink-docs-release-1.3/dev/migration.html) and [Upgrading Applications and Flink versions](https://ci.apache.org/projects/flink/flink-docs-release-1.3/ops/upgrading.html).

          The main changes are:

          • *For API Migration Guides*: list all known changes, with links to the respective details (or TBA if none has been added yet)
          • *Upgrading Applications and Flink versions*: Make the document more generic, and include specific limitations and compatibility info for 1.3.x.

          You can merge this pull request into a Git repository by running:

          $ git pull https://github.com/tzulitai/flink migration-doc-bootstrap

          Alternatively you can review and apply these changes as the patch at:

          https://github.com/apache/flink/pull/4211.patch

          To close this pull request, make a commit to your master/trunk branch
          with (at least) the following in the commit message:

          This closes #4211


          commit 62706c40a54abab63db3cd7d4ef82f1cb92b6ee8
          Author: Tzu-Li (Gordon) Tai <tzulitai@apache.org>
          Date: 2017-06-28T13:29:36Z

          FLINK-6674 [docs] Bootstrap API Migration docs update for 1.2 -> 1.3

          commit bf7dec3ed05613ab3caf9c143e2aa8d4e405e1ac
          Author: Tzu-Li (Gordon) Tai <tzulitai@apache.org>
          Date: 2017-06-28T14:44:01Z

          FLINK-6680 [docs] Update "Upgrading Applications and Flink Versions" for 1.3


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user tzulitai opened a pull request: https://github.com/apache/flink/pull/4211 FLINK-6674 FLINK-6680 [docs] Update migration docs for 1.3 This PR updates / bootstraps changes to the migration docs required for 1.3, namely [API Migration Guides] ( https://ci.apache.org/projects/flink/flink-docs-release-1.3/dev/migration.html ) and [Upgrading Applications and Flink versions] ( https://ci.apache.org/projects/flink/flink-docs-release-1.3/ops/upgrading.html ). The main changes are: * For API Migration Guides *: list all known changes, with links to the respective details (or TBA if none has been added yet) * Upgrading Applications and Flink versions *: Make the document more generic, and include specific limitations and compatibility info for 1.3.x. You can merge this pull request into a Git repository by running: $ git pull https://github.com/tzulitai/flink migration-doc-bootstrap Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/4211.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #4211 commit 62706c40a54abab63db3cd7d4ef82f1cb92b6ee8 Author: Tzu-Li (Gordon) Tai <tzulitai@apache.org> Date: 2017-06-28T13:29:36Z FLINK-6674 [docs] Bootstrap API Migration docs update for 1.2 -> 1.3 commit bf7dec3ed05613ab3caf9c143e2aa8d4e405e1ac Author: Tzu-Li (Gordon) Tai <tzulitai@apache.org> Date: 2017-06-28T14:44:01Z FLINK-6680 [docs] Update "Upgrading Applications and Flink Versions" for 1.3

            People

            • Assignee:
              Unassigned
              Reporter:
              NicoK Nico Kruber
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:

                Development