कम्यूनिटी के लिए पहला ट्यूटोरियल लिखना

यह सेक्शन, Earth Engine के उन उपयोगकर्ताओं के लिए है जो Earth Engine कम्यूनिटी के बाकी सदस्यों के साथ अपना अनुभव शेयर करना चाहते हैं. इस सेक्शन में दिए गए ट्यूटोरियल, Earth Engine के उपयोगकर्ताओं ने ही बनाए हैं. ये ट्यूटोरियल, शुरुआती से लेकर ऐडवांस लेवल के उपयोगकर्ताओं तक, सभी के लिए हैं.

ट्यूटोरियल को, सादे टेक्स्ट और Markdown मार्कअप लैंग्वेज का इस्तेमाल करके फ़ॉर्मैट किए गए कोड के तौर पर सबमिट किया जा सकता है. इसके अलावा, इन्हें Colab notebook के तौर पर भी सबमिट किया जा सकता है. इनमें Markdown और Python का ऐसा कोड होता है जिसे चलाया जा सकता है. Earth Engine JavaScript क्लाइंट लाइब्रेरी का इस्तेमाल करके बनाए गए ट्यूटोरियल आम तौर पर Markdown में लिखे जाते हैं. वहीं, Earth Engine Python क्लाइंट लाइब्रेरी पर आधारित ट्यूटोरियल के लिए, Colab का इस्तेमाल करने का सुझाव दिया जाता है.

शुरू करने से पहले

आचार संहिता

Earth Engine की टीम, ऐसी कम्यूनिटी बनाने के लिए प्रतिबद्ध है जहां किसी के साथ उत्पीड़न न हो और सभी को शामिल किया जाए. योगदान देने से पहले, कृपया हमारी आचार संहिता के बारे में अच्छी तरह जान लें.

GitHub में शामिल होना

Earth Engine कम्यूनिटी के ट्यूटोरियल, GitHub के ज़रिए शेयर और उनकी समीक्षा की जाती है. अगर आपके पास GitHub खाता नहीं है, तो आपको पहले https://github.com/join पर जाकर खाता बनाना होगा.

ट्यूटोरियल का सुझाव देना

नए ट्यूटोरियल पर ज़्यादा समय और मेहनत करने से पहले, संभावित योगदानकर्ताओं से अनुरोध किया जाता है कि वे कुछ बुनियादी जानकारी के साथ एक आसान सा सुझाव सबमिट करें. इससे लेखक, Earth Engine डेवलपर के दस्तावेज़ों के रखरखाव करने वालों के साथ मिलकर काम कर पाते हैं. साथ ही, वे ऐसे ट्यूटोरियल पर फ़ोकस कर पाते हैं जिनसे Earth Engine के उपयोगकर्ताओं को सबसे ज़्यादा फ़ायदा मिल सके. इससे समीक्षा की प्रोसेस के दौरान, बार-बार होने वाली बातचीत से भी समय बचता है.

ट्यूटोरियल का सुझाव देना

पहली बार किया जाने वाला सेट अप

अगर आपने Earth Engine कम्यूनिटी की GitHub रिपॉज़िटरी में पहली बार कोई ट्यूटोरियल सबमिट किया है, तो अपने ट्यूटोरियल पर काम शुरू करने से पहले, ये चरण पूरे करें:

1. योगदानकर्ता लाइसेंस समझौते (सीएलए) को यहां स्वीकार करें:

   https://cla.developers.google.com

2. कम्यूनिटी के ट्यूटोरियल के लिए बने स्टाइल गाइड को पढ़ें और उसके मुताबिक काम करें.

ट्यूटोरियल लिखना और सबमिट करना

ट्यूटोरियल का आपका सुझाव, रखरखाव करने वालों की ओर से स्वीकार किए जाने के बाद, आपके पास ट्यूटोरियल में बदलाव करने और उसे Earth Engine कम्यूनिटी की रिपॉज़िटरी में सबमिट करने के कई विकल्प होते हैं:

Markdown का इस्तेमाल करने के लिए, क्विक स्टार्ट गाइड

बिना किसी अतिरिक्त टूल या सेटअप के, तुरंत काम शुरू करने के लिए, GitHub की रिपॉज़िटरी को फ़ोर्क करें और सीधे GitHub वेबसाइट से नया ट्यूटोरियल बनाएं:

1. अगर आपने GitHub में पहले से साइन इन नहीं किया है, तो साइन इन करें.

2. नई ट्यूटोरियल फ़ाइल बनाने और उसमें बदलाव करने के लिए, नया ट्यूटोरियल पर क्लिक करें. ज़रूरत पड़ने पर, आपको रिपॉज़िटरी को फ़ोर्क करने के लिए कहा जाएगा.

   नया ट्यूटोरियल

3. ट्यूटोरियल फ़ाइल के लिए कोई नाम डालें. इसका फ़ॉर्मैट यह होना चाहिए:

   your-tutorial-name/index.md

   यहां your-tutorial-name का मतलब, आपके ट्यूटोरियल का छोटा नाम है. यह नाम, सभी छोटे अक्षरों में होना चाहिए. शब्दों को अलग-अलग करने के लिए, डैश ("-") का इस्तेमाल करें. फ़ोल्डर के नाम में स्पेस या किसी अन्य विराम चिह्न का इस्तेमाल न करें.

4. GitHub के फ़ाइल एडिटर में सीधे अपने ट्यूटोरियल में बदलाव करें. फ़ॉर्मैट किए गए आउटपुट की पुष्टि करने के लिए, "पूर्वावलोकन" का इस्तेमाल करें. इसके अलावा, GitHub के दस्तावेज़ में अपनी रिपॉज़िटरी में फ़ाइलें में बदलाव करना लेख पढ़ें.

5. तैयार होने के बाद, अपने बदलावों को कमिट करें और पुल करने का अनुरोध करें.

Colab notebook

Colab में ट्यूटोरियल लिखना शुरू करने के लिए, यहां क्लिक करें:

Colab का नया ट्यूटोरियल

इससे एक नोटबुक खुलेगी. इसमें, ट्यूटोरियल लिखने और उसे सबमिट करने के निर्देश शामिल होंगे.

बेहतर

अगर आपको GitHub, git, और इनसे जुड़े टूल के बारे में पहले से जानकारी है, तो Markdown और Colab दोनों तरह के ट्यूटोरियल सबमिट करने की प्रोसेस एक जैसी होती है:

1. google/earthengine-community GitHub रिपॉज़िटरी को फ़ोर्क और क्लोन करें.

2. tutorials में, आपके ट्यूटोरियल के स्लग वाले छोटे नाम के साथ एक डायरेक्ट्री बनाएं. उदाहरण के लिए, tutorials/my-amazing-tutorial.

3. Markdown या Colab के लिए सही हेडर जोड़ें.

4. ट्यूटोरियल को नई डायरेक्ट्री में, index.md (Markdown के लिए) या tutorial.ipynb (Colab के लिए) नाम की फ़ाइल के साथ कमिट करें. ट्यूटोरियल में इस्तेमाल की गई इमेज को भी उसी डायरेक्ट्री में कमिट करें.

5. नए कॉन्टेंट को अपने फ़ोर्क में पुश करें और पुल करने का अनुरोध करें.

पुल करने का अनुरोध करते समय, टिप्पणी वाले सेक्शन में, GitHub के समस्या नंबर के हिसाब से मूल सुझाव का रेफ़रंस ज़रूर दें. उदाहरण के लिए, अगर समस्या #123 है, तो पुल करने के अनुरोध के ब्यौरे में "Closes #123" टेक्स्ट डालें. इससे मूल सुझाव का रेफ़रंस दिया जा सकेगा. साथ ही, ट्यूटोरियल पब्लिश होने के बाद, इसे अपने-आप 'पूरा हुआ' के तौर पर मार्क किया जा सकेगा.

पुल करने का अनुरोध करने के बाद, आपके सबमिशन की समीक्षा करने के लिए, एक या उससे ज़्यादा रखरखाव करने वालों को असाइन किया जाएगा. समीक्षा करने वाला व्यक्ति या टीम, आपके साथ मिलकर काम करेगी, ताकि यह पक्का किया जा सके कि आपका सबमिशन पूरा और सही है. साथ ही, यह Earth Engine कम्यूनिटी के ट्यूटोरियल के लिए बने स्टाइल गाइड के मुताबिक है.

पुल करने का आपका अनुरोध स्वीकार होने के बाद, रिपॉज़िटरी के रखरखाव करने वाले लोग आपके ट्यूटोरियल को पब्लिश करेंगे.