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