หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- อาปาเช่ คาสซันดรา
- ผู้เขียนด้านเทคนิค:
- ดีโวห์รา
- ชื่อโปรเจ็กต์:
- การอัปเดตเอกสารประกอบ Apache Cassandra 4.0 และแก้ไขสิ่งที่ต้องทำในเอกสารประกอบ
- ระยะเวลาของโปรเจ็กต์:
- วิ่งเป็นเวลานาน (5 เดือน)
คำอธิบายโปรเจ็กต์
โปรเจ็กต์ประกอบด้วยโปรเจ็กต์ย่อย 2 โปรเจ็กต์ ดังนี้
1. การอัปเดตเอกสารประกอบ Apache Cassandra 4.0
ตรวจสอบและอัปเดตเอกสารประกอบ Apache Cassandra ที่มีอยู่
เพื่อให้แน่ใจว่าสอดคล้องกับรุ่น Apache Cassandra 4.0 ที่กำลังจะเปิดตัว แนวทางที่เราเสนอ
สำหรับเรื่องนี้คือการติดต่อไปยังรายชื่ออีเมลของ Cassandra-dev
สำหรับผู้ร่วมให้ข้อมูลของ Cassandra เพื่อไฮไลต์ส่วนต่างๆ ของเอกสาร
ที่จำเป็นต้องอัปเดต ในลำดับที่ 2 เราจะรวบรวมการตรวจสอบ
เอกสารที่มีอยู่อย่างมีโครงสร้างเพื่อระบุช่องว่างที่อาจเกิดขึ้น เช่น
ตัวอย่าง: ในการตรวจสอบที่มีโครงสร้าง ผู้เขียนด้านเทคนิคสามารถเปรียบเทียบ
เอกสารประกอบเกี่ยวกับไฟล์การกำหนดค่า 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. แก้ไขสิ่งที่ต้องทำในเอกสารประกอบของ Apache Cassandra
เอกสารประกอบ Apache Cassandra ประกอบด้วยส่วนต่างๆ
ที่ไฮไลต์เป็น "TODO" (หรืองานที่ยังไม่เสร็จสมบูรณ์) ได้แก่
- การดำเนินงาน Cassandra / การสำรองข้อมูล
- การใช้งาน Cassandra / การขนถ่ายจำนวนมาก
- CQL / คำจำกัดความของข้อมูล (คะแนนการตรวจสอบแบบจำกัด)
- การสร้างแบบจำลองข้อมูล
- Dynamo / Gossip, การตรวจจับความล้มเหลว และ Token Ring
- สถาปัตยกรรม/การค้ำประกัน
- การดำเนินการ Cassandra/คำแนะนำ
- สถาปัตยกรรม/ภาพรวม (เสนอเป็นโปรเจ็กต์แยกต่างหาก)
- การซ่อมแคสซันดรา/การซ่อมหนังสือ
- สมาชิกจำนวนมากในชุมชนได้สร้างเนื้อหาเพื่อครอบคลุมหัวข้อเหล่านี้ (รวมถึงบล็อกโพสต์สาธารณะ โพสต์ใน Stack Overflow เป็นต้น) วิธีที่มีประสิทธิภาพมากที่สุดในการดำเนินการส่วนต่างๆ เหล่านี้อาจเป็นการขอข้อมูลอ้างอิงและเนื้อหาที่ดีจากรายชื่ออีเมล และรวมเข้าด้วยกันเป็นเอกสารที่สั้นกระชับของชุดเอกสาร Apache Cassandra