flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From se...@apache.org
Subject [07/10] flink git commit: [FLINK-5458] [docs] Add a template for migration guide
Date Mon, 16 Jan 2017 10:55:30 GMT
[FLINK-5458] [docs] Add a template for migration guide


Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/4b0c4d96
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/4b0c4d96
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/4b0c4d96

Branch: refs/heads/release-1.2
Commit: 4b0c4d969e53caa986a47465c3600484dbd14e5e
Parents: 2730e89
Author: Stephan Ewen <sewen@apache.org>
Authored: Tue Jan 10 15:44:42 2017 +0100
Committer: Stephan Ewen <sewen@apache.org>
Committed: Mon Jan 16 11:53:46 2017 +0100

----------------------------------------------------------------------
 docs/dev/migration.md | 33 +++++++++++++++++++++++++++++++++
 docs/index.md         | 11 ++++++++++-
 2 files changed, 43 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flink/blob/4b0c4d96/docs/dev/migration.md
----------------------------------------------------------------------
diff --git a/docs/dev/migration.md b/docs/dev/migration.md
new file mode 100644
index 0000000..c74952c
--- /dev/null
+++ b/docs/dev/migration.md
@@ -0,0 +1,33 @@
+---
+title: "API Migration Guides"
+nav-parent_id: dev
+nav-pos: 100
+---
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+* This will be replaced by the TOC
+{:toc}
+
+## Flink 1.1 to 1.2
+
+### State API
+
+### Fast Processing Time Window Operators
+

http://git-wip-us.apache.org/repos/asf/flink/blob/4b0c4d96/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
index 75b5328..595a094 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -29,8 +29,17 @@ Apache Flink is an open source platform for distributed stream and batch
data pr
 
 ## First Steps
 
-- **Concepts**: Start with the basic concepts of Flink's [Dataflow Programming Model]({{
site.baseurl }}/concepts/programming-model.html) and [Distributed Runtime Environment]({{
site.baseurl }}/concepts/runtime.html). This will help you to fully understand the other parts
of the documentation, including the setup and programming guides. It is highly recommended
to read these sections first.
+- **Concepts**: Start with the basic concepts of Flink's [Dataflow Programming Model](concepts/programming-model.html)
and [Distributed Runtime Environment](concepts/runtime.html). This will help you to fully
understand the other parts of the documentation, including the setup and programming guides.
It is highly recommended to read these sections first.
 
 - **Quickstarts**: [Run an example program](quickstart/setup_quickstart.html) on your local
machine or [write a simple program](quickstart/run_example_quickstart.html) working on live
Wikipedia edits.
 
 - **Programming Guides**: You can check out our guides about [basic concepts](dev/api_concepts.html)
and the [DataStream API](dev/datastream_api.html) or [DataSet API](dev/batch/index.html) to
learn how to write your first Flink programs.
+
+## Migration Guide
+
+For users that have used prior versions of Apache Flink we recommend checking out the [API
migration guide](dev/migration.html).
+While all parts of the API that were marked as public and stable are still supported (backwards
compatible), we suggest to migrate applications to the
+newer interfaces where applicable.
+
+For users that look to upgrade an operation Flink system to the latest version, we recommend
to check out the guide on [upgrading Apache Flink](ops/upgrading.html)
+


Mime
View raw message