[
https://issues.apache.org/jira/browse/FLINK-10153?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16582484#comment-16582484
]
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_r210588192
##########
File path: docs/building/index.md
##########
@@ -1,10 +1,10 @@
---
section-break: true
-nav-title: '<i class="fa fa-cogs title maindish" aria-hidden="true"></i>
Project Setup'
-title: "Project Setup"
-nav-id: "start"
+nav-title: '<i class="fa fa-cogs title dessert" aria-hidden="true"></i>
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:
[email protected]
> 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)
