[FLINK-34677] Refactor the structure of documentation for Flink CDC

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: cdc-3.1.0
• Fix Version/s: cdc-3.1.0
• Component/s: Documentation, Flink CDC
• Labels: pull-request-available
• Assignee: Qingsheng Ren
• Reporter: Qingsheng Ren
• Created: 15/Mar/24 02:57
• Updated: 25/Mar/24 08:02
• Resolved: 25/Mar/24 08:02

Description

The documentation structure of Flink CDC is not quite in good shape currently. We plan to refactor it as below (✅ for existed pages and 🖊️  for new pages to write):

• Get Started
  • 🖊️ Introduction
  • ✅ Quickstart
• Core Concept
  • 🖊️ (Pages for data pipeline / sources / sinks / table ID / transform / route)
• Connectors
  • 🖊️ Overview
  • ✅ (Pages for connectors)
  • ✅ Legacy Flink CDC Sources (For CDC sources before 3.0)
• Deployment
  • 🖊️ Standalone
  • 🖊️ Kubernetes
  • 🖊️ YARN
• Developer Guide
  • 🖊️ Understand Flink CDC API
  • 🖊️ Contribute to Flink CDC
  • 🖊️ Licenses
• FAQ
  • ✅ Frequently Asked Questions

Issue Links

• links to: GitHub Pull Request #3146
• links to: GitHub Pull Request #3169

Sub-Tasks

• Home Page of Flink CDC Documentation: Resolved
• "Introduction" Page for Flink CDC Documentation: Resolved
• "Core Concept" Pages for Flink CDC Documentation: Resolved
• "Connectors - Overview" Page for Flink CDC Documentation: Resolved
• "Developer Guide - Understanding Flink CDC API" Page for Flink CDC Documentation: Closed
• "Developer Guide - Contribute to Flink CDC" Page for Flink CDC Documentation: Resolved
• "Developer Guide - Licenses" Page for Flink CDC Documentation: Resolved
• "Deployment - Standalone" Page for Flink CDC Documentation: Resolved
• "Deployment - Kubernetes" Page for Flink CDC Documentation: Resolved
• "Deployment - YARN" Page for Flink CDC Documentation: Resolved
• Update Flink website to point to the new Flink CDC “Get Started” page: Resolved
• Update the content of README.md in FlinkCDC project: Resolved
• Add document dead link check for Flink CDC Documentation: Resolved