[
https://issues.apache.org/jira/browse/FLINK-8293?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Flink Jira Bot updated FLINK-8293:
----------------------------------
Labels: auto-deprioritized-major auto-unassigned stale-minor (was:
auto-deprioritized-major auto-unassigned)
I am the [Flink Jira Bot|https://github.com/apache/flink-jira-bot/] and I help
the community manage its development. I see this issues has been marked as
Minor but is unassigned and neither itself nor its Sub-Tasks have been updated
for 180 days. I have gone ahead and marked it "stale-minor". If this ticket is
still Minor, please either assign yourself or give an update. Afterwards,
please remove the label or in 7 days the issue will be deprioritized.
> 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: API / Type Serialization System, Documentation
> Reporter: Timo Walther
> Priority: Minor
> Labels: auto-deprioritized-major, auto-unassigned, stale-minor
>
> 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
(v8.20.1#820001)
