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