Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Apache Flink
- Người viết nội dung kỹ thuật:
- haseeb1431
- Tên dự án:
- Tài liệu về API Bảng và SQL mở rộng cho Apache Flink
- Thời lượng dự án:
- Thời hạn tiêu chuẩn (3 tháng)
Mô tả dự án
Tôi sẽ gửi đơn đăng ký tham gia GSOD về chủ đề "Mở rộng API bảng và tài liệu SQL". Chúng ta sẽ viết tài liệu API để bà cũng có thể viết truy vấn. Mặc dù có thể chúng ta đã có cấu trúc, nhưng chúng ta sẽ xem xét cấu trúc đó dưới vai trò là người dùng mới và đề xuất ý tưởng bất cứ khi nào cần thiết. Tôi dự định làm việc chặt chẽ với các cố vấn để hiểu rõ quy trình tư duy của họ, đồng thời chia sẻ nhiều ý tưởng dựa trên kinh nghiệm trước đây của tôi trong ngành.
Một số ý kiến ban đầu dựa trên tài liệu hiện tại là:
Trang tổng quan hiện có rất nhiều thông tin nhưng cần được xem xét lại và sắp xếp sao cho cả người dùng mới và người dùng nâng cao đều có thể bắt đầu nhanh chóng. Ý tưởng của tôi là bắt đầu với nhiều kênh có thể, a) bắt đầu một dự án mới rồi chạy các truy vấn trên đó, b) chạy các truy vấn SQL hoặc API Bảng trên một dự án hiện có.
Chúng ta cũng cần có bản đồ đầy đủ về tài liệu API trên trang đích để người dùng có thể xem tất cả các khả năng ngay từ cái nhìn đầu tiên. Đây sẽ là phiên bản cải tiến của phần "Bước tiếp theo" trên trang tổng quan hiện tại.
Trang khái niệm có nội dung khá hay nhưng lại bị nhồi nhét quá nhiều vào một trang nên chúng ta sẽ có ít tiểu mục trên trang này. Tương tự, các phần khác như Trình lập kế hoạch, Hàm tích hợp, Trình kết nối cần hiển thị nhiều hơn có thể trên trang tổng quan hoặc thanh điều hướng bên trái. Trang Trình kết nối có thể được chia thành nhiều mục phụ hơn, chẳng hạn như trình kết nối, định dạng, v.v. Tôi thấy các hàm Hệ thống (Tích hợp) ổn vì chúng ta có tất cả các phương thức có thể có trên một trang và người dùng có thể tham khảo các hàm này như bảng tra cứu mọi lúc, nhưng tôi rất sẵn lòng thêm nội dung khác liên quan đến các hàm này.
Khoảng thời gian 3 tháng này sẽ được chia thành nhiều giai đoạn. Ban đầu, chúng ta sẽ tạo một cấu trúc (chẳng hạn như sơ đồ trang web) của tài liệu về API Bảng và SQL. Chúng ta sẽ giới thiệu các mục phụ và giới thiệu các dòng câu chuyện như đã chia sẻ ở trên. Sau khi bạn hoàn thành khoá học, chúng tôi có thể yêu cầu người dùng ở trình độ cao cấp và người mới bắt đầu đánh giá khoá học đó. Mặt khác, chúng ta có thể bắt đầu viết về trình lập kế hoạch, trình kết nối trong khi chờ ý kiến phản hồi. Sau khi nhận được ý kiến phản hồi, chúng tôi sẽ tái cấu trúc tài liệu API. Tiếp theo, chúng ta sẽ tập trung hoàn tất nội dung cho các phần đang chờ xử lý. Cuối cùng, nếu có thời gian, tôi dự định sẽ lấy một ví dụ từ đầu và trình bày cách triển khai dự án toàn diện có thể được tận dụng cho FLINK-12639.
Tôi đề xuất chúng ta có thể họp trong 1 giờ sau 2 tuần, thay vì trò chuyện trên Slack (hoặc bất kỳ công cụ nào khác). Tôi sẽ chia sẻ tiến trình dự án ban đầu với các tuần dự kiến. Điều này cũng sẽ giúp chúng ta theo dõi tiến trình dự án hằng tuần.
Cuối cùng, tài liệu này tương tự như blog của chúng tôi trên medium.com, trong đó chúng tôi thêm tất cả thông tin cơ bản khi tìm hiểu các chức năng khác nhau của Flink API. Điều này cũng khiến tôi trở thành một ứng cử viên duy nhất vì tôi sẽ xác minh tài liệu bằng các triển khai thực tế thay vì chỉ viết tài liệu kỹ thuật. Dự án này sẽ là một con dao hai lưỡi đối với tôi vì tôi sẽ đóng góp vào tài liệu nguồn mở trong khi tìm hiểu về API Bảng và SQL.