Skip to content

Commit

Permalink
[FLINK-13942][docs] Add "Getting Started" overview page.
Browse files Browse the repository at this point in the history
This closes apache#9603.

[ci skip]
  • Loading branch information
fhueske committed Sep 6, 2019
1 parent a17623b commit 275fe96
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 0 deletions.
35 changes: 35 additions & 0 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
<!--
Expand All @@ -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**]()
-->
35 changes: 35 additions & 0 deletions docs/getting-started/index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
<!--
Expand All @@ -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**]()
-->

0 comments on commit 275fe96

Please sign in to comment.