[jira] [Created] (FLINK-8293) Rework Flink's type and serialization docs

[Shang Yuanchun (Jira)]

Timo Walther created FLINK-8293:
-----------------------------------

             Summary: Rework Flink's type and serialization docs
                 Key: FLINK-8293
                 URL: https://issues.apache.org/jira/browse/FLINK-8293
             Project: Flink
          Issue Type: Improvement
          Components: Documentation, Type Serialization System
            Reporter: Timo Walther
            Assignee: Timo Walther


The documentation about Flink's type and serialization system hasn't been updated for a while and there are a lot of users (especially beginners) that have problems with defining types for inputs, functions, state etc. We should rework the documentation a little bit to solve things like:

Type related things:
{code}
"Document all data types.
What TypeInfo is available? What are the limitation? Encourage TypeHints? returns()? Link to new Types class. How to declare a valid case class in Scala.
Look into log if type is no POJO type (e.g. when using org.json4s)
ResultTypeQueryable documentation
Case classes and Tuples do not support null!
Subtypes of POJOs are handled during runtime or via cache and registerType()
Explain all methods in ExecutionConfig.
Compatibility guarantees.
Pojos must have a void setter. Why are we so strict?
Update docs in api_concepts about types (Avro is not used for POJOs)!"
{code}

Serialization related things:
{code}
"Serialization overview. Big picture (what is serialized, how, why, where, when?).
When/why should I register a type or a subtype -- what does that do?
Link to ""Streaming/Working with State/Custom Serialization for Managed State""."
{code}






--
This message was sent by Atlassian JIRA
(v6.4.14#64029)