...
| Page properties | |
|---|---|
|
...
|
...
|
...
|
Motivation
Apache Flink’s documentation has grown a lot over the years. Some features are better documented than others; some content is outdated or become irrelevant over time. With this FLIP we would like to coordinate the efforts to restructure, improve and update our documentation.
...
We propose a complete overhaul of the structure of our documentation; expanding, improving, and bringing up to date all sections.
Top-Level Structure
Current (moved to) | Target |
|
|
Getting Started is targeted to new users, who want to get up and running quickly. It will contain quickstarts and example walkthroughs for the two main APIs: DataStream & TableAPI/SQL. Interactive Docker compose playgrounds would be great to have as well: 1) SQL CLI setup (like the SQL training, 2) Flink+ Kafka + a job jar to submit, savepoint, restart, etc via Web UI / REST..
...
The Table API has the additional concept of “Dynamic Tables”. Since this “Concept” is only relevant to that API, we propose to introduce it in APIs -> Table API / SQL.
APIs
Current | Target |
|
|
Remarks:
- Project Build Setup is removed from APIs and moved Getting Started -> Project Setup.
- Libraries is moved top-level.
- Basic API Concepts & Data Types & Serialization are mostly moved to DataStream API.
- Best Practices can be removed completely
...