You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by fh...@apache.org on 2019/09/06 12:13:03 UTC
[flink] 03/03: [FLINK-13942][docs] Add "Getting Started" overview
page.
This is an automated email from the ASF dual-hosted git repository.
fhueske pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 275fe9641a8be0815fee152388bf105941b23418
Author: Fabian Hueske <fh...@apache.org>
AuthorDate: Tue Sep 3 09:54:30 2019 +0200
[FLINK-13942][docs] Add "Getting Started" overview page.
This closes #9603.
[ci skip]
---
docs/getting-started/index.md | 35 +++++++++++++++++++++++++++++++++++
docs/getting-started/index.zh.md | 35 +++++++++++++++++++++++++++++++++++
2 files changed, 70 insertions(+)
diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md
index bd80898..861be99 100644
--- a/docs/getting-started/index.md
+++ b/docs/getting-started/index.md
@@ -4,6 +4,7 @@ nav-id: getting-started
nav-title: '<i class="fa fa-rocket title appetizer" aria-hidden="true"></i> Getting Started'
nav-parent_id: root
section-break: true
+nav-show_overview: true
nav-pos: 1
---
<!--
@@ -24,3 +25,37 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
+
+There are many ways to get started with Apache Flink. Which one is the best for you depends on your goal and prior experience.
+
+### Taking a first look at Flink
+
+The **Docker Playgrounds** provide sandboxed Flink environments that are set up in just a few minutes and which allow you to explore and play with Flink.
+
+* The [**Operations Playground**](./docker-playgrounds/flink-operations-playground.html) shows you how to operate streaming applications with Flink. You can experience how Flink recovers application from failures, upgrade and scale streaming applications up and down, and query application metrics.
+
+<!--
+* The [**Streaming SQL Playground**]() provides a Flink cluster with a SQL CLI client, tables which are fed by streaming data sources, and instructions for how to run continuous streaming SQL queries on these tables. This is the perfect environment for your first steps with streaming SQL.
+-->
+
+### First steps with one of Flink's APIs
+
+The **Code Walkthroughs** are the best way to get started and introduce you step by step to an API.
+A walkthrough provides instructions to bootstrap a small Flink project with a code skeleton and shows how to extend it to a simple application.
+
+<!--
+* The [**DataStream API**]() code walkthrough shows how to implement a simple DataStream application and how to extend it to be stateful and use timers.
+-->
+* The [**DataStream API**](./tutorials/datastream_api.html) tutorial shows how to implement a basic DataStream application. The DataStream API is Flink's main abstraction to implement stateful streaming applications with sophisticated time semantics in Java or Scala.
+
+* The [**Table API**](./walkthroughs/table_api.html) code walkthrough shows how to implement a simple Table API query on a batch source and how to evolve it into a continuous query on a streaming source. The Table API Flink's language-embedded, relational API to write SQL-like queries in Java or Scala which are automatically optimized similar to SQL queries. Table API queries can be executed on batch or streaming data with identical syntax and semantics.
+
+<!--
+### Starting a new Flink application
+
+The **Project Setup** instructions show you how to create a project for a new Flink application in just a few steps.
+
+* [**DataStream API**]()
+* [**DataSet API**]()
+* [**Table API / SQL**]()
+ -->
diff --git a/docs/getting-started/index.zh.md b/docs/getting-started/index.zh.md
index bd80898..861be99 100644
--- a/docs/getting-started/index.zh.md
+++ b/docs/getting-started/index.zh.md
@@ -4,6 +4,7 @@ nav-id: getting-started
nav-title: '<i class="fa fa-rocket title appetizer" aria-hidden="true"></i> Getting Started'
nav-parent_id: root
section-break: true
+nav-show_overview: true
nav-pos: 1
---
<!--
@@ -24,3 +25,37 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
+
+There are many ways to get started with Apache Flink. Which one is the best for you depends on your goal and prior experience.
+
+### Taking a first look at Flink
+
+The **Docker Playgrounds** provide sandboxed Flink environments that are set up in just a few minutes and which allow you to explore and play with Flink.
+
+* The [**Operations Playground**](./docker-playgrounds/flink-operations-playground.html) shows you how to operate streaming applications with Flink. You can experience how Flink recovers application from failures, upgrade and scale streaming applications up and down, and query application metrics.
+
+<!--
+* The [**Streaming SQL Playground**]() provides a Flink cluster with a SQL CLI client, tables which are fed by streaming data sources, and instructions for how to run continuous streaming SQL queries on these tables. This is the perfect environment for your first steps with streaming SQL.
+-->
+
+### First steps with one of Flink's APIs
+
+The **Code Walkthroughs** are the best way to get started and introduce you step by step to an API.
+A walkthrough provides instructions to bootstrap a small Flink project with a code skeleton and shows how to extend it to a simple application.
+
+<!--
+* The [**DataStream API**]() code walkthrough shows how to implement a simple DataStream application and how to extend it to be stateful and use timers.
+-->
+* The [**DataStream API**](./tutorials/datastream_api.html) tutorial shows how to implement a basic DataStream application. The DataStream API is Flink's main abstraction to implement stateful streaming applications with sophisticated time semantics in Java or Scala.
+
+* The [**Table API**](./walkthroughs/table_api.html) code walkthrough shows how to implement a simple Table API query on a batch source and how to evolve it into a continuous query on a streaming source. The Table API Flink's language-embedded, relational API to write SQL-like queries in Java or Scala which are automatically optimized similar to SQL queries. Table API queries can be executed on batch or streaming data with identical syntax and semantics.
+
+<!--
+### Starting a new Flink application
+
+The **Project Setup** instructions show you how to create a project for a new Flink application in just a few steps.
+
+* [**DataStream API**]()
+* [**DataSet API**]()
+* [**Table API / SQL**]()
+ -->