本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Apache Flink
- 技术文档工程师：
- haseeb1431
- 项目名称：
- 扩展了 Apache Flink 的表 API 和 SQL 文档
- 项目时长：
- 标准时长（3 个月）
Project description
我要提交有关“扩展 Table API 和 SQL 文档”的 GSOD 申请。我们将编写 API 文档，让奶奶也能编写查询。虽然我们可能已经有了结构，但我们会以新手用户的身份查看该结构，并在需要时提出建议。我计划与导师密切合作，了解他们的思维过程，同时根据我之前的行业经验分享不同的想法。
根据当前文档，我们提出了一些初步想法：
概览页面目前包含大量信息，但需要重新访问和排序，以便初学者和高级用户都能快速上手。我的想法是，提供有关不同可能轨道的入门信息，a) 启动一个新项目，然后在该项目上运行查询，b) 在现有项目上运行 SQL 或 Table API 查询。
我们还需要在着陆页上提供完整的 API 文档地图，以便用户能够一眼就看到所有的可能性。它将是当前概览页面上“后续措施”部分的改进版。
概念页面上的内容非常不错，但内容过于集中，因此我们将在本页中添加较少的子部分。同样，其他部分（“规划工具”“内置函数”“连接器”）也需要在概览页面或左侧导航栏中更醒目地显示。“连接器”页面可以划分为更多子部分，例如连接器、格式等。系统（内置）函数看起来不错，因为我们在一个页面上提供了所有可能的方法，用户可以随时将其用作备忘单，但我们很乐意添加更多相关内容。
这三个月的期限将分为不同的阶段。最初，我们将创建 Table &SQL API 文档的结构，例如站点地图。我们将按照上文中介绍的内容划分小节和故事情节。完成后，我们会交由高级用户和新手用户进行评价。另一方面，我们可以在等待反馈期间开始撰写有关规划者和连接器的内容。收到反馈后，我们会重构 API 文档。接下来，我们将专注于完成待处理部分的编写。最后，如果时间允许，我打算从头开始举一个例子，展示可以用于 FLINK-12639 的端到端项目实施案例。
我建议我们在 2 周后开一个一小时的会议，而不是通过 Slack（或任何其他工具）聊天。我会分享一份初步的项目时间表，其中包含预计的周数，这有助于我们每周跟踪项目进度。
最后，本文档与我们在 medium.com 上发布的博文类似，我们在学习 Flink API 的不同功能时会在该博文中添加所有基本详细信息。这也使我成为一个独特的候选人，因为我将通过实际实现来验证文档，而不仅仅是编写技术文档。这个项目对我来说是一把双刃剑，因为我将在学习 Table 和 SQL API 的同时为开源文档做出贡献。