From 275fe9641a8be0815fee152388bf105941b23418 Mon Sep 17 00:00:00 2001 From: Fabian Hueske Date: Tue, 3 Sep 2019 09:54:30 +0200 Subject: [PATCH] [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 bd80898bf32a3..861be994d0783 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -4,6 +4,7 @@ nav-id: getting-started nav-title: ' Getting Started' nav-parent_id: root section-break: true +nav-show_overview: true nav-pos: 1 --- + +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. + + + +### 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**](./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. + + diff --git a/docs/getting-started/index.zh.md b/docs/getting-started/index.zh.md index bd80898bf32a3..861be994d0783 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: ' Getting Started' nav-parent_id: root section-break: true +nav-show_overview: true nav-pos: 1 --- + +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. + + + +### 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**](./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. + +