इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- Linux फ़ाउंडेशन
- तकनीकी लेखक:
- बोरॉन
- प्रोजेक्ट का नाम:
- शुरू करने के लिए उपलब्ध पेजों और डेवलपर गाइड को फिर से तैयार करें और उन्हें होस्ट करने वाले और जनरेट करने के तरीके को फिर से तैयार करें.
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
संक्षेप :
प्रॉडक्ट या सेवा का इस्तेमाल करने में असली उपयोगकर्ताओं और डेवलपर की मदद करने के लिए, दस्तावेज़ डिज़ाइन किए गए हैं. अच्छे दस्तावेज़ बहुत ज़रूरी हैं, क्योंकि इससे उपयोगकर्ताओं को सॉफ़्टवेयर इस्तेमाल करने का तरीका, उसकी सुविधाओं, सुझाव, और तरकीबों के बारे में जानकारी मिलती है. साथ ही, सॉफ़्टवेयर इस्तेमाल करते समय आने वाली आम समस्याओं को हल किया जा सकता है. इससे सहायता शुल्क भी कम हो जाता है और यह प्रॉडक्ट की कॉर्पोरेट और ओपन सोर्स पहचान का हिस्सा होता है : एक अच्छा दस्तावेज़, प्रॉडक्ट और डेवलपर टीम की सेहत का प्रतीक है.
अच्छे दस्तावेज़ के बिना, हो सकता है कि उपयोगकर्ता को ऊपर दिए गए कामों को असरदार और बेहतर तरीके से करने का तरीका न पता हो. किसी प्रॉडक्ट की सफलता को बेहतर बनाने में दस्तावेज़ अहम भूमिका निभा सकते हैं. इसकी वजह यह है कि अच्छी बातचीत, किसी भी कारोबार या प्रॉडक्ट का अहम हिस्सा होती है और हमेशा अहम होती है. एक बेहतरीन दस्तावेज़ के लिए यह ज़रूरी है कि वह आसानी से बातचीत कर सके और उसे आसानी से मैनेज कर सके, ताकि सभी लोग उसे आसानी से ऐक्सेस कर सकें.
हर दस्तावेज़ साइट को अच्छे बिल्डिंग और होस्टिंग वर्कफ़्लो पाइपलाइन की ज़रूरत होती है. यह एजीएल जैसे संगठन में होता है, जिसमें कई वर्शन और जानकारी देने वाले बहुत सारे दस्तावेज़ होते हैं. दस्तावेज़ फ़ाइलें (मार्कडाउन), अलग-अलग डेटा स्टोर करने की जगहों में फैलाई गई होती हैं. इससे उन्हें मैनेज करने और अपडेट करने का काम बहुत मुश्किल और समय लगता है.
वर्तमान स्थिति :
- AGL दस्तावेज़ की वेबसाइट, डेटा स्टोर करने की अलग-अलग जगहों से फ़ेच की गई, Markdown फ़ाइलों के कलेक्शन पर आधारित होती है.
- फ़िलहाल, दस्तावेज़ पेज कोर्डोवा प्रोजेक्ट के इंजन का इस्तेमाल करके, अलग-अलग सोर्स में मार्कडाउन के तौर पर होस्ट किया जाता है.
- इससे दस्तावेज़ बनाने और होस्ट करने की प्रोसेस के लिए, चार डेटा स्टोर करने की जगह सेटअप होती है :
- Docs-webtemplate [https://github.com/automotive-grad-linux/docs-webtemplate] : इसमें Jekyll की वेबसाइट का टेंप्लेट शामिल होता है.
- Docs-tools [https://github.com/automotive-grad-linux/docs-tools] : इसमें Markdown फ़ाइलों की मदद से अपने-आप तकनीकी वेबसाइट जनरेट करने वाले टूल शामिल होते हैं.
- Docs-sources [https://github.com/automotive-grad-linux/docs-sources] : सामान्य दस्तावेज़ों, गाइड के लिए सोर्स (markdowns [https://github.com/automotive-grad-linux/docs-sources/tree/master/docs]).
- Docs-gh-pages [https://github.com/automotive-grad-linux/docs-gh-pages] : दस्तावेज़ साइट [https://gist.github.com/growupboron/docs.automotivelinux.org] के लिए GitHub पेजों का डेटा स्टोर करने के लिए डिप्लॉय किया गया.
- Docs-टूल [https://github.com/automotive-grad-linux/docs-tools] में यह टूल (स्क्रिप्ट) उपलब्ध होता है. इसकी मदद से, सभी मार्कडाउन फ़ाइलों को इकट्ठा और टेंप्लेट किया जाता है. ये फ़ाइलें, docs-webtemplate [https://github.com/automotive-grad-linux/docs-webtemplate] के मुताबिक होती है.
- agl दस्तावेज़ वेबसाइट जनरेट करने का मौजूदा वर्कफ़्लो : current_workflow [https://drive.google.com/file/d/1OSwkVWFcsajgCOjbtdPf42EIfpidUJ0U/view?usp=sharing]
- सेक्शन_version.yml में किताब की सभी yaml फ़ाइलों के लिंक होते हैं. यह रिमोट रिपॉज़िटरी से सभी किताब yaml फ़ाइलों को docs-webtemplate [https://github.com/automotive-grad-linux/docs-webtemplate] पर फ़ेच करता है. किताब की yaml फ़ाइलों में रिमोट रिपॉज़िटरी की आपकी Markdown फ़ाइलों के सभी यूआरएल मौजूद होते हैं.
- जैसे ही सभी Markdown फ़ाइलें फ़ेच हो जाती हैं, वैसे ही टूल की प्रोसेस, Docs-gh-पेजों [https://github.com/automotive-grad-linux/docs-gh-pages] में AGL दस्तावेज़ वेबसाइट जनरेट कर देती है.
- पाइपलाइन के रखरखाव की मौजूदा प्रक्रिया उपयोगकर्ता और डेवलपर के हिसाब से सही नहीं है, खास तौर पर योगदान देने वाले नए लोगों के लिए. डेवलपर के लिए, दस्तावेज़ बनाने और उन्हें डिप्लॉय करने के वर्कफ़्लो को बनाए रखने के बजाय, दस्तावेज़ वाले हिस्से पर फ़ोकस करने के लिए, इस वर्कफ़्लो पाइपलाइन (बनाने और होस्टिंग की) को आसान और व्यवस्थित तरीके से बनाया जा सकता है.