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 13:18:00 UTC
[flink] branch release-1.9 updated: [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 release-1.9
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/release-1.9 by this push:
new fcdad72 [FLINK-13942][docs] Add "Getting Started" overview page.
fcdad72 is described below
commit fcdad7265866b5f5b44bb09f7b036e1540f7e27f
Author: Fabian Hueske <fh...@apache.org>
AuthorDate: Tue Sep 3 09:54:30 2019 +0200
[FLINK-13942][docs] Add "Getting Started" overview page.
[ci skip]
---
docs/getting-started/index.md | 30 ++++++++++++++++++++++++++++++
docs/getting-started/index.zh.md | 30 ++++++++++++++++++++++++++++++
2 files changed, 60 insertions(+)
diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md
index bd80898..901e48c 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,32 @@ 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 **API Tutorials** are the best way to get started and introduce you step by step to an API.
+A tutorial 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**](./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.
+
+<!--
+### 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..901e48c 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,32 @@ 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 **API Tutorials** are the best way to get started and introduce you step by step to an API.
+A tutorial 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**](./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.
+
+<!--
+### 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**]()
+ -->