इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- Apache Cassandra
- टेक्निकल राइटर:
- dvohra
- प्रोजेक्ट का नाम:
- Apache Cassandra 4.0 के दस्तावेज़ से जुड़ा अपडेट और दस्तावेज़ में बाकी बचे कामों को पूरा करना
- प्रोजेक्ट की अवधि:
- लंबे समय तक चलने वाला (पांच महीने)
प्रोजेक्ट का विवरण
प्रोजेक्ट में इस तरह के दो सब-प्रोजेक्ट शामिल हैं:
1. Apache Cassandra 4.0 के दस्तावेज़ से जुड़ा अपडेट
Apache Cassandra के मौजूदा दस्तावेज़ों की समीक्षा करें और उन्हें अपडेट करें. इससे यह पक्का किया जा सकेगा कि वे
Apache Cassandra के आने वाले वर्शन 4.0 के साथ अलाइन हों. हमारा सुझाव है कि
इसके लिए, Cassandra-dev को सबसे पहले कॉल करना चाहिए
कैसांद्रा के योगदान देने वालों के लिए ईमेल की सूची में दस्तावेज़ के उन हिस्सों को हाइलाइट करना होगा
जिन्हें अपडेट करने की ज़रूरत है. दूसरा, हम संभावित अंतर की पहचान करने के लिए, मौजूदा दस्तावेज़ों की स्ट्रक्चर्ड
समीक्षा करेंगे. उदाहरण के लिए: स्ट्रक्चर्ड समीक्षा में, तकनीकी लेखक
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. Apache Cassandra के दस्तावेज़ में, 'बाद में करें' सेक्शन में मौजूद कामों को पूरा करना
Apache Cassandra के दस्तावेज़ में कई सेक्शन
हैं, जिन्हें "TODO" (या ऐसे टास्क जिन्हें पूरा करना बाकी है) के तौर पर हाइलाइट किया गया है. इनके उदाहरण हैं:
- Cassandra / बैकअप को ऑपरेट करना
- Cassandra का इस्तेमाल करना / बल्क लोडिंग
- CQL / डेटा डेफ़िनिशन (समीक्षा के सीमित पॉइंट)
- डेटा मॉडलिंग
- Dynamo / Gossip, गड़बड़ी का पता लगाने की सुविधा, और टोकन रिंग
- आर्किटेक्चर/गारंटी
- Cassandra को ऑपरेट करना/सलाह
- आर्किटेक्चर/खास जानकारी (इसे एक अलग प्रोजेक्ट के तौर पर प्रस्तावित किया गया है)
- Cassandra/Read Repair को ऑपरेट करना
- समुदाय के कई सदस्यों ने इन विषयों को कवर करने के लिए सामग्री तैयार की है (सार्वजनिक ब्लॉग पोस्ट, स्टैक ओवरफ़्लो पोस्ट वगैरह). इन सेक्शन को पूरा करने का सबसे बेहतर तरीका यह हो सकता है कि मेलिंग सूचियों से अच्छे रेफ़रंस और कॉन्टेंट का अनुरोध किया जाए. इसके बाद, Apache Cassandra के दस्तावेज़ सेट को कम शब्दों में लिखा जाए.