[
https://issues.apache.org/jira/browse/FLINK-10153?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16582401#comment-16582401
]
ASF GitHub Bot commented on FLINK-10153:
----------------------------------------
aljoscha 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_r210566345
##########
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:
Is it common to link to external websites in a project documentation?
----------------------------------------------------------------
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
> Add tutorial section to documentation
> -------------------------------------
>
> Key: FLINK-10153
> URL: https://issues.apache.org/jira/browse/FLINK-10153
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
> Reporter: Fabian Hueske
> Assignee: Fabian Hueske
> Priority: Major
> Labels: pull-request-available
>
> The current documentation does not feature a dedicated tutorials section and
> has a few issues that should be fix in order to help our (future) users
> getting started with Flink.
> I propose to add a single "Tutorials" section to the documentation where
> users find step-by-step guides. The tutorials section help users with
> different goals:
> * Get a quick idea of the overall system
> * Implement a DataStream/DataSet/Table API/SQL job
> * Set up Flink on a local machine (or run a Docker container)
> There are already a few guides to get started but they are located at
> different places and should be moved into the Tutorials section. Moreover,
> some sections such as "Project Setup" contain content that addresses users
> with very different intentions.
> I propose to
> * add a new Tutorials section and move all existing tutorials there (and
> later add new ones).
> * move the "Quickstart" section to "Tutorials".
> * remove the "Project Setup" section and move the pages to other sections
> (some pages will be split up or adjusted).
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
