[
https://issues.apache.org/jira/browse/FLINK-9574?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16694790#comment-16694790
]
ASF GitHub Bot commented on FLINK-9574:
---------------------------------------
alpinegizmo commented on a change in pull request #7124: [FLINK-9574] [doc]
Rework documentation for custom state serializers and state evolution
URL: https://github.com/apache/flink/pull/7124#discussion_r235402519
##########
File path: docs/dev/stream/state/custom_serialization.md
##########
@@ -23,15 +23,18 @@ specific language governing permissions and limitations
under the License.
-->
-If your application uses Flink's managed state, it might be necessary to
implement custom serialization logic for special use cases.
+* ToC
+{:toc}
This page is targeted as a guideline for users who require the use of custom
serialization for their state, covering how
-to provide a custom serializer and how to handle upgrades to the serializer
for compatibility. If you're simply using
-Flink's own serializers, this page is irrelevant and can be skipped.
+to provide a custom state serializer and guidelines and best practices to
implementing serializers that allows
Review comment:
```suggestion
how to provide a custom state serializer as well as guidelines and best
practices for implementing serializers that allow
```
----------------------------------------------------------------
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 a dedicated documentation page for state evolution
> ------------------------------------------------------
>
> Key: FLINK-9574
> URL: https://issues.apache.org/jira/browse/FLINK-9574
> Project: Flink
> Issue Type: Sub-task
> Components: Documentation, State Backends, Checkpointing, Type
> Serialization System
> Reporter: Tzu-Li (Gordon) Tai
> Assignee: Tzu-Li (Gordon) Tai
> Priority: Critical
> Labels: pull-request-available
> Fix For: 1.8.0
>
>
> Currently, the only bit of documentation about serializer upgrades / state
> evolution, is
> [https://ci.apache.org/projects/flink/flink-docs-release-1.5/dev/stream/state/custom_serialization.html#handling-serializer-upgrades-and-compatibility.],
> which only explains things at an API level.
> State evolution over the time has proved to be a rather complex topic that is
> often overlooked by users. Users would probably benefit from a actual
> full-grown dedicated page that covers both API, some necessary internal
> details regarding interplay of state serializers, best practices, and caution
> notices.
> I propose to add this documentation as a subpage under Streaming/State &
> Fault-Tolerance/.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
