[FLINK-24483] Document what is Public API and what compatibility guarantees Flink is providing

• Type: Sub-task
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: 1.14.0, 1.12.5, 1.13.2
• Component/s: API / DataStream, Documentation, Table SQL / API
• Assignee: Unassigned
• Reporter: Piotr Nowojski
• Created: 08/Oct/21 10:09
• Updated: 14/Jun/22 07:09

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 (backward?) functional/compile/binary compatibility for @Public interfaces?

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

Issue Links

• links to: FLIP-196