[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210610938 ## File path: docs/building/index.md ## @@ -1,10 +1,10 @@ --- section-break: true -nav-title: ' Project Setup' -title: "Project Setup" -nav-id: "start" +nav-title: ' Building & Developing Flink' Review comment: That would be perfect This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210588192 ## File path: docs/building/index.md ## @@ -1,10 +1,10 @@ --- section-break: true -nav-title: ' Project Setup' -title: "Project Setup" -nav-id: "start" +nav-title: ' Building & Developing Flink' Review comment: Sorry if you see the previous comment I deleted. The only thing remain from that is, as you said, choose different version of Flink or Hadoop might be a command demand from users. Even they don't want to develop Flink. So it would be worth to link the building page from `tutorials/local_setup.html`'s `Download and Compile` section. Mention that one could config the version as he like. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210582481 ## File path: docs/building/index.md ## @@ -1,10 +1,10 @@ --- section-break: true -nav-title: ' Project Setup' -title: "Project Setup" -nav-id: "start" +nav-title: ' Building & Developing Flink' Review comment: Building Flink from source, as you said, is highly probably a demand of users who don't want to develop it. With content in your version, this section would be at quite bottom. And since choose specific version of Flink, Hadoop, ... is a common demand of users, also according to `building/building.html`'s content, I'd prefer move it to `Tutorials`, and link to it from `Developing Flink`. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210584047 ## File path: docs/dev/projectsetup/java_api_quickstart.md ## @@ -1,7 +1,7 @@ --- title: "Project Template for Java" nav-title: Project Template for Java -nav-parent_id: start +nav-parent_id: projectsetup nav-pos: 0 ---
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210584685 ## File path: docs/dev/projectsetup/index.md ## @@ -0,0 +1,25 @@ +--- +title: "Project Build Setup" Review comment: Sounds reasonable :-) This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210584047 ## File path: docs/dev/projectsetup/java_api_quickstart.md ## @@ -1,7 +1,7 @@ --- title: "Project Template for Java" nav-title: Project Template for Java -nav-parent_id: start +nav-parent_id: projectsetup nav-pos: 0 ---
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210584047 ## File path: docs/dev/projectsetup/java_api_quickstart.md ## @@ -1,7 +1,7 @@ --- title: "Project Template for Java" nav-title: Project Template for Java -nav-parent_id: start +nav-parent_id: projectsetup nav-pos: 0 ---
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210582481 ## File path: docs/building/index.md ## @@ -1,10 +1,10 @@ --- section-break: true -nav-title: ' Project Setup' -title: "Project Setup" -nav-id: "start" +nav-title: ' Building & Developing Flink' Review comment: Building Flink from source, as you said, is highly probably a demand of users who don't want to develop it. With content in your version, this section would be at quite bottom. And since choose specific version of Flink, Hadoop, ... is a common demand of users, also according to `building/building.html`'s content, I'd prefer move it to `Tutorials`, and link to it from `Developing Flink`. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210582481 ## File path: docs/building/index.md ## @@ -1,10 +1,10 @@ --- section-break: true -nav-title: ' Project Setup' -title: "Project Setup" -nav-id: "start" +nav-title: ' Building & Developing Flink' Review comment: Building Flink from source, as you said, may be a demand of users who don't want to develop it. With content in your version, this section would be at quite bottom. And since choose specific version of Flink, Hadoop, ... is a common demand of users, also according to `building/building.html`'s content, I'd prefer move it to `Tutorials`, and link to it from `Developing Flink`. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210580737 ## File path: docs/building/index.md ## @@ -1,10 +1,10 @@ --- section-break: true -nav-title: ' Project Setup' -title: "Project Setup" -nav-id: "start" +nav-title: ' Building & Developing Flink' +title: "Developing Flink" +nav-id: "building" Review comment: But this section more about `developing`, right? In the long run we would add more stuff about developing (e.g. FAQ, developing process, etc). This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add
Tutorials section and rework structure.
URL: https://github.com/apache/flink/pull/6565#discussion_r210568609
##
File path: docs/examples/index.md
##
@@ -25,15 +25,24 @@ specific language governing permissions and limitations
under the License.
-->
-[Sample Project in Java]({{ site.baseurl
}}/quickstart/java_api_quickstart.html) and [Sample Project in Scala]({{
site.baseurl }}/quickstart/scala_api_quickstart.html) are guides to setting up
Maven and SBT projects and include simple implementations of a word count
application.
-[Monitoring Wikipedia Edits]({{ site.baseurl
}}/quickstart/run_example_quickstart.html) is a more complete example of a
streaming analytics application.
+## Bundled Examples
-[Building real-time dashboard applications with Apache Flink, Elasticsearch,
and
Kibana](https://www.elastic.co/blog/building-real-time-dashboard-applications-with-apache-flink-elasticsearch-and-kibana)
is a blog post at elastic.co showing how to build a real-time dashboard
solution for streaming data analytics using Apache Flink, Elasticsearch, and
Kibana.
+The Flink sources include many examples for Flink's different APIs:
-The [Flink training website](http://training.data-artisans.com/) from data
Artisans has a number of examples. See the hands-on sections, and the exercises.
+* DataStream applications ({% gh_link
flink-examples/flink-examples-streaming/src/main/java/org/apache/flink/streaming/examples
"Java" %} / {% gh_link
flink-examples/flink-examples-streaming/src/main/scala/org/apache/flink/streaming/scala/examples
"Scala" %})
+* DataSet applications ({% gh_link
flink-examples/flink-examples-batch/src/main/java/org/apache/flink/examples/java
"Java" %} / {% gh_link
flink-examples/flink-examples-batch/src/main/scala/org/apache/flink/examples/scala
"Scala" %})
+* Table API / SQL queries ({% gh_link
flink-examples/flink-examples-table/src/main/java/org/apache/flink/table/examples/java
"Java" %} / {% gh_link
flink-examples/flink-examples-table/src/main/scala/org/apache/flink/table/examples/scala
"Scala" %})
-## Bundled Examples
+These [instructions]({{ site.baseurl
}}/dev/batch/examples.html#running-an-example) explain how to run the examples.
+
+## Examples on the Web
Review comment:
I think this link is to the same website
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210527451 ## File path: docs/dev/batch/examples.md ## @@ -27,8 +27,7 @@ The following example programs showcase different applications of Flink from simple word counting to graph algorithms. The code samples illustrate the Review comment: Thanks for your explanation. Now I agree with you. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210527451 ## File path: docs/dev/batch/examples.md ## @@ -27,8 +27,7 @@ The following example programs showcase different applications of Flink from simple word counting to graph algorithms. The code samples illustrate the Review comment: Thanks for you explanation. Now I agree with you. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210446691 ## File path: docs/building/index.md ## @@ -1,10 +1,10 @@ --- section-break: true -nav-title: ' Project Setup' -title: "Project Setup" -nav-id: "start" +nav-title: ' Building & Developing Flink' +title: "Developing Flink" +nav-id: "building" Review comment: could `building` becomes `developing` more comfortable? This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210445845 ## File path: docs/tutorials/local_setup.md ## @@ -1,8 +1,8 @@ --- -title: "Quickstart" -nav-title: ' Quickstart' -nav-parent_id: root -nav-pos: 2 +title: "Local Setup" +nav-title: 'Local Setup' +nav-parent_id: setuptutorials +nav-pos: 10 ---
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210446790 ## File path: docs/building/ide_setup.md ## @@ -1,6 +1,6 @@ --- -title: "IDE Setup" -nav-parent_id: start +title: "Importing Flink into an IDE" +nav-parent_id: building Review comment: also, how about `building` to `developing` This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210446227 ## File path: docs/dev/batch/examples.md ## @@ -27,8 +27,7 @@ The following example programs showcase different applications of Flink from simple word counting to graph algorithms. The code samples illustrate the Review comment: I wonder why we still need a section named `Examples` since we now have another named `Tutorials`. Besides, the contents below `Examples` is `Overview` and `Batch Examples`, that's weird. "why only batch?" may a new comer ask. Maybe we could move stuff from `Examples` to `Tutorials`. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210447328 ## File path: docs/dev/projectsetup/index.md ## @@ -0,0 +1,25 @@ +--- +title: "Project Build Setup" Review comment: "Project Setup" would be enough. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure.
TisonKun commented on a change in pull request #6565: [FLINK-10153] [docs] Add Tutorials section and rework structure. URL: https://github.com/apache/flink/pull/6565#discussion_r210446630 ## File path: docs/building/index.md ## @@ -1,10 +1,10 @@ --- section-break: true -nav-title: ' Project Setup' -title: "Project Setup" -nav-id: "start" +nav-title: ' Building & Developing Flink' Review comment: as below, `Building & Developing Flink` could be `Developing Flink`, more concise. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
