Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Google Phần Tài liệu.
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:
- Sử dụng lâu 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 Apache Cassandra 4.0
Xem lại và cập nhật tài liệu hiện có của Apache Cassandra để đảm bảo rằng tài liệu này
phù hợp với bản phát hành Apache Cassandra 4.0 sắp tới. Chúng tôi đề xuất
giải pháp này trước tiên, gọi điện đến danh sách gửi thư của cassandra-dev
cho những người đóng góp cho Cassandra để nêu bật những phần cần cập nhật trong tài liệu
. Thứ hai, chúng tôi sẽ tổng hợp
đánh giá theo cấu trúc của tài liệu hiện có để xác định những thiếu sót tiềm ẩn. Ví dụ:
ví dụ: trong bài đánh giá có cấu trúc, người viết kỹ thuật có thể so sánh
tài liệu về tệp cấu hình Cassandra
(http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html)
với các lựa 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 Apache Cassandra chứa một số phần
được làm nổi bật là "TODO" (hoặc các nhiệm vụ chưa được hoàn thành). Đó là:
- Hoạt động tại Cassandra / Sao lưu
- Hoạt động Cassandra / Tải hàng loạt
- CQL / Định nghĩa dữ liệu (điểm xem xét có giới hạn)
- Mô hình hoá dữ liệu
- Dynamo / Chuyện phiếm, Phát hiện lỗi và Vòng mã thông báo
- Kiến trúc/Đảm bảo
- Cassandra/Gợi ý hoạt động
- Cấu trúc/Tổng quan (đề xuất này là một dự án riêng)
- Vận hành Cassandra/Sửa chữa đọc
- Nhiều thành viên của cộng đồng đã tạo tài liệu về các chủ đề này (bao gồm cả bài đăng trên blog công khai, bài đăng trên Stack Overflow, v.v.). Phương pháp hiệu quả nhất để hoàn thành những phần này có thể là yêu cầu tài liệu tham khảo và tài liệu phù hợp từ danh sách gửi thư và 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.