[
https://issues.apache.org/jira/browse/FLINK-10153?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16581775#comment-16581775
]
ASF GitHub Bot commented on FLINK-10153:
----------------------------------------
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
> 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)
