You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2017/08/04 09:01:01 UTC
[jira] [Commented] (FLINK-7370) rework operator documentation
[ https://issues.apache.org/jira/browse/FLINK-7370?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16114140#comment-16114140 ]
ASF GitHub Bot commented on FLINK-7370:
---------------------------------------
GitHub user NicoK opened a pull request:
https://github.com/apache/flink/pull/4477
[FLINK-7370][docs] rework the operator documentation structure
## What is the purpose of the change
Improve the docs by re-structuring the operators documentation.
## Brief change log
- create category `Streaming/Operators`
- move `Streaming/Overview/DataStream Transformations` to `Streaming/Operators/Overview`
- move `ProcessFunction`, `Windows`, and `Async IO` to `Streaming/Operators`
- update previous links in the documentation
- create any necessary redirects for old URLs
## Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): (no)
- The public API, i.e., is any changed class annotated with `@Public(Evolving)`: (no)
- The serializers: (no)
- The runtime per-record code paths (performance sensitive): (no)
- Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Yarn/Mesos, ZooKeeper: (no)
## Documentation
- Does this pull request introduce a new feature? (no)
- If yes, how is the feature documented? (not applicable)
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/NicoK/flink flink-7370
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/4477.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #4477
----
commit ce4f1ce928e6d21131b23cbc96c85a63adfaf941
Author: Nico Kruber <ni...@data-artisans.com>
Date: 2017-08-04T08:56:58Z
[FLINK-7370][docs] rework the operator documentation structure
- create category `Streaming/Operators`
- move `Streaming/Overview/DataStream Transformations` to `Streaming/Operators/Overview`
- move `ProcessFunction`, `Windows`, and `Async IO` to `Streaming/Operators`
- update previous links in the documentation
- create any necessary redirects for old URLs
----
> rework operator documentation
> -----------------------------
>
> Key: FLINK-7370
> URL: https://issues.apache.org/jira/browse/FLINK-7370
> Project: Flink
> Issue Type: Improvement
> Components: Documentation, Streaming
> Affects Versions: 1.3.0, 1.4.0
> Reporter: Nico Kruber
> Assignee: Nico Kruber
>
> The structure of the operator documentation could be improved the following way:
> - Create category {{Streaming/Operators}}.
> - Move {{Streaming/Overview/DataStream Transformations}} to {{Streaming/Operators/Overview}}.
> - Move {{ProcessFunction}}, {{Windows}}, and {{Async IO}} to {{Streaming/Operators}}
> - create any necessary redirects for old URLs
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)