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 Phần Google 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 các việc cần làm trong tài liệu
- Thời lượng dự án:
- Lâu dài (5 tháng)
Mô tả dự án
Dự án bao gồm 2 dự án phụ như sau:
1. 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ó về 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
phương pháp giải quyết vấn đề này trước tiên, gọi điện đến danh sách gửi thư cassandra
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 một bài đánh giá có cấu trúc
về 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 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 Apache Cassandra
Tài liệu về Apache Cassandra có chứa một số phần
được đánh dấu là "TODO" (hoặc các nhiệm vụ chưa hoàn thành). Đó là:
- Vận hành Cassandra / Sao lưu
- Vận hành Cassandra / Tải hàng loạt
- CQL / Định nghĩa dữ liệu (điểm đánh giá hạn chế)
- 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/Bảo đảm
- Hoạt động Cassandra/Gợi ý
- Kiến trúc/Tổng quan (đề xuất dưới dạng một dự án riêng biệt)
- Vận hành Cassandra/Sửa chữa đọc sách
- Nhiều thành viên của cộng đồng đã tạo tài liệu để đề cập đến 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.). Cách tiếp cận hiệu quả nhất để hoàn thành các phần này có thể là yêu cầu các tài liệu tham khảo và tài liệu thích hợp 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 thuộc bộ tài liệu Apache Cassandra.