หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- Apache Cassandra
- นักเขียนเชิงเทคนิค
- dvohra
- ชื่อโปรเจ็กต์:
- อัปเดตเอกสาร Apache Cassandra 4.0 และแก้ไขสิ่งที่ต้องทำในเอกสาร
- ระยะเวลาของโปรเจ็กต์
- ดำเนินงานมาอย่างยาวนาน (5 เดือน)
คำอธิบายโปรเจ็กต์
โปรเจ็กต์ประกอบด้วยโปรเจ็กต์ย่อย 2 รายการ ดังนี้
1. การอัปเดตเอกสารประกอบ Apache Cassandra 4.0
ตรวจสอบและอัปเดตเอกสารประกอบ Apache Cassandra ที่มีอยู่เพื่อให้สอดคล้องกับรุ่น Apache Cassandra 4.0 ที่กำลังจะเปิดตัว
แนวทางที่เราเสนอ
คือเราจะส่งคำขอไปยังรายชื่ออีเมล cassandra-dev
เพื่อให้ผู้มีส่วนร่วมของ Cassandra ไฮไลต์ส่วนต่างๆ ของเอกสาร
ที่ต้องอัปเดต ประการที่ 2 เราจะจัด
การตรวจสอบเอกสารประกอบที่มีอยู่อย่างเป็นระบบเพื่อระบุช่องโหว่ที่อาจเกิดขึ้น ตัวอย่างเช่น ในการตรวจสอบแบบมีโครงสร้าง นักเขียนเนื้อหาทางเทคนิคอาจเปรียบเทียบ
เอกสารประกอบเกี่ยวกับไฟล์การกําหนดค่า Cassandra
(http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html)
กับตัวเลือกการกําหนดค่าที่มีอยู่ในซอร์สโค้ดจริง
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java)
2. แก้ไข TODO ในเอกสารประกอบ Apache Cassandra
เอกสารประกอบของ Apache Cassandra มีหัวข้อหลายส่วน
ที่ไฮไลต์เป็น "TODO" (หรืองานที่ยังไม่ได้ทํา) ได้แก่
- การดำเนินการกับ Cassandra / การสำรองข้อมูล
- การดำเนินการ Cassandra / การโหลดจำนวนมาก
- CQL / คำจำกัดความของข้อมูล (จุดตรวจสอบแบบจำกัด)
- การสร้างโมเดลข้อมูล
- ไดนาโม / ข่าวซุบซิบ การตรวจจับความล้มเหลว และแหวนโทเค็น
- สถาปัตยกรรม/การรับประกัน
- การดำเนินการกับ Cassandra/คำแนะนำ
- สถาปัตยกรรม/ภาพรวม (เราขอแนะนำให้ทำเป็นโปรเจ็กต์แยกต่างหาก)
- การดําเนินการ Cassandra/การซ่อมการอ่าน
- สมาชิกหลายคนในชุมชนได้จัดทำสื่อเพื่อดูแลหัวข้อเหล่านี้ (รวมถึงบล็อกโพสต์สาธารณะ โพสต์ใน Stack Overflow เป็นต้น) วิธีที่ดีที่สุดในการเขียนส่วนเหล่านี้ให้เสร็จสมบูรณ์อาจเป็นการขอข้อมูลอ้างอิงและเนื้อหาที่เป็นประโยชน์จากรายชื่ออีเมล แล้วนำมารวบรวมเป็นเอกสารที่กระชับของชุดเอกสารประกอบ Apache Cassandra