This is an automated email from the ASF dual-hosted git repository. sjwiesman pushed a commit to branch release-1.11 in repository https://gitbox.apache.org/repos/asf/flink.git
commit b8e8269871950cf4437b44f2186c814675332d35 Author: Seth Wiesman <sjwies...@gmail.com> AuthorDate: Mon Jun 8 11:33:16 2020 -0500 [FLINK-17980][docs] Move getting started walkthroughs to Try Flink --- docs/getting-started/index.md | 86 ---------------------- docs/getting-started/index.zh.md | 86 ---------------------- .../datastream-walkthrough.md} | 9 +-- .../flink-operations-playground.md} | 9 +-- .../index.md => redirects/getting-started.md} | 11 ++- .../python_table_walkthrough.md} | 11 ++- .../index.md => redirects/table-walkthrough.md} | 9 +-- .../walkthroughs => try-flink}/datastream_api.md | 2 +- .../datastream_api.zh.md | 2 +- .../flink-operations-playground.md | 4 +- .../flink-operations-playground.zh.md | 4 +- .../docker-playgrounds => try-flink}/index.md | 12 +-- .../docker-playgrounds => try-flink}/index.zh.md | 11 +-- .../walkthroughs => try-flink}/python_table_api.md | 4 +- .../python_table_api.zh.md | 4 +- .../walkthroughs => try-flink}/table_api.md | 2 +- .../walkthroughs => try-flink}/table_api.zh.md | 2 +- 17 files changed, 47 insertions(+), 221 deletions(-) diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md deleted file mode 100644 index a6b5cab..0000000 --- a/docs/getting-started/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "Getting Started" -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 ---- -<!-- -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. ---> - -There are many ways to get started with Apache Flink. Which one is the best for -you depends on your goals and prior experience: - -* take a look at the **Docker Playgrounds** if you want to see what Flink can do, via a hands-on, - docker-based introduction to specific Flink concepts -* explore one of the **Code Walkthroughs** if you want a quick, end-to-end - introduction to one of Flink's APIs -* work your way through the **Hands-on Training** for a comprehensive, - step-by-step introduction to Flink -* use **Project Setup** if you already know the basics of Flink and want a - project template for Java or Scala, or need help setting up the dependencies - -### 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**]({% link getting-started/docker-playgrounds/flink-operations-playground.md %}) 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 a great way to get started quickly with a step-by-step introduction to -one of Flink's APIs. Each walkthrough provides instructions for bootstrapping a small skeleton -project, and then shows how to extend it to a simple application. - -* The [**DataStream API** code walkthrough]({% link getting-started/walkthroughs/datastream_api.md %}) shows how - to implement a simple DataStream application and how to extend it to be stateful and use timers. - The DataStream API is Flink's main abstraction for implementing stateful streaming applications - with sophisticated time semantics in Java or Scala. - -* Flink's **Table API** is a relational API used for writing SQL-like queries in Java, Scala, or - Python, which are then automatically optimized, and can be executed on batch or streaming data - with identical syntax and semantics. The [Table API code walkthrough for Java and Scala]({% link - getting-started/walkthroughs/table_api.md %}) 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. There's also a - similar [code walkthrough for the Python Table API]({% link - getting-started/walkthroughs/python_table_api.md %}). - -### Taking a Deep Dive with the Hands-on Training - -The [**Hands-on Training**]({% link training/index.md %}) is a self-paced training course with -a set of lessons and hands-on exercises. This step-by-step introduction to Flink focuses -on learning how to use the DataStream API to meet the needs of common, real-world use cases, -and provides a complete introduction to the fundamental concepts: parallel dataflows, -stateful stream processing, event time and watermarking, and fault tolerance via state snapshots. - -<!-- -### 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 deleted file mode 100644 index 2619f77..0000000 --- a/docs/getting-started/index.zh.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: 入门指南 -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 ---- -<!-- -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. ---> - -There are many ways to get started with Apache Flink. Which one is the best for -you depends on your goals and prior experience: - -* take a look at the **Docker Playgrounds** if you want to see what Flink can do, via a hands-on, - docker-based introduction to specific Flink concepts -* explore one of the **Code Walkthroughs** if you want a quick, end-to-end - introduction to one of Flink's APIs -* work your way through the **Hands-on Training** for a comprehensive, - step-by-step introduction to Flink -* use **Project Setup** if you already know the basics of Flink and want a - project template for Java or Scala, or need help setting up the dependencies - -### 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**]({% link getting-started/docker-playgrounds/flink-operations-playground.md %}) 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 a great way to get started quickly with a step-by-step introduction to -one of Flink's APIs. Each walkthrough provides instructions for bootstrapping a small skeleton -project, and then shows how to extend it to a simple application. - -* The [**DataStream API** code walkthrough]({% link getting-started/walkthroughs/datastream_api.md %}) shows how - to implement a simple DataStream application and how to extend it to be stateful and use timers. - The DataStream API is Flink's main abstraction for implementing stateful streaming applications - with sophisticated time semantics in Java or Scala. - -* Flink's **Table API** is a relational API used for writing SQL-like queries in Java, Scala, or - Python, which are then automatically optimized, and can be executed on batch or streaming data - with identical syntax and semantics. The [Table API code walkthrough for Java and Scala]({% link - getting-started/walkthroughs/table_api.md %}) 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. There's also a - similar [code walkthrough for the Python Table API]({% link - getting-started/walkthroughs/python_table_api.md %}). - -### Taking a Deep Dive with the Hands-on Training - -The [**Hands-on Training**]({% link training/index.md %}) is a self-paced training course with -a set of lessons and hands-on exercises. This step-by-step introduction to Flink focuses -on learning how to use the DataStream API to meet the needs of common, real-world use cases, -and provides a complete introduction to the fundamental concepts: parallel dataflows, -stateful stream processing, event time and watermarking, and fault tolerance via state snapshots. - -<!-- -### 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/docker-playgrounds/index.zh.md b/docs/redirects/datastream-walkthrough.md similarity index 83% copy from docs/getting-started/docker-playgrounds/index.zh.md copy to docs/redirects/datastream-walkthrough.md index e3d5fd8..b430b61 100644 --- a/docs/getting-started/docker-playgrounds/index.zh.md +++ b/docs/redirects/datastream-walkthrough.md @@ -1,9 +1,8 @@ --- -title: Docker Playgrounds -nav-id: docker-playgrounds -nav-title: 'Docker Playgrounds' -nav-parent_id: getting-started -nav-pos: 10 +title: DataStream Walkthrough +layout: redirect +redirect: /try-flink/datastream_api.html +permalink: /getting-started/walkthroughs/datastream_api.html --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/getting-started/docker-playgrounds/index.md b/docs/redirects/flink-operations-playground.md similarity index 81% copy from docs/getting-started/docker-playgrounds/index.md copy to docs/redirects/flink-operations-playground.md index e3d5fd8..eb230cd 100644 --- a/docs/getting-started/docker-playgrounds/index.md +++ b/docs/redirects/flink-operations-playground.md @@ -1,9 +1,8 @@ --- -title: Docker Playgrounds -nav-id: docker-playgrounds -nav-title: 'Docker Playgrounds' -nav-parent_id: getting-started -nav-pos: 10 +title: Flink Operations Playground +layout: redirect +redirect: /try-flink/flink-operations-playground.html +permalink: /getting-started/playgrounds/flink-operations-playground.html --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/getting-started/walkthroughs/index.md b/docs/redirects/getting-started.md similarity index 86% rename from docs/getting-started/walkthroughs/index.md rename to docs/redirects/getting-started.md index 055f1b8..ce76fb2 100644 --- a/docs/getting-started/walkthroughs/index.md +++ b/docs/redirects/getting-started.md @@ -1,9 +1,8 @@ --- -title: "Code Walkthroughs" -nav-id: walkthroughs -nav-title: 'Code Walkthroughs' -nav-parent_id: getting-started -nav-pos: 20 +title: Getting Started +layout: redirect +redirect: /index.html +permalink: /getting-started/index.html --- <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -22,4 +21,4 @@ software distributed under the License is distributed on an KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ---> \ No newline at end of file +--> diff --git a/docs/getting-started/walkthroughs/index.zh.md b/docs/redirects/python_table_walkthrough.md similarity index 82% rename from docs/getting-started/walkthroughs/index.zh.md rename to docs/redirects/python_table_walkthrough.md index 055f1b8..c23f91e 100644 --- a/docs/getting-started/walkthroughs/index.zh.md +++ b/docs/redirects/python_table_walkthrough.md @@ -1,9 +1,8 @@ --- -title: "Code Walkthroughs" -nav-id: walkthroughs -nav-title: 'Code Walkthroughs' -nav-parent_id: getting-started -nav-pos: 20 +title: Python Table Walkthrough +layout: redirect +redirect: /try-flink/python_table_api.html +permalink: /getting-started/walkthroughs/python_table_api.html --- <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -22,4 +21,4 @@ software distributed under the License is distributed on an KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ---> \ No newline at end of file +--> diff --git a/docs/getting-started/docker-playgrounds/index.md b/docs/redirects/table-walkthrough.md similarity index 85% copy from docs/getting-started/docker-playgrounds/index.md copy to docs/redirects/table-walkthrough.md index e3d5fd8..36dea00 100644 --- a/docs/getting-started/docker-playgrounds/index.md +++ b/docs/redirects/table-walkthrough.md @@ -1,9 +1,8 @@ --- -title: Docker Playgrounds -nav-id: docker-playgrounds -nav-title: 'Docker Playgrounds' -nav-parent_id: getting-started -nav-pos: 10 +title: Table Walkthrough +layout: redirect +redirect: /try-flink/table_api.html +permalink: /getting-started/walkthroughs/table_api.html --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/getting-started/walkthroughs/datastream_api.md b/docs/try-flink/datastream_api.md similarity index 99% rename from docs/getting-started/walkthroughs/datastream_api.md rename to docs/try-flink/datastream_api.md index 7281a65..ae529ad 100644 --- a/docs/getting-started/walkthroughs/datastream_api.md +++ b/docs/try-flink/datastream_api.md @@ -2,7 +2,7 @@ title: "DataStream API" nav-id: datastreamwalkthrough nav-title: 'DataStream API' -nav-parent_id: walkthroughs +nav-parent_id: try-flink nav-pos: 1 --- <!-- diff --git a/docs/getting-started/walkthroughs/datastream_api.zh.md b/docs/try-flink/datastream_api.zh.md similarity index 99% rename from docs/getting-started/walkthroughs/datastream_api.zh.md rename to docs/try-flink/datastream_api.zh.md index f21004d..d5e13f4 100644 --- a/docs/getting-started/walkthroughs/datastream_api.zh.md +++ b/docs/try-flink/datastream_api.zh.md @@ -2,7 +2,7 @@ title: "DataStream API" nav-id: datastreamwalkthrough nav-title: 'DataStream API' -nav-parent_id: walkthroughs +nav-parent_id: try-flink nav-pos: 1 --- <!-- diff --git a/docs/getting-started/docker-playgrounds/flink-operations-playground.md b/docs/try-flink/flink-operations-playground.md similarity index 99% rename from docs/getting-started/docker-playgrounds/flink-operations-playground.md rename to docs/try-flink/flink-operations-playground.md index 6d9f409..956f118 100644 --- a/docs/getting-started/docker-playgrounds/flink-operations-playground.md +++ b/docs/try-flink/flink-operations-playground.md @@ -1,8 +1,8 @@ --- title: "Flink Operations Playground" nav-title: 'Flink Operations Playground' -nav-parent_id: docker-playgrounds -nav-pos: 1 +nav-parent_id: try-flink +nav-pos: 4 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/getting-started/docker-playgrounds/flink-operations-playground.zh.md b/docs/try-flink/flink-operations-playground.zh.md similarity index 99% rename from docs/getting-started/docker-playgrounds/flink-operations-playground.zh.md rename to docs/try-flink/flink-operations-playground.zh.md index 6d9f409..956f118 100644 --- a/docs/getting-started/docker-playgrounds/flink-operations-playground.zh.md +++ b/docs/try-flink/flink-operations-playground.zh.md @@ -1,8 +1,8 @@ --- title: "Flink Operations Playground" nav-title: 'Flink Operations Playground' -nav-parent_id: docker-playgrounds -nav-pos: 1 +nav-parent_id: try-flink +nav-pos: 4 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/getting-started/docker-playgrounds/index.md b/docs/try-flink/index.md similarity index 81% rename from docs/getting-started/docker-playgrounds/index.md rename to docs/try-flink/index.md index e3d5fd8..8b04ddb 100644 --- a/docs/getting-started/docker-playgrounds/index.md +++ b/docs/try-flink/index.md @@ -1,9 +1,10 @@ --- -title: Docker Playgrounds -nav-id: docker-playgrounds -nav-title: 'Docker Playgrounds' -nav-parent_id: getting-started -nav-pos: 10 +title: "Try Flink" +nav-id: try-flink +nav-title: '<i class="fa fa-rocket title appetizer" aria-hidden="true"></i> Try Flink' +nav-parent_id: root +section-break: true +nav-pos: 1 --- <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -23,3 +24,4 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> + diff --git a/docs/getting-started/docker-playgrounds/index.zh.md b/docs/try-flink/index.zh.md similarity index 81% rename from docs/getting-started/docker-playgrounds/index.zh.md rename to docs/try-flink/index.zh.md index e3d5fd8..90f3a1d 100644 --- a/docs/getting-started/docker-playgrounds/index.zh.md +++ b/docs/try-flink/index.zh.md @@ -1,9 +1,10 @@ --- -title: Docker Playgrounds -nav-id: docker-playgrounds -nav-title: 'Docker Playgrounds' -nav-parent_id: getting-started -nav-pos: 10 +title: "Try Flink" +nav-id: try-flink +nav-title: '<i class="fa fa-rocket title appetizer" aria-hidden="true"></i> Try Flink' +nav-parent_id: root +section-break: true +nav-pos: 1 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/getting-started/walkthroughs/python_table_api.md b/docs/try-flink/python_table_api.md similarity index 99% rename from docs/getting-started/walkthroughs/python_table_api.md rename to docs/try-flink/python_table_api.md index 553289d..9cff9f7 100644 --- a/docs/getting-started/walkthroughs/python_table_api.md +++ b/docs/try-flink/python_table_api.md @@ -1,8 +1,8 @@ --- title: "Python API Tutorial" nav-title: Python API -nav-parent_id: walkthroughs -nav-pos: 10 +nav-parent_id: try-flink +nav-pos: 3 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/getting-started/walkthroughs/python_table_api.zh.md b/docs/try-flink/python_table_api.zh.md similarity index 99% rename from docs/getting-started/walkthroughs/python_table_api.zh.md rename to docs/try-flink/python_table_api.zh.md index 48ab506..be27eca 100644 --- a/docs/getting-started/walkthroughs/python_table_api.zh.md +++ b/docs/try-flink/python_table_api.zh.md @@ -1,8 +1,8 @@ --- title: "Python API 教程" nav-title: Python API -nav-parent_id: walkthroughs -nav-pos: 10 +nav-parent_id: try-flink +nav-pos: 3 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/getting-started/walkthroughs/table_api.md b/docs/try-flink/table_api.md similarity index 99% rename from docs/getting-started/walkthroughs/table_api.md rename to docs/try-flink/table_api.md index f1293fb..7c277ca 100644 --- a/docs/getting-started/walkthroughs/table_api.md +++ b/docs/try-flink/table_api.md @@ -2,7 +2,7 @@ title: "Table API" nav-id: tableapiwalkthrough nav-title: 'Table API' -nav-parent_id: walkthroughs +nav-parent_id: try-flink nav-pos: 2 --- <!-- diff --git a/docs/getting-started/walkthroughs/table_api.zh.md b/docs/try-flink/table_api.zh.md similarity index 99% rename from docs/getting-started/walkthroughs/table_api.zh.md rename to docs/try-flink/table_api.zh.md index 3194ae8..13f4bee 100644 --- a/docs/getting-started/walkthroughs/table_api.zh.md +++ b/docs/try-flink/table_api.zh.md @@ -2,7 +2,7 @@ title: "Table API" nav-id: tableapiwalkthrough nav-title: 'Table API' -nav-parent_id: walkthroughs +nav-parent_id: try-flink nav-pos: 2 --- <!--