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