You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2020/05/04 18:12:11 UTC
[GitHub] [flink] alpinegizmo opened a new pull request #11988: [FLINK-17244][docs] Update the Getting Started page
alpinegizmo opened a new pull request #11988:
URL: https://github.com/apache/flink/pull/11988
## What is the purpose of the change
* Generally improve the content of this page
* Add the Python Table API code walkthrough
* Add the Hands-on Training
## Translation
* I created FLINK-17504 for updating the Chinese translation
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] alpinegizmo commented on a change in pull request #11988: [FLINK-17244][docs] Update the Getting Started page
Posted by GitBox <gi...@apache.org>.
alpinegizmo commented on a change in pull request #11988:
URL: https://github.com/apache/flink/pull/11988#discussion_r420170811
##########
File path: docs/getting-started/index.md
##########
@@ -28,34 +28,53 @@ 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:
+you depends on your goals and prior experience:
-* take a look at the **Docker Playgrounds** for a docker-based introduction to
- specific Flink concepts
-* explore on of the **Code Walkthroughs** if you want to get an end-to-end
- introduction to using one of the Flink APIs
-* use **Project Setup** if you already know the basics of Flink but want to get a
- project setup template for Java or Scala and need help setting up
- dependencies
+* 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
Review comment:
I think it might be odd to only link to the Training here, and the other 3 aren't linkable.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] NicoK commented on a change in pull request #11988: [FLINK-17244][docs] Update the Getting Started page
Posted by GitBox <gi...@apache.org>.
NicoK commented on a change in pull request #11988:
URL: https://github.com/apache/flink/pull/11988#discussion_r420121701
##########
File path: docs/getting-started/index.md
##########
@@ -28,34 +28,53 @@ 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:
+you depends on your goals and prior experience:
-* take a look at the **Docker Playgrounds** for a docker-based introduction to
- specific Flink concepts
-* explore on of the **Code Walkthroughs** if you want to get an end-to-end
- introduction to using one of the Flink APIs
-* use **Project Setup** if you already know the basics of Flink but want to get a
- project setup template for Java or Scala and need help setting up
- dependencies
+* 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
Review comment:
What do you think about linking these sections directly here? That way, you don't have to look for them in the navigation; especially with the Hands-On Training not being part of this section.
##########
File path: docs/getting-started/index.md
##########
@@ -28,34 +28,53 @@ 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:
+you depends on your goals and prior experience:
-* take a look at the **Docker Playgrounds** for a docker-based introduction to
- specific Flink concepts
-* explore on of the **Code Walkthroughs** if you want to get an end-to-end
- introduction to using one of the Flink APIs
-* use **Project Setup** if you already know the basics of Flink but want to get a
- project setup template for Java or Scala and need help setting up
- dependencies
+* 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**](./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 [**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 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 **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**](./walkthroughs/datastream_api.html) code walkthrough 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 to implement stateful streaming applications with sophisticated time semantics in Java or Scala.
+* The [**DataStream API**]({% link getting-started/walkthroughs/datastream_api.md %}) code walkthrough shows how
Review comment:
Should you actually also include "code walkthrough" in the link? (we're not linking to the DataStream API docs)
```suggestion
* The [**DataStream API** code walkthrough]({% link getting-started/walkthroughs/datastream_api.md %}) shows how
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] NicoK commented on a change in pull request #11988: [FLINK-17244][docs] Update the Getting Started page
Posted by GitBox <gi...@apache.org>.
NicoK commented on a change in pull request #11988:
URL: https://github.com/apache/flink/pull/11988#discussion_r420172306
##########
File path: docs/getting-started/index.md
##########
@@ -28,34 +28,53 @@ 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:
+you depends on your goals and prior experience:
-* take a look at the **Docker Playgrounds** for a docker-based introduction to
- specific Flink concepts
-* explore on of the **Code Walkthroughs** if you want to get an end-to-end
- introduction to using one of the Flink APIs
-* use **Project Setup** if you already know the basics of Flink but want to get a
- project setup template for Java or Scala and need help setting up
- dependencies
+* 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
Review comment:
true - didn't see that the other 3 are not linkable...
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot commented on pull request #11988: [FLINK-17244][docs] Update the Getting Started page
Posted by GitBox <gi...@apache.org>.
flinkbot commented on pull request #11988:
URL: https://github.com/apache/flink/pull/11988#issuecomment-623622490
Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.
## Automated Checks
Last check on commit cc4fa4fe94ef8a6ff97a2a9b7bb752302224c5c4 (Mon May 04 18:14:38 UTC 2020)
**Warnings:**
* Documentation files were touched, but no `.zh.md` files: Update Chinese documentation or file Jira ticket.
<sub>Mention the bot in a comment to re-run the automated checks.</sub>
## Review Progress
* ❓ 1. The [description] looks good.
* ❓ 2. There is [consensus] that the contribution should go into to Flink.
* ❓ 3. Needs [attention] from.
* ❓ 4. The change fits into the overall [architecture].
* ❓ 5. Overall code [quality] is good.
Please see the [Pull Request Review Guide](https://flink.apache.org/contributing/reviewing-prs.html) for a full explanation of the review process.<details>
The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required <summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot approve description` to approve one or more aspects (aspects: `description`, `consensus`, `architecture` and `quality`)
- `@flinkbot approve all` to approve all aspects
- `@flinkbot approve-until architecture` to approve everything until `architecture`
- `@flinkbot attention @username1 [@username2 ..]` to require somebody's attention
- `@flinkbot disapprove architecture` to remove an approval you gave earlier
</details>
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #11988: [FLINK-17244][docs] Update the Getting Started page
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #11988:
URL: https://github.com/apache/flink/pull/11988#issuecomment-623640141
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "cc4fa4fe94ef8a6ff97a2a9b7bb752302224c5c4",
"status" : "PENDING",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=573",
"triggerID" : "cc4fa4fe94ef8a6ff97a2a9b7bb752302224c5c4",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* cc4fa4fe94ef8a6ff97a2a9b7bb752302224c5c4 Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=573)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org