本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- Apache Flink
- 技術撰稿人：
- haseeb1431
- 專案名稱：
- Apache Flink 的 Table API 和 SQL 說明文件擴充功能
- 專案長度：
- 標準長度 (3 個月)
Project description
我在「擴充 Table API 和 SQL 說明文件」中提交 GSOD 的申請書，我們會撰寫 API 說明文件，讓奶奶也能撰寫查詢。雖然我們可能已經有架構，但我們會以新手使用者的角度檢視，並在必要時提供建議。我打算與導師密切合作，瞭解他們的思考過程，並根據先前的業界經驗分享不同的想法。
根據目前的說明文件，我們初步認為：
總覽頁面目前提供大量資訊，但需要重新檢視並重新排序，讓初學者和進階使用者都能快速上手。我的想法是開始從不同的可能測試群組著手，a) 開始建立新專案，然後在該專案上方執行查詢、b) 針對現有專案，同時執行 SQL 或 Table API 查詢。
我們也需要在到達網頁上提供完整的 API 說明文件地圖，讓使用者一目瞭然。這項功能是目前總覽頁面「下一步」部分的改良版。
概念頁面內容相當不錯，但內容太多，因此我們會在這個頁面中加入一些子部分。同樣地，其他專區規劃工具、內建功能、連接器也可能需要更多瀏覽權限，例如總覽頁面或左側的導覽列。連接器頁面可分為更多子區段，例如連接器、格式等。系統 (內建) 函式看起來不錯，因為我們在單一頁面上提供所有可能的方法，使用者可以隨時將這些方法當作作弊手冊參考，但我們很樂意針對此內容新增更多內容。
這段三個月的時間會分為不同階段。我們會先建立資料表與 SQL API 說明文件的結構，類似於 Sitemap。我們將推出子章節並介紹前文提到的故事線。完成後，我們就能向進階使用者及初級使用者審查內容。另一方面，我們可以開始撰寫有關企劃書和連接器的內容，同時等待您的意見回饋。收到您的意見回饋後，我們會重新調整 API 說明文件。接下來，我們將專注於完成待處理的部分。最後，如果時間允許，我打算從頭開始建立範例，並展示可用於 FLINK-12639 的端對端專案實作項目。
我建議在 2 週後，我們可以透過 Slack (或其他工具) 進行 1 小時的會議，我會提供初步的專案時間表，其中包含預計的週數，方便我們每週追蹤專案進度。
最後，這份說明文件和 medium.com 上的網誌十分類似，我們會在這裡學習 Flink API 的各項功能，並新增所有基本資料。我會透過實際導入方式驗證說明文件，而非僅撰寫技術文件，這也讓我成為獨特的候選人。這個專案對我來說是雙面刃，因為我會在學習 Table 和 SQL API 的同時，為開放原始碼文件做出貢獻。