[jira] [Updated] (FLINK-24483) Document what is Public API and what compatibility guarantees Flink is providing

["Piotr Nowojski (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/FLINK-24483?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Piotr Nowojski updated FLINK-24483:
-----------------------------------
    Description: 
We should document:
* What constitute of the Public API, what do Public/PublicEvolving/Experimental/Internal annotations mean.
* What compatibility guarantees we are providing (forward functional, compile and binary compatibility for {{@Public}} interfaces)


A good starting point: https://cwiki.apache.org/confluence/plugins/servlet/mobile?contentId=44302796#content/view/62686683

  was:
We should document:
* What constitute of the Public API, what do Public/PublicEvolving/Experimental/Internal annotations mean.
* What compatibility guarantees we are providing (forward functional, compile and binary compatibility for {{@Public}} interfaces)


> Document what is Public API and what compatibility guarantees Flink is providing
> --------------------------------------------------------------------------------
>
>                 Key: FLINK-24483
>                 URL: https://issues.apache.org/jira/browse/FLINK-24483
>             Project: Flink
>          Issue Type: Improvement
>          Components: API / DataStream, Documentation, Table SQL / API
>    Affects Versions: 1.14.0, 1.12.5, 1.13.2
>            Reporter: Piotr Nowojski
>            Priority: Blocker
>             Fix For: 1.15.0
>
>
> We should document:
> * What constitute of the Public API, what do Public/PublicEvolving/Experimental/Internal annotations mean.
> * What compatibility guarantees we are providing (forward functional, compile and binary compatibility for {{@Public}} interfaces)
> A good starting point: https://cwiki.apache.org/confluence/plugins/servlet/mobile?contentId=44302796#content/view/62686683



--
This message was sent by Atlassian Jira
(v8.3.4#803005)