[FLINK-12639] FLIP-42: Rework Documentation

• Type: Improvement
• Status: In Progress
• Priority: Major
• Resolution: Unresolved
• Component/s: Documentation
• Labels: pull-request-available usability
• Assignee: Unassigned
• Reporter: Konstantin Knauf
• Created: 28/May/19 07:02
• Updated: 19/Apr/20 17:15

Issue Links

• relates to: FLINK-12537 Improve Documentation Build Time

Sub-Tasks

• Redirect Users to Documentation Homepage if Requested Resource Does Not Exist: Reopened
• Add "Style Guide" to Documentation Contribution Guide: Closed
• Add Python Table API to Table Api Walkthrough: Closed
• Glossary - Add Glossary to Concepts Section of Documentation: Resolved
• Glossary - Add Links to new Concepts Section to Glossary: Open
• Getting Started - DataStream Example Walkthrough: Resolved
• Getting Started - Table API Example Walkthrough: Closed
• Getting Started - Flink Overview: Resolved
• Getting Started - Docker Playgrounds - Flink Cluster Playground: Closed
• Rename "JobManager (Process)" to "Flink Master": Open
• Gettting Started - Docker Playground - Interactive SQL Playground: Open
• Getting Started - Add Top-Level Section to Existing Documentation: Resolved
• Expand Concept -> Glossary Section: Open
• Rename "Job Cluster" to "Application Cluster" in READMEs and Documentation: In Progress
• Remove Tutorials and Examples sections from Getting Started: Closed
• Add Overview page for Getting Started section: Resolved
• Link from Flink website to Getting Started Overview page: Closed
• Add timeout to 404 documentation redirect, add explanation: Closed
• Make documentation 404 page look like a documentation page: Closed
• In Glossary, clarify Application/Job cluster description: Closed
• Extract “Concepts” material from API/Library sections and start proper concepts section: Closed
• Move "Project Build Setup" to "Getting Started" in documentation: Closed
• Expand "popular" documentation sections by default: Closed
• Extract libraries documentation to a top-level section: Closed
• Extract connectors documentation to a top-level section: Closed
• Remove outdated "Best Practices" section from Application Development Section: Closed
• In stream processing concepts section, rework distribution patterns description: Open
• Add introduction to timely stream processing concepts documentation: Closed
• Add Latency and Completeness section in timely stream processing concepts: Closed
• Add section about applications and clusters/session in concepts documentation: Closed
• Add introduction to stream processing concepts documentation: Closed
• Describe how Flink is a unified batch/stream processing system in concepts documentation: Open
• Add "What Is State" section in concepts documentation: Closed
• Describe how state is different for stream/batch programs in concepts documentation: Open
• Expand end-to-end exactly once section in fault tolerance tutorial: Reopened
• Fold API-agnostic documentation into DataStream documentation: Closed
• Rename toplevel DataSet/DataStream section titles: Closed
• Add new Training section to Documentation: Closed
• Add Intro to DataStream API page to Training section: Closed
• Add ETL page to Training section: Closed
• Add streaming analytics page to Training section: Closed
• Add page on Event-driven Applications to Training section: Closed
• Add page on Fault Tolerance to Training: Closed
• Update docs Home page to mention Training: Closed
• Update Getting Started / Overview: training and python: Closed
• Merge concepts/stream-processing into training overview: Closed
• Rework Concepts / Stateful Stream Processing to depend on Training: Closed
• Rework Concepts / Timely Stream Processing to depend on Training: Closed
• Fold API-agnostic documentation into DataStream documentation (chinese): Open