इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- Jenkins X
- टेक्निकल राइटर:
- Nitin
- प्रोजेक्ट का नाम:
- Jenkins X के दस्तावेज़ों की मौजूदा साइट और Jenkins X की सुविधाओं के मैट्रिक्स को फिर से तैयार करना
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड अवधि (तीन महीने)
प्रोजेक्ट का विवरण
इस प्रोजेक्ट का मुख्य मकसद, दस्तावेज़ों से जुड़ी समस्याओं को ठीक करते हुए, मौजूदा Jenkins X दस्तावेज़ों को फिर से तैयार करना है. साथ ही, एंटरप्राइज़ क्लाउड सेवा देने वाली कंपनियों पर Jenkins X के इस्तेमाल से जुड़े उपयोगकर्ता दस्तावेज़ के साथ-साथ, Jenkins X की क्षमताओं का अपडेट किया गया मैट्रिक्स तैयार करना है. इसके अलावा, इस प्रोजेक्ट में डैनियल के साथ मिलकर, OpenShift पर आधारित Jenkins X के झलक वाले इंफ़्रास्ट्रक्चर को डेवलप करने पर भी काम किया जा रहा है.
Jenkins X के मौजूदा दस्तावेज़ को रीफ़ैक्टर करने के दौरान, इन समस्याओं पर काम किया जाएगा:
- EKS संसाधनों में बूट करना: समस्या
- बूट के साथ EKS में Vault विफल: समस्या
- jx बूट के लिए, एनवायरमेंट वैरिएबल को दस्तावेज़ में शामिल करना: समस्या
- Vault सेटअप करने के लिए ज़रूरी दस्तावेज़: समस्या
- लोकल से वॉल्ट में अपग्रेड करने में समस्या आना
- दस्तावेज़ से जुड़ा सुझाव/राय/शिकायत “बनाएं” बनाम “jx इंस्टॉल करें” बनाम “बूट करें” बनाम “इंपोर्ट करें”: समस्या
- हेल्म दस्तावेज़ हर जगह मौजूद है: समस्या
- बेहतर दस्तावेज़ बनाएं कि ChartMuseum, Monocular, और Docker Registry को Nexus Issue से क्यों नहीं बदला गया
- Boot + GKE का इस्तेमाल करते समय, Docker Registry में बदलाव नहीं किया जा सका: समस्या
- डोमेन को nip.io से कस्टम डोमेन में नहीं बदला जा सका: समस्या
Jenkins X की सुविधाओं के मैट्रिक्स के लिए, नीचे बताए गए काम में हर क्लाउड सेवा देने वाली कंपनी की एंटरप्राइज़ Kubernetes सेवाएं शामिल हैं. जैसे, Google Cloud (GKE), Amazon Web Services (AWS EKS), और Azure Cloud (AKS).
- terraform स्क्रिप्ट और
jx boot
की मदद से, क्लाउड पर Jenkins X इंस्टॉल करना - इन क्लाउड सेवा देने वाली कंपनियों की Kubernetes सेवाओं पर, Kubernetes वर्शन के साथ Jenkins X के काम करने की जांच करना.
- ऐसी कोई भी सुविधा (गुप्त जानकारी के लिए वॉल्ट स्टोरेज, सोर्स कंट्रोल वर्शन या अन्य) जिसकी चर्चा डीन और Jenkins X कम्यूनिटी के सदस्यों के साथ की जानी है.
OpenShift पर आधारित Jenkins X के प्रीव्यू एनवायरमेंट के इन्फ़्रास्ट्रक्चर को सेट अप करने के काम में ये शामिल हैं:
- OpenShift प्लैटफ़ॉर्म पर, Jenkins X के प्रीव्यू एनवायरमेंट के इंफ़्रास्ट्रक्चर पर डिज़ाइन दस्तावेज़
- OpenShift में, जेनकिन्स X के टीज़र के तौर पर बने एनवायरमेंट को अपने-आप बनाने की सुविधा चालू करें
- झलक वाले एनवायरमेंट के लिए, जेनकिन्स X के दस्तावेज़ अपडेट करें
प्रोजेक्ट के लिए डिलीवर की जाने वाली चीज़ें:
- ऊपर बताए गए दस्तावेज़ से जुड़ी समस्याओं को ठीक करने के लिए, PR का इस्तेमाल किया गया है. ऐसा, Jenkins X के मौजूदा दस्तावेज़ को फिर से तैयार करने के लिए किया गया है.
- Jenkins X की सुविधाओं का अपडेट किया गया मैट्रिक्स. साथ ही, अलग-अलग क्लाउड सेवा देने वाली कंपनियों (मुख्य रूप से AKS, EKS, और GKE जैसी Kubernetes सेवाएं) के साथ Jenkins X का इस्तेमाल करने के बारे में उपयोगकर्ता दस्तावेज़.
- डेनियल के साथ मिलकर, OpenShift के आधार पर, जेनकिन्स X के प्रीव्यू एनवायरमेंट इन्फ़्रास्ट्रक्चर का अपने-आप सेट अप किया गया.
टास्क के साथ संभावित टाइमलाइन का सुझाव:
कम्यूनिटी बॉन्डिंग (17 अगस्त से 13 सितंबर)
- तकनीकी दस्तावेज़ों के लिए डेवलपमेंट एनवायरमेंट सेट अप करें. साथ ही, प्रोजेक्ट के टास्क पर काम करने के लिए, क्लाउड इन्फ़्रास्ट्रक्चर का ऐक्सेस पाएं.
- प्रोजेक्ट के मेंटर के साथ, प्रोजेक्ट की संभावित समयसीमा, प्रोजेक्ट के नतीजे, और टास्क (उनकी प्राथमिकता के साथ) के बारे में चर्चा.
- संगठन की काम करने की प्रक्रिया, पीआर की समीक्षा की प्रक्रिया को समझें और उसके बारे में जानकारी पाएं. साथ ही, समुदाय के साथ जुड़ें.
- Jenkins X के दस्तावेज़ की मौजूदा स्थिति देखें.
पहला हफ़्ता (14 सितंबर से 20 सितंबर)
- क्लाउड पर Jenkins X को सेट अप करने के निर्देश, मौजूदा स्थिति, और दस्तावेज़ों के बारे में जानें.
- डीन के साथ, Jenkins X की मौजूदा सुविधाओं के बारे में बातचीत (अलग-अलग क्लाउड सेवा देने वाली कंपनियों पर पुष्टि की जानी है).
- OpenShift पर आधारित, Jenkins X के झलक वाले एनवायरमेंट के इंफ़्रास्ट्रक्चर की मौजूदा स्थिति के बारे में, डेनियल के साथ बातचीत.
- OpenShift पर, जेनकिन्स X प्रीव्यू एनवायरमेंट इन्फ़्रास्ट्रक्चर के लिए आर्किटेक्चर डिज़ाइन करने के लिए डेनियल के साथ मिलकर काम करें.
दूसरा हफ़्ता (21 सितंबर से 27 सितंबर)
- GKE क्लाउड के लिए, Jenkins X की क्षमताओं के मैट्रिक्स पर काम करना: Jenkins X को इंस्टॉल करना और उपयोगकर्ता के नोट का ड्राफ़्ट तैयार करना.
- Jenkins X के मौजूदा दस्तावेज़ को बेहतर बनाने के लिए, दस्तावेज़ से जुड़ी किसी समस्या पर काम करें.
तीसरा हफ़्ता (28 सितंबर से 4 अक्टूबर)
- GKE क्लाउड के लिए, Jenkins X की क्षमताओं के मैट्रिक्स पर काम करना: Jenkins X को इंस्टॉल करना और उपयोगकर्ता के नोट का ड्राफ़्ट तैयार करना.
- मौजूदा जेनकिन्स X दस्तावेज़ को बेहतर बनाने के लिए दस्तावेज़-समस्या में से किसी एक पर काम करें.
- OpenShift पर आधारित, Jenkins X के झलक वाले एनवायरमेंट के इंफ़्रास्ट्रक्चर के लिए डिज़ाइन दस्तावेज़ पर काम करना.
चौथा हफ़्ता (5 अक्टूबर से 11 अक्टूबर)
- GKE (जीकेई) पर जेनकिन्स X के लिए उपयोगकर्ता के दस्तावेज़ तैयार करें.
- मौजूदा Jenkins X दस्तावेज़ को बेहतर बनाने के लिए, दस्तावेज़ से जुड़ी किसी समस्या पर काम करें.
पांचवां हफ़्ता (12 अक्टूबर से 18 अक्टूबर)
- Azure क्लाउड (AKS) के लिए, Jenkins X की क्षमता वाले मैट्रिक पर काम करना: Jenkins X इंस्टॉल करना और उपयोगकर्ता नोट का ड्राफ़्ट तैयार करना.
- Jenkins X के मौजूदा दस्तावेज़ को बेहतर बनाने के लिए, दस्तावेज़ से जुड़ी किसी समस्या पर काम करें.
- कम्यूनिटी के सदस्यों से सुझाव/राय/शिकायत मिलने के बाद, OpenShift पर आधारित Jenkins X के प्रीव्यू एनवायरमेंट के इंफ़्रास्ट्रक्चर के लिए डिज़ाइन दस्तावेज़ को फ़ाइनल करें.
छठा हफ़्ता (19 अक्टूबर से 25 अक्टूबर)
- Azure क्लाउड (AKS) के लिए, Jenkins X की क्षमताओं के मैट्रिक्स पर काम करना: Jenkins X इंस्टॉल करना और उपयोगकर्ता नोट का ड्राफ़्ट तैयार करना.
- Jenkins X के मौजूदा दस्तावेज़ को बेहतर बनाने के लिए, दस्तावेज़ से जुड़ी किसी समस्या पर काम करें.
सातवां हफ़्ता (26 अक्टूबर से 1 नवंबर)
- Azure क्लाउड (AKS) के लिए, जेनकिन्स X की सुविधा वाले मैट्रिक्स पर काम करना: जेनकिन्स X को इंस्टॉल करना और उपयोगकर्ताओं के ड्राफ़्ट के तौर पर नोट तैयार करना.
- Jenkins X के मौजूदा दस्तावेज़ को बेहतर बनाने के लिए, दस्तावेज़ से जुड़ी किसी समस्या पर काम करें.
- OpenShift के आधार पर, जेनकिन्स X प्रीव्यू एनवायरमेंट इंफ़्रास्ट्रक्चर को सेट अप करने पर काम करें.
आठवां हफ़्ता (2 नवंबर से 8 नवंबर)
- AKS पर Jenkins X के लिए, उपयोगकर्ता दस्तावेज़ों को फ़ाइनल करें.
- Jenkins X के मौजूदा दस्तावेज़ को बेहतर बनाने के लिए, दस्तावेज़ से जुड़ी किसी समस्या पर काम करें.
नौवां हफ़्ता (9 नवंबर से 15 नवंबर)
- AWS (EKS) के लिए, Jenkins X की क्षमताओं के मैट्रिक्स पर काम करना: Jenkins X इंस्टॉल करना और उपयोगकर्ता के नोट का ड्राफ़्ट तैयार करना.
- Jenkins X के मौजूदा दस्तावेज़ को बेहतर बनाने के लिए, दस्तावेज़ से जुड़ी किसी समस्या पर काम करें.
- OpenShift पर आधारित, Jenkins X के प्रीव्यू एनवायरमेंट के इंफ़्रास्ट्रक्चर को सेट अप करने पर काम करना.
10वां हफ़्ता (16 नवंबर से 22 नवंबर)
- AWS (EKS) के लिए, Jenkins X की क्षमताओं के मैट्रिक्स पर काम करना: Jenkins X इंस्टॉल करना और उपयोगकर्ता के नोट का ड्राफ़्ट तैयार करना.
- Jenkins X के मौजूदा दस्तावेज़ को बेहतर बनाने के लिए, दस्तावेज़ से जुड़ी किसी समस्या पर काम करें.
11वां हफ़्ता (23 नवंबर से 29 नवंबर)
- EKS पर Jenkins X के लिए, उपयोगकर्ता दस्तावेज़ों को फ़ाइनल करें.
- मौजूदा Jenkins X दस्तावेज़ को बेहतर बनाने के लिए, दस्तावेज़ से जुड़ी किसी समस्या पर काम करें.
- Jenkins X के दस्तावेज़ों की साइट पर, Jenkins X के प्रीव्यू एनवायरमेंट के इंफ़्रास्ट्रक्चर के दस्तावेज़ को फ़ाइनल करें.
हफ़्ता 12 (30 नवंबर से 5 दिसंबर)
- सुझाव/राय के आधार पर, प्रोजेक्ट की डिलीवरables को फ़ाइनल करें और कोड को फिर से लिखें.
- लिंक, इमेज, हाइपरलिंक वगैरह के साथ-साथ, Jenkins X की दस्तावेज़ साइट के काम करने की जांच करें.
- जेनकिन्स X दस्तावेज़ साइट के उपयोगकर्ता के ज़रिए तय किए गए नियंत्रण और नेविगेशन की जाँच करें.
- जेनकिन्स X कैपाबिलिट्स मैट्रिक्स के फ़ाइनल प्रज़ेंटेशन को देखें.
10 दिसंबर, 2020 से पहले टेक्निकल लेखक और मेंटर, प्रोजेक्ट का आकलन सबमिट करते हैं.
प्रस्तावित प्रोजेक्ट से, Jenkins X और उसकी कम्यूनिटी को क्या फ़ायदे मिलेंगे? इस प्रोजेक्ट से, Jenkins X कम्यूनिटी को अपने असली उपयोगकर्ताओं के लिए दस्तावेज़ को बेहतर बनाने में मदद मिलेगी. साथ ही, Jenkins X के तकनीकी आर्किटेक्चर, काम करने के तरीके, इस्तेमाल, और इंटिग्रेशन के बारे में जानकारी देने के लिए, डेवलपर को भी मदद मिलेगी. इस प्रोजेक्ट के पूरा होने के बाद, Jenkins X के लिए उपयोगकर्ताओं के लिए पूरी तरह से तैयार, अच्छी तरह से समझा जा सकने वाला, और तकनीकी तौर पर पुष्टि किया गया दस्तावेज़ उपलब्ध होगा. साथ ही, अलग-अलग क्लाउड सेवा देने वाली कंपनियों के साथ काम करने के लिए, Jenkins X की क्षमताओं का मैट्रिक भी उपलब्ध होगा.
आने वाले समय में, आपको Jenkins X के साथ कौनसे फ़ायदे मिल सकते हैं? Google Season of Docs 2020 प्रोग्राम खत्म होने के बाद, मैं कम्यूनिटी के सक्रिय सदस्य के तौर पर, Jenkins X प्रोजेक्ट में लंबे समय तक योगदान देने वाला व्यक्ति बनने की कोशिश करूंगा. मैं हमेशा दूसरों (नए लोगों) की मदद करने के लिए तैयार रहूंगा और उन्हें Jenkins X कम्यूनिटी में शामिल होने के लिए बढ़ावा दूंगा. मैं अन्य जेनकिन्स X प्रोजेक्ट के आइडिया पर हमेशा काम करने के लिए तैयार हूँ.
इस प्रोजेक्ट पर काम करने के लिए, मेरे पास ये वजहें हैं:
- मैं बहुत व्यवस्थित और सटीक तरीके से काम करता/करती हूं. हम प्रोजेक्ट के बारे में प्रोजेक्ट में शामिल मेंटर और संगठन की कम्यूनिटी, दोनों को जानकारी देते रहेंगे. इसके लिए, हम हर हफ़्ते एक ब्लॉग पोस्ट पब्लिश करेंगे. साथ ही, SIG-docs की हर हफ़्ते होने वाली मीटिंग को शेड्यूल करेंगे और नियमित तौर पर ईमेल भेजेंगे.
- वे टास्क को पूरा करने के लिए, अक्सर मेंटर और कम्यूनिटी के सदस्यों से दिशा-निर्देश और सुझाव मांगेंगे. इससे सभी को एक जैसी जानकारी मिलेगी और वे टास्क को पूरा करने में मदद कर पाएंगे. साथ ही, वे किसी भी तरह की समस्या और/या रुकावट के बारे में भी बता पाएंगे.
- नियमित रूप से सभी सोर्स कोड को एक बार में सबमिट करना, ताकि मेंटॉर और योगदान देने वालों से कोड की समीक्षा की जा सके. साथ ही, समुदाय के सदस्यों के रेफ़रंस के लिए किए गए काम का रिकॉर्ड रखा जा सके.
- मेरे पास इस प्रोजेक्ट के आइडिया पर काम करने के लिए, ज़रूरी तकनीकी कौशल हैं. मैंने प्रोजेक्ट के प्रस्ताव के बारे में, मेंटर डीन, कारा, और डेनियल से बातचीत की है. मुझे प्रोजेक्ट के प्रपोज़ल और इसके पूरा होने की पूरी समझ है.
- मेरे पास Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo वगैरह जैसी तकनीकी स्किल का अनुभव है. इनकी मदद से, मैं पूरी तरह से तैयार दस्तावेज़ उपलब्ध करा सकता हूं. साथ ही, दस्तावेज़ से जुड़ी ज़्यादातर मौजूदा समस्याओं को हल कर सकता हूं. मैं पॉज़िटिव सोचती हूँ और कुछ की निगरानी में ही, प्रोजेक्ट का काम समय पर पूरा कर सकती हूँ.