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/07/31 18:25:00 UTC
[jira] [Commented] (FLINK-7301) Rework state documentation
[ https://issues.apache.org/jira/browse/FLINK-7301?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16107731#comment-16107731 ]
ASF GitHub Bot commented on FLINK-7301:
---------------------------------------
GitHub user twalthr opened a pull request:
https://github.com/apache/flink/pull/4441
[FLINK-7301] [docs] Rework state documentation
## What is the purpose of the change
*This PR restructures state related documentation pages. It introduces some state introduction page and moves some files (from `setup/` to `ops/`) according to the new documentation structure.*
## Brief change log
*Documentation changes only.*
## Verifying this change
*Built with built script and links checked.*
## 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/twalthr/flink FLINK-7301
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/4441.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 #4441
----
commit b53e758216364903f211277052dbba4ae99da7d3
Author: twalthr <tw...@apache.org>
Date: 2017-07-31T18:14:31Z
[FLINK-7301] [docs] Rework state documentation
----
> Rework state documentation
> --------------------------
>
> Key: FLINK-7301
> URL: https://issues.apache.org/jira/browse/FLINK-7301
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
> Reporter: Timo Walther
> Assignee: Timo Walther
>
> The documentation about state is spread across different pages, but this is not consistent and it is hard to find what you need. I propose:
> "Mention State Backends and link to them in ""Streaming/Working with State"".
> Create category ""State & Fault Tolerance"" under ""Streaming"". Move ""Working with State"", ""Checkpointing"" and ""Queryable State"".
> Move API related parts (90%) of ""Deployment/State & Fault Tolerance/State Backends"" to ""Streaming/State & Fault Tolerance/State Backends"".
> Move all tuning things from ""Debugging/Large State"" to ""Deployment/State & Fault Tolerance/State Backends"".
> Move ""Streaming/Working with State/Custom Serialization for Managed State"" to ""Streaming/State & Fault Tolerance/Custom Serialization"" (Add a link from previous position, also link from ""Data Types & Serialization"")."
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)