[
https://issues.apache.org/jira/browse/FLINK-10153?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16581693#comment-16581693
]
ASF GitHub Bot commented on FLINK-10153:
----------------------------------------
fhueske opened a new pull request #6565: [FLINK-10153] [docs] Add Tutorials
section and rework structure.
URL: https://github.com/apache/flink/pull/6565
## What is the purpose of the change
This PR is restructuring some parts of the documentation and mostly moving
docs pages around.
Only deprecated content is updated or removed.
- Add a *Tutorials* section to the docs where users can find tutorials to
get started with Flink.
- Remove the *Project Setup* which contains diverse content and move the
pages into the right sections
More tutorials (DataSet, Table API / SQL, Docker setup) will be added in
subsequent PRs.
## Brief change log
- Add a Tutorials section
- Move tutorial & quickstart guides into Tutorial section
- Add a "Building & Developing Flink" section for Flink contributors
- Remove Project Setup section and move content to relevant sections
- Update Examples section
## Verifying this change
- Run `./docs/build_docs.sh -i` and check the changes at `localhost:4000`.
## Does this pull request potentially affect one of the following parts:
Only changes documentation.
## Documentation
Only changes 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:
[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)
