इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- इलेक्ट्रॉन
- तकनीकी लेखक:
- मिस्टर गोल्ड
- प्रोजेक्ट का नाम:
- इलेक्ट्रॉन ट्यूटोरियल फ़्लो
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
प्रोजेक्ट की खास जानकारी
Electron, JavaScript, HTML, और CSS का इस्तेमाल करके क्रॉस-प्लैटफ़ॉर्म डेस्कटॉप ऐप्लिकेशन बनाने के सबसे लोकप्रिय टूल में से एक है. Electron पर बनाए गए ऐप्लिकेशन के कलेक्शन में करीब 900 एंट्री हैं और यह सूची लगातार बढ़ती रहती है. कुछ बेहद लोकप्रिय डेवलपर टूल, जैसे कि Visual Studio Code, Atom, Postman, Slack, GitKraken Electron पर बनाए गए हैं.
इलेक्ट्रॉन की लोकप्रियता इसके आसान लर्निंग कर्व और लो एंट्री थ्रेशोल्ड में तय होती है - JavaScript, एचटीएमएल, और सीएसएस स्टैक के बारे में जानने वाले सभी लोग अपना खुद का ऐप्लिकेशन बना सकते हैं. कुल बढ़ोतरी की दर यह बताती है कि ट्यूटोरियल बनाने की ज़रूरत है या नहीं. साथ ही, इन्हें आसानी से समझने और इस्तेमाल करने लायक शुरुआती निर्देश देने के लिए भी इनका इस्तेमाल किया जा सकता है.
इस प्रोजेक्ट का मकसद ऐसे ऐप्लिकेशन बनाने वालों को भरोसा दिलाना है जो इलेक्ट्रॉन फ़्रेमवर्क के नए हैं. साथ ही, उन्हें ग्राउंड-अप से अपने इलेक्ट्रॉन ऐप्लिकेशन बनाने का एक जैसा और व्यवस्थित अनुभव देना है.
प्रोजेक्ट की समस्याएं
Electron ट्यूटोरियल के दस्तावेज़ से जुड़ी सबसे अहम समस्याओं की सूची यहां दी गई है: 1. ऐप्लिकेशन डेवलपमेंट के चरणों के बारे में शुरुआती जानकारी साफ़ तौर पर नहीं दी गई है. साथ ही, ऐसी जानकारी जिसे काम का नहीं है 2. ऐप्लिकेशन डेवलपमेंट प्रोसेस के बारे में बिखरी हुई और ग़ैर-ज़रूरी जानकारी 3. "इस्तेमाल शुरू करना" गाइड के बेतरतीब हिस्सों के ज़रिए जानकारी का कोई एक सोर्स नहीं दिया गया है
प्रोजेक्ट का प्रस्ताव
प्रोजेक्ट के लक्ष्य और ऊपर बताई गई समस्याओं के हिसाब से, इन सुधारों की सूची यहां दी गई है: 1. मौजूदा गाइड को अपडेट करें. शुरुआती चरणों को आसान और एक जैसा बनाने के लिए, नीचे दिए गए दस्तावेज़ों को अपडेट किया जाना चाहिए. इनमें, सामान्य से ज़्यादा जटिल प्रोसेस के चरण शामिल होते हैं: - डेवलपर एनवायरमेंट - अपना पहला Electron ऐप्लिकेशन लिखना - अपने ऐप्लिकेशन में सुविधाएं जोड़ना (खास जानकारी वाला पेज बनाना) - ऐप्लिकेशन पैकेजिंग और डिस्ट्रिब्यूशन 2. डॉक्यूमेंटेशन डायरेक्ट्री फिर से बनाएं. नए डेवलपर को यह दिखाने के लिए कि शुरू करने के लिए क्या ज़रूरी है और आगे के चरणों में किसे माना जा सकता है, दस्तावेज़ पेज में चरणों के विज़ुअल और संदर्भ के हिसाब से, दोनों तरह के अलग-अलग होने चाहिए, ताकि पहले ऐप्लिकेशन को जल्द से जल्द लाइव किया जा सके. रीस्ट्रक्चर में आगे के संभावित चरणों के लिए दिशा-निर्देश भी शामिल होते हैं. 3. ऐप्लिकेशन डेवलपमेंट से जुड़े दस्तावेज़ों को व्यवस्थित और इकट्ठा करना. सभी सुविधाओं में, ऐप्लिकेशन को इंस्टॉल/चालू करने, तुरंत शुरू करने, ऐप्लिकेशन को पहली बार लॉन्च करने के बाद उसके साथ काम करने, और उसे लोगों तक पहुंचाने से जुड़े निर्देशों का एक यूनिफ़ाइड सेट होना चाहिए. 4. दस्तावेज़ में इलेक्ट्रॉन-एपीआई-डेमो रिपॉज़िटरी शामिल करें. इलेक्ट्रॉन-एपीआई-डेमो रिपॉज़िटरी में उदाहरण का एक सेट होता है, जो आपको बताता है कि आपके Electron ऐप्लिकेशन में सुविधाएं कैसे जोड़ना है. अपने ऐप्लिकेशन में सुविधाएं जोड़ना गाइड में यह जानकारी शामिल की जानी चाहिए, ताकि कॉन्टेंट से जुड़ी सही रणनीति के एक ही सोर्स से आपको कामयाबी मिल सके. 5. दस्तावेज़ में, इलेक्ट्रॉन फ़िडल के उदाहरणों को इंटिग्रेट करें. इस तरीके से, नए डेवलपर आसानी से यह देख पाएंगे कि कोड का कोई खास हिस्सा कैसे काम करता है. इसके लिए, उन्हें मैन्युअल तरीके से इन चरणों को दोहराना नहीं पड़ेगा. इंटिग्रेशन में, अपडेट किए गए ट्यूटोरियल के लिए कोड के सैंपल लिखने और कोड ब्लॉक में "Fiddle में लॉन्च करें" बटन जोड़ना शामिल होता है.
टाइमलाइन
आवेदन की समीक्षा की अवधि - समुदाय और काम करने वाले लोगों के बारे में जानें. समुदाय में योगदान की गाइड और सबसे सही तरीकों के बारे में जानें. अपना पहला योगदान दें. कम्यूनिटी से जुड़ना - समुदाय को एक्सप्लोर करें. इलेक्ट्रॉन दस्तावेज़ की मौजूदा स्थिति की जांच करें. कमज़ोर बिंदुओं की पहचान करें. पहला हफ़्ता - मेंटॉर से उनके प्रोजेक्ट की उपलब्धियां और उन्हें पूरा करने के बारे में बातचीत करें दूसरा हफ़्ता - डेवलपर एनवायरमेंट में बदलाव करना और अपने पहले Electron ऐप्लिकेशन के पेज लिखना तीसरा हफ़्ता - ऐप्लिकेशन आर्किटेक्चर में बदलाव करना, अपने ऐप्लिकेशन में सुविधाएं जोड़ना, ऐप्लिकेशन पैकेजिंग और डिस्ट्रिब्यूशन पेज. ऐप्लिकेशन में जोड़ी जा सकने वाली सुविधाओं की सूची के साथ सारांश पेज बनाएं चौथा हफ़्ता - दस्तावेज़ डायरेक्ट्री फिर से बनाएं पांचवा हफ़्ता - एक टेंप्लेट तैयार करें कि इलेक्ट्रॉन-एपीआई-डेमो को मुख्य दस्तावेज़ में कैसे इंटिग्रेट किया जाएगा छह हफ़्ता - 7 - इलेक्ट्रॉन-एपी-डेमो डेटा स्टोर करने की जगह को माइग्रेट करें आठवां हफ़्ता - मुख्य दस्तावेज़ में इलेक्ट्रॉन फ़िलडल को इंटिग्रेट करने के तरीके का टेंप्लेट तैयार करें. पहला सैंपल लिखें. सप्ताह 9 - 10 - इलेक्ट्रॉन फिडल को मुख्य दस्तावेज़ में एकीकृत करें 11 सप्ताह - इलेक्ट्रॉन-एपीआई-डेमो डेटा संग्रह स्थान और इलेक्ट्रॉन फिडल के नमूनों को माइग्रेट करने के बाद मुख्य दस्तावेज़ संरचना और पेजों को अंतिम रूप देना 12 वें सप्ताह - परिणामों का मूल्यांकन करना
उपलब्धियों के बारे में पूरी जानकारी
आवेदन की समीक्षा की अवधि इस अवधि का पहला हिस्सा, कम्यूनिटी चैनल और सोर्स कोड की जांच करने और इस प्रोजेक्ट में काम करने वाले लोगों से संपर्क करने के लिए किया जाएगा.
इस पीरियड का दूसरा हिस्सा, योगदान की संस्कृति को सामान्य तौर पर देखने, योगदान की गाइड और सबसे सही तरीकों की जांच करने पर आधारित होगा. इस बार में पहली बार योगदान दिया जा सकेगा और यह देखा जा सकेगा कि फ़्लो कैसे काम करता है.
कम्यूनिटी के साथ जुड़ाव
यह समय आपको दस्तावेज़ फ़ोल्डर के रोडमैप और उसके रोडमैप की गहराई से जांच करने पर मिलेगा. इस जानकारी के आधार पर, उन कमज़ोर चीज़ों की पहचान की जा सकती है जिनमें सुधार किया जा सकता है. जैसे, अधूरे या गुम हुए हिस्से. कमियों को दूर करने के लिए, पुल के अनुरोध (जहां मुमकिन हो) बनाएं.
पहला हफ़्ता - दूसरा हफ़्ता
पहला हफ़्ता, मेंटॉर से बातचीत करने का होगा, ताकि वे तय समय पर अपने लक्ष्य को हासिल कर पाएं और तय समय पर उन्हें उपलब्ध करा पाएं.
दूसरा हफ़्ता, डेवलपर एनवायरमेंट में सुधार करने और अपने पहले Electron ऐप्लिकेशन के पेज लिखने के बारे में होगा. डेवलपर एनवायरमेंट पेज के लिए, इसमें सामान्य खास जानकारी और प्रूफ़रीडिंग को फिर से लिखा जाएगा. अपना पहला इलेक्ट्रॉन ऐप्लिकेशन पेज लिखने के लिए, इसमें पेज के शुरुआती और आखिरी बिंदुओं के साथ एक ही तरह के सिलसिलेवार निर्देश तैयार करने होंगे, जिससे गैर-ज़रूरी जानकारी हट जाएगी (जैसे संक्षेप में इलेक्ट्रॉन डेवलपमेंट के तहत दो मिलते-जुलते कोड ब्लॉक और इस उदाहरण वाले सेक्शन को आज़माना).
डिलीवरेबल: Electron ऐप्लिकेशन के साथ क्विकस्टार्ट करने के तरीके के बारे में जानकारी देने वाली गाइड में बदलाव किए गए हैं और इन्हें आसानी से फ़ॉलो किया जा सकता है.
तीसरा हफ़्ता
यह हफ़्ता: 1. ऐप्लिकेशन आर्किटेक्चर पेज में सुधार करने के लिए है. इसमें ये चीज़ें शामिल हैं: - मुख्य और रेंडरर प्रोसेस सेक्शन में मौजूदा जानकारी को फिर से लिखना, ताकि पहली बार पढ़ने वाले लोगों के लिए इसे आसान और आसान बनाया जा सके - आर्किटेक्चर का विज़ुअल प्रज़ेंटेशन, प्रोसेस कैसे जुड़ी हुई हैं, कैसे बातचीत की जाती है, और उनके मुख्य अंतर. विज़ुअल के उदाहरण: एक, दो, तीन (खराब क्वालिटी). 2. उन सभी सुविधाओं की जानकारी का एकीकरण जो आप अपने Electron ऐप्लिकेशन में जोड़ सकते हैं. इसमें गाइड को फिर से लिखना शामिल है, ताकि उनके पास किसी सुविधा को इंस्टॉल/चालू करने के बारे में निर्देशों का एक यूनिफ़ाइड सेट हो. साथ ही, उसमें सुविधा के काम करने के तरीके का उदाहरण भी शामिल हो. इसके अलावा, एक नया पेज (खास जानकारी) भी बनाया जाएगा, जिसमें इस्तेमाल के लिए उपलब्ध सभी सुविधाओं की जानकारी दी जाएगी. यूनिफ़ाइड निर्देश इस तरह दिख सकते हैं: - खास जानकारी - उदाहरण: - कोड सैंपल - विज़ुअल उदाहरण (जहां मुमकिन हो)
- ऐप्लिकेशन डिस्ट्रिब्यूशन पेज को आसान बनाना. इसमें ये शामिल हैं: a. ऐप्लिकेशन पैकेजिंग को ऐप्लिकेशन डिस्ट्रिब्यूशन गाइड में मर्ज करना b. डिस्ट्रिब्यूशन के तरीकों को ऑटोमैटिक और मैन्युअल में बांटना c. इलेक्ट्रॉन-फ़ॉर्ज को अपने-आप डिस्ट्रिब्यूशन के उदाहरण के तौर पर इस्तेमाल करना d. ऐप्लिकेशन पैकेजिंग पेज से asar के बारे में जानकारी लेना और सोर्स फ़ाइलों को कॉपी करना और मैन्युअल डिस्ट्रिब्यूशन के उदाहरणों के तौर पर Asar संग्रह बनाना. #### हफ़्ता 4 यह हफ़्ता डॉक्यूमेंटरी डायरेक्ट्री को फिर से बनाने के लिए किया जाएगा. इसमें ये चीज़ें शामिल हैं:
1 - मौजूदा गाइड को कम से कम तीन कैटगरी में बांटना: a. क्विकस्टार्ट b. बुनियादी बातें जानना c. बेहतर तरीका
क्विकस्टार्ट कैटगरी में बुनियादी ट्यूटोरियल (इंस्टॉलेशन, कॉन्फ़िगरेशन, डिस्ट्रिब्यूशन) शामिल होंगे, ताकि नई गाइड की एक जैसी सीरीज़ बनाई जा सके. इससे नए उपयोगकर्ताओं को शुरुआत से ही क्विकस्टार्ट करने में आसानी होगी. हर गाइड में, सीरीज़ की पिछली/अगली गाइड के लिंक होने चाहिए.
स्ट्रक्चर ऐसा दिख सकता है: 1. ज़रूरी शर्तें 2. इलेक्ट्रॉन इंस्टॉल करें 3. कोई बुनियादी ऐप्लिकेशन बनाएं 4. ऐप्लिकेशन को पैकेज/डिस्ट्रिब्यूट करें
क्विकस्टार्ट सेक्शन को पूरा करने के बाद, उपयोगकर्ता को इलेक्ट्रॉन ऐप्लिकेशन के काम करने के तरीके की बुनियादी जानकारी मिलेगी. साथ ही, उसके पास पूरी तरह काम करने वाला ऐसा इलेक्ट्रॉन ऐप्लिकेशन होगा, जो वितरण योग्य होगा.
'बुनियादी जानकारी' कैटगरी में, ऐसी गाइड शामिल होंगी जिनका मकसद इलेक्ट्रॉन के बारे में जानकारी को मज़बूत करना और क्विकस्टार्ट सेक्शन में बनाए गए ऐप्लिकेशन का दायरा बढ़ाना है. इन गाइड में ये शामिल हैं: - ऐप्लिकेशन आर्किटेक्चर - अपने ऐप्लिकेशन में सुविधाएं जोड़ना - बॉयलरप्लेट और सीएलआई
बेहतर चरणों की कैटगरी में, आपके Electron ऐप्लिकेशन को कॉन्फ़िगर और बेहतर करने के लिए ज़्यादा बेहतर गाइड मौजूद होंगी: - जांच और डीबग करना - सुलभता - सुरक्षा - अपडेट
2 - दस्तावेज़ों वाले पेजों की संख्या कम करना. दस्तावेज़ के मौजूदा वर्शन में कुछ हद तक ओवरलैप होने वाला कॉन्टेंट और अन्य निर्देश शामिल हैं. उदाहरण के लिए: - अपना पहला ऐप्लिकेशन लिखने के दौरान इलेक्ट्रॉन को इंस्टॉल और इंस्टॉल करना - ऐप्लिकेशन डिस्ट्रिब्यूशन में, ऐप्लिकेशन पैकेजिंग और पैकेजिंग की फ़ाइल में अपने ऐप्लिकेशन की पैकेजिंग - 'ज़्यादा जानकारी' और 'बेहतर कैटगरी' में अवर्गीकृत निर्देश: सुझाव: इन दस्तावेज़ों को GitHub में ले जाएं और मुख्य दस्तावेज़ से बाहर रखें. ये दस्तावेज़ खास तौर पर, इलेक्ट्रॉन डेवलपमेंट के दिशा-निर्देशों के बारे में हैं और इन्हें ढूंढने के लिए सबसे पहले, सोर्स को स्टोर करना ज़रूरी है: - इलेक्ट्रॉन डेवलप करना - Chromium डेवलपमेंट - V8 डेवलपमेंट - इलेक्ट्रॉन में समस्याएं - इलेक्ट्रॉन में पैच - पुल के अनुरोध - सोर्स कोड डायरेक्ट्री स्ट्रक्चर - टेस्टिंग - कोडिंग स्टाइल
इसे कम करने का मुख्य मकसद उपलब्ध गाइड की बड़ी संख्या से छुटकारा पाना है. इसके लिए, पज़ल के बिखरे हुए हिस्सों को एक साथ जोड़ना और नए लोगों को Electron दस्तावेज़ का व्यवस्थित, आसानी से नेविगेट किया जा सकने वाला, और उपयोगकर्ता के लिए आसान वर्शन उपलब्ध कराना है.
पांच से सात हफ़्ते
सप्ताह 5 को एक टेम्प्लेट (एक तरीका) तैयार करने के लिए समर्पित किया जाएगा कि इलेक्ट्रॉन-एपीआई-डेमो को मुख्य दस्तावेज़ में किस तरह से इंटिग्रेट किया जाएगा. यह टेंप्लेट कुछ ऐसा दिख सकता है: 1. मुख्य दस्तावेज़ में, "अपने ऐप्लिकेशन में सुविधाएं जोड़ना" सेक्शन में, इलेक्ट्रॉन-एपीआई-डेमो में दिखाई गई कैटगरी बनाएं 2. हर कैटगरी को देखकर, डेमो के उदाहरणों को मुख्य दस्तावेज़ में ट्रांसफ़र करें: - कोड के सैंपल या तो सोर्स कोड से या ऐप्लिकेशन में दी गई सुविधा के ब्यौरे से लिए जा सकते हैं - ट्रांसफ़र किए गए हर उदाहरण के बाद उससे जुड़ी जानकारी होनी चाहिए - हर चाइल्ड उदाहरण (उदाहरण के लिए, सिस्टम डायलॉग बॉक्स के चाइल्ड के तौर पर गड़बड़ी वाला डायलॉग बॉक्स) अपने पैरंट के तहत ट्रांसफ़र किया जाना चाहिए
ध्यान दें #1: इलेक्ट्रॉन-एपीआई-डेमो और मुख्य दस्तावेज़, दोनों में ऐसे उदाहरण मौजूद हैं (उदाहरण के लिए, कीबोर्ड शॉर्टकट, ड्रैग और ड्रॉप). इस मामले में, इलेक्ट्रॉन-एपीआई-डेमो के उदाहरण को प्राथमिकता दी जानी चाहिए. साथ ही, मुख्य दस्तावेज़ में दिए गए उदाहरण को अनदेखा किया जाना चाहिए.
ध्यान दें #2: इलेक्ट्रॉन-एपीआई-डेमो ऐप्लिकेशन में कई उदाहरणों में, बताई गई सुविधा या फ़ंक्शन का लाइव डेमो की झलक शामिल है. जब तक 9 से 10 हफ़्ते के बीच इलेक्ट्रॉन फ़िडल का इंटिग्रेशन नहीं हो जाता, तब तक इस सुविधा को अनदेखा कर दिया जाएगा.
- उदाहरणों के नए हैरारकी को ध्यान में रखते हुए, पेज को अपडेट करें. इसमें वे सभी सुविधाएं शामिल हैं जो इस्तेमाल के लिए उपलब्ध हैं (जो तीसरे हफ़्ते के दौरान बनाई गई थीं).
छठे और सातवें हफ़्ते को ऊपर बताए गए टेंप्लेट के मुताबिक, इलेक्ट्रॉन-एपीआई-डेमो के उदाहरणों को मुख्य दस्तावेज़ में ट्रांसफ़र करने के लिए इस्तेमाल किया जाएगा. आखिरी चरण में, इलेक्ट्रॉन-एपीआई-डेमो रिपॉज़िटरी को मिटा दिया जाना चाहिए या बंद कर देना चाहिए.
8 से 10 हफ़्ते
आठवें हफ़्ते को एक टेंप्लेट तैयार करने के लिए कहा जाएगा, जिससे यह पता चलेगा कि इलेक्ट्रॉन फ़िडल को मुख्य दस्तावेज़ में किस तरह इंटिग्रेट किया जाएगा. इस पहल को समुदाय के वॉलंटियर के साथ-साथ इलेक्ट्रॉन के लोगों ने पहले ही (समस्या #20442 में दी गई जानकारी देखें) लॉन्च कर दिया है, लेकिन इसे पूरा करने की ज़रूरत है.
Fiddle सैंपल के साथ आगे बढ़ने के लिए, बेसिक टेंप्लेट इस तरह दिख सकता है: 1. मुख्य दस्तावेज़ (उदाहरण के लिए, क्विकस्टार्ट) में से कोई उदाहरण चुनें. इस समय, दस्तावेज़ में इलेक्ट्रॉन-एपीआई-डेमो के उदाहरण भी शामिल होने चाहिए; 2. इलेक्ट्रॉन वायलिन में उदाहरण फिर से बनाएं (शुरुआत में उदाहरण के तौर पर कोड या सोर्स कोड का इस्तेमाल करके); 3. Fiddle को स्थानीय तौर पर किसी फ़ोल्डर में सेव करना; 4. उदाहरण को /docs/fiddles/[CATEGORY]/[SECTION]/[DEMO] में ले जाएं. * समस्या के पूरे हो चुके उदाहरणों की सूची, समस्या के “डेमो की सूची” सेक्शन में बताई गई है. 5. समस्या #2848 में शुरुआती टिप्पणी में बताए गए तरीके के मुताबिक, “Fiddle में लॉन्च करें” बटन को जोड़ें.
हफ़्ते 9 और 10 को ऊपर बताए गए टेंप्लेट के मुताबिक, इलेक्ट्रॉन-एपीआई-डेमो के उदाहरणों (जो पहले ही फ़िडल में बदल दिए गए हैं) को मुख्य दस्तावेज़ में इंटिग्रेट करने के लिए खास तौर पर चुना जाएगा.
11 हफ़्ता
यह हफ़्ता, इलेक्ट्रॉन-एपीआई-डेमो रिपॉज़िटरी और इलेक्ट्रॉन फ़िडल के नमूनों के सफल माइग्रेशन के बाद, राइटिंग प्रोजेक्ट को पूरा करने में पूरी तरह से काम करेगा. इसमें शामिल है: - यह जांच करना कि सभी मौजूदा कोड उदाहरणों में "फ़िडल में लॉन्च करें" बटन है या नहीं - यह जांच करना कि सभी मौजूदा कोड उदाहरण फ़िडल के रूप में ठीक से काम कर रहे हैं या नहीं - यह जांचना कि मुख्य दस्तावेज़ अब इलेक्ट्रॉन-एपीआई-डेमो रिपॉज़िटरी को रेफ़र करता है या नहीं
12 हफ़्ता
पूरे हो चुके काम को फ़ाइनल करना. स्वीकार है या नहीं, इसकी जांच.