इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- FreeBSD प्रोजेक्ट
- टेक्निकल राइटर:
- Larry
- प्रोजेक्ट का नाम:
- FreeBSD हैंडबुक में अपडेट
- प्रोजेक्ट की अवधि:
- लंबे समय तक चलने वाला (पांच महीने)
प्रोजेक्ट का विवरण
GSoD2020 प्रोजेक्ट में, FreeBSD हैंडबुक के दो चैप्टर शामिल होंगे:
- टेस्टिंग: FreeBSD डेवलपर हैंडबुक में नया चैप्टर
- LDAP: अपडेट किए गए लेख को FreeBSD हैंडबुक के चैप्टर में मर्ज कर दिया गया है
टेस्टिंग: FreeBSD Developers की हैंडबुक में नया चैप्टर:
ध्यान दें: शुरुआत में यह प्रोजेक्ट ज़्यादा एक्सप्लोरेशन वाला है. कॉन्टेंट लिखने के दौरान, ज़रूरी शर्तें बदल सकती हैं.
तैयारी के टास्क में ये शामिल हैं: * FreeBSD और अन्य बीएसडी के लिए, डेवलपर टेस्टिंग फ़्रेमवर्क, तरीकों वगैरह के मौजूदा दस्तावेज़ों और नोट की समीक्षा करना. * FreeBSD के मौजूदा या पुराने दस्तावेज़ और नोट. उदाहरण के लिए: * TestSuite: https://wiki.freebsd.org/TestSuite * पुराना ""TestingFreeBSD"" पेज: https://wiki.freebsd.org/TestingFreeBSD * इससे जुड़े प्रोजेक्ट के मौजूदा दस्तावेज़ और नोट. उदाहरण के लिए: * http://wiki.netbsd.org/tutorials/atf/ * इसमें शामिल टूल के प्राथमिक दस्तावेज़. उदाहरण के लिए: * Kyua टेस्टिंग फ़्रेमवर्क: https://github.com/jmmv/kyua/ * ऑटोमेटेड टेस्टिंग फ़्रेमवर्क (ATF): https://github.com/jmmv/atf/ * काम के फ़्रेमवर्क को इंस्टॉल और कॉन्फ़िगर करना, ताकि इनके बारे में जानकारी मिल सके. * मौजूदा टेस्ट चलाने के लिए, टेस्टिंग फ़्रेमवर्क का इस्तेमाल करना. * कुछ नए टेस्ट लिखना. * (बहुत ज़रूरी) लोगों (सॉफ़्टवेयर डेवलपर और टेस्टर) से इस बारे में सलाह लेना कि वे चैप्टर में क्या देखना चाहते हैं.
दस्तावेज़ों का सही क्रम तय करना है. हालांकि, चैप्टर को पढ़ने के बाद, पाठक को कम से कम ये काम करने चाहिए:
- FreeBSD की जांच करने के लिए, टेस्टिंग फ़्रेमवर्क इंस्टॉल और कॉन्फ़िगर करें.
- टेस्टिंग फ़्रेमवर्क के लिए कोई टेस्ट लिखें.
- टेस्टिंग फ़्रेमवर्क में कोई टेस्ट चलाएं.
जहां भी हो सकेगा वहां इन पर ज़ोर दिया जाएगा: * टेस्ट इन्फ़्रास्ट्रक्चर सेट अप करने, टेस्ट लिखने, और टेस्ट चलाने में लगने वाले समय को कम करने के लिए, ऑटोमेशन का ज़्यादा से ज़्यादा इस्तेमाल करना. * जब भी कोई नई गड़बड़ी ठीक की जाती है, तो टेस्ट केस जोड़ना. * ज़्यादा जानकारी वाली ऑटोमेटेड रिग्रेशन टेस्टिंग. * (जहां लागू हो) स्टैंडर्ड टेस्टिंग से जुड़े उदाहरण शामिल करता है. जैसे, यूनिट टेस्टिंग, फ़ंक्शनल टेस्टिंग, लोड टेस्टिंग वगैरह.
जहां तक हो सके, हमारा मकसद सिर्फ़ डेवलपर को टेस्टिंग फ़्रेमवर्क के बारे में बताना और उसे गाइड करना नहीं है. हम यह भी चाहते हैं कि इस प्रोसेस को जितना हो सके उतना आसान बनाया जाए, ताकि डेवलपर ज़्यादा टेस्टिंग शामिल कर सकें और नए डेवलपर भी योगदान दे सकें.
LDAP: FreeBSD हैंडबुक के चैप्टर में अपडेट किया गया लेख मर्ज किया गया:
टेस्टिंग वाले चैप्टर के मुकाबले, एलडीपी के बारे में अपडेट किए गए लेख या चैप्टर का दायरा अच्छी तरह से समझा जा सकता है.
FreeBSD हैंडबुक के मौजूदा चैप्टर और इस लेख, दोनों में बहुत काम की जानकारी दी गई है. हालांकि, उन्हें अपडेट करना पड़ता है. लेख में बदलाव करने की प्रोसेस शुरू हो गई है. इसे पूरा करने के बाद, यह नया चैप्टर बन जाएगा.
इनमें ये टास्क शामिल हैं: * हैंडबुक के मौजूदा चैप्टर और मौजूदा लेख की प्रूफ़रीडिंग करना. * GSoD2020 की तैयारी के लिए, शुरुआती पास कर लिया गया है. * हैंडबुक के हर सेक्शन की जांच करके यह पुष्टि करना कि कौनसा सेक्शन काम करता है और किसमें बदलाव करने की ज़रूरत है. * GSoD2020 की तैयारी के लिए, सर्वर कॉन्फ़िगरेशन की जांच की गई है. इसमें सुधारों की पहचान की गई है. * बाकी बचे अन्य सेक्शन. * नया कॉन्टेंट लिखना और मौजूदा कॉन्टेंट में बदलाव करना. * सर्वर सेक्शन के लिए, अपडेट किया गया कॉन्टेंट दिखाना शुरू किया गया है. इसे पूरा करना ज़रूरी है. * बाकी बचे अन्य सेक्शन. * फ़ाइनल ड्राफ़्ट पूरा होने के बाद, सभी कॉन्टेंट को FreeBSD सिस्टम पर टेस्ट करना. * यह टास्क बेहद अहम है, क्योंकि इससे पता चलता है कि डेटा में कोई कमी है या नहीं.
आखिरी लेख या हैंडबुक के चैप्टर में ये सेक्शन शामिल होने चाहिए:
(1) LDAP के बारे में जानकारी (2) सर्वर कॉन्फ़िगरेशन: (a) FreeBSD पर, बुनियादी लेकिन काम करने वाले OpenLDAP सर्वर कॉन्फ़िगरेशन के बारे में जानकारी देने वाला वॉकथ्रू. (b) OpenLDAP सर्वर के बुनियादी, लेकिन काम करने वाले कॉन्फ़िगरेशन का पूरा उदाहरण, जैसे कि FreeBSD पर (2a) का नतीजा.
""सामान्य लेकिन काम करने वाला"" में, हैश किए गए पासवर्ड के साथ सर्वर का कॉन्फ़िगरेशन, नेटवर्क पर सुरक्षित कनेक्शन, और उपयोगकर्ता के डेटा का सिम्युलेट किया गया, लेकिन उदाहरण के तौर पर दिखाया गया डेटा शामिल है.
(ज़रूरी नहीं - GSoD2020 के दौरान तय किया जाएगा) सर्वर कॉन्फ़िगरेशन में, FreeBSD में 389 डायरेक्ट्री सर्वर की मिलती-जुलती कवरेज भी शामिल हो सकती है. 389 डायरेक्ट्री सर्वर में, FreeBSD के साथ काम करने की सुविधा प्रयोग के तौर पर उपलब्ध थी. हालांकि, इसकी मौजूदा स्थिति की पुष्टि की जानी चाहिए.
(3) क्लाइंट कॉन्फ़िगरेशन: (a) FreeBSD पर काम करने वाले क्लाइंट कॉन्फ़िगरेशन के बारे में जानकारी देने वाला वॉकथ्रू, जो (2) में दिए गए सर्वर कनेक्शन के उदाहरण से कनेक्ट हो सकता है. (b) किसी फ़ंक्शनल क्लाइंट कॉन्फ़िगरेशन का पूरा उदाहरण, जैसे कि FreeBSD पर (3a) का नतीजा.
क्लाइंट कॉन्फ़िगरेशन सेक्शन में, इनके बारे में सब-सेक्शन शामिल होंगे: * प्लग करने लायक पुष्टि करने वाला मॉड्यूल (पीएम), जैसे कि pam_ldap, pam_mkhomedir, nss-pam-ldapd * नेम सर्विस स्विच (एनएसएस), जैसे कि nss_ldap, nss-pam-ldapd * (ज़रूरी नहीं - GSoD2020 के दौरान तय किया जाएगा) SSSD - FreeBSD में प्रोडक्शन में SSSD की स्थिति की पुष्टि की जानी चाहिए. * (ज़रूरी नहीं - GSoD2020 के दौरान तय करना) FreeIPA - FreeBSD में FreeIPA के इस्तेमाल और काम करने के तरीके की जांच करनी होगी. FreeIPA में सिर्फ़ LDAP के अलावा और भी चीज़ें शामिल हैं. इसलिए, इस हैंडबुक के चैप्टर में शामिल करने से पहले, FreeIPA कॉन्फ़िगरेशन के दायरे का आकलन करना ज़रूरी है.
(4) सुरक्षा से जुड़ी बातें * लेख के मौजूदा वर्शन में, सुरक्षा से जुड़ी बातों के बारे में एक सेक्शन शामिल है. इसमें से कुछ कॉन्टेंट को संबंधित सेक्शन में ट्रांसफ़र किया जा सकता है. हालांकि, रेफ़रंस के मकसद से, सुरक्षा से जुड़ी बातों के लिए अब भी एक खास सेक्शन होना चाहिए.
(5) समस्या हल करना * LDAP कॉन्फ़िगरेशन से जुड़ी समस्या हल करने के लिए रणनीतियां.
(6) OpenAssistant अपेंडिक्स
अपडेट किए गए हैंडबुक चैप्टर / लेख की मदद से, पाठक दो नए FreeBSD सिस्टम ले सकते हैं. साथ ही, LDAP सर्वर और LDAP क्लाइंट सेट अप कर सकते हैं और क्लाइंट की पुष्टि सर्वर के साथ कर सकते हैं.
अपडेट की गई हैंडबुक के चैप्टर या लेख को पढ़ने के बाद, पाठक के पास ज़्यादा खास या बेहतर दस्तावेज़ों को पढ़ने के लिए ज़रूरी बुनियादी जानकारी होनी चाहिए. जैसे, OpenLDAP दस्तावेज़, LDAP RFCs, और अपनी ज़रूरतों को पूरा करने के लिए FreeBSD LDAP कॉन्फ़िगरेशन को बनाना या बेहतर बनाना.