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 Cassandra
- Người viết nội dung kỹ thuật:
- dvohra
- Tên dự án:
- Cập nhật tài liệu Apache Cassandra 4.0 và giải quyết việc cần làm trong tài liệu
- Thời lượng dự án:
- Chạy trong thời gian dài (5 tháng)
Mô tả dự án
Dự án bao gồm hai dự án phụ như sau:
1. Bản cập nhật tài liệu về Apache Cassandra 4.0
Xem xét và cập nhật tài liệu hiện có về Apache Cassandra để đảm bảo tài liệu đó
phù hợp với bản phát hành Apache Cassandra 4.0 sắp tới. Phương pháp
đề xuất của chúng tôi cho việc này là trước tiên, hãy đưa ra lời kêu gọi đến danh sách gửi thư cassandra-dev
để những người đóng góp cho Cassandra nêu bật các phần của tài liệu
cần cập nhật. Thứ hai, chúng tôi sẽ tổng hợp một
tài liệu hiện có để xác định những lỗ hổng tiềm ẩn. Ví
dụ: trong quy trình xem xét có cấu trúc, người viết kỹ thuật có thể so sánh
tài liệu tệp cấu hình Cassandra
(http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html)
với các tuỳ chọn cấu hình thực sự có trong nguồn
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java).
2. Giải quyết việc cần làm trong Tài liệu về Apache Cassandra
Tài liệu về Apache Cassandra chứa một số phần
được làm nổi bật là "TODO" (hoặc các tác vụ chưa hoàn thành). Đó là:
- Vận hành Cassandra / Bản sao lưu
- Vận hành Cassandra / Tải hàng loạt
- CQL / Định nghĩa dữ liệu (điểm xem xét giới hạn)
- Lập mô hình dữ liệu
- Dynamo / Gossip, Phát hiện lỗi và Vòng mã thông báo
- Kiến trúc/Bảo đảm
- Vận hành Cassandra/Gợi ý
- Cấu trúc/Tổng quan (đề xuất dưới dạng một dự án riêng)
- Vận hành Cassandra/Sửa lỗi đọc
- Nhiều thành viên trong cộng đồng đã tạo tài liệu để đề cập đến các chủ đề này (bao gồm cả bài đăng công khai trên blog, bài đăng trên Stack Overflow, v.v.). Phương pháp hiệu quả nhất để hoàn thành các phần này có thể là yêu cầu tài liệu và tài liệu tham khảo hữu ích từ danh sách gửi thư rồi tổng hợp thành một tài liệu ngắn gọn của bộ tài liệu Apache Cassandra.