flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FLINK-10153) Add tutorial section to documentation
Date Thu, 16 Aug 2018 13:01:00 GMT

    [ https://issues.apache.org/jira/browse/FLINK-10153?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16582470#comment-16582470

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_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
 Review comment:
   Please note that link to `{base-url}/quickstart/run_example_quickstart.html#writing-a-flink-program`
in this page is broken because you move it.
   There might be other such broken links, please check :-)

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:

> 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
> * 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

View raw message