इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- क्लाउड नेटिव कंप्यूटिंग फ़ाउंडेशन (सीएनसीएफ़)
- तकनीकी लेखक:
- सायम सुंदर के
- प्रोजेक्ट का नाम:
- Kubectl के ज़्यादा और बेहतर उदाहरण
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
इस प्रोजेक्ट का मकसद, मौजूदा kubectl चीट शीट और रेफ़रंस दस्तावेज़ों को बेहतर बनाना है.
ये इस प्रोजेक्ट के आखिरी लक्ष्य हैं: • ज़्यादा और बेहतर kubectl उदाहरण बनाएं. • kubectl चीट शीट में kubectl के उदाहरण जोड़ें. • ज़्यादा मददगार होने के लिए, kubectl दस्तावेज़ों को रीफ़ैक्टर करें.
लक्ष्य I - kubectl के उदाहरण:
हम सीएलआई के खास इंटरेस्ट ग्रुप के साथ मिलकर काम करेंगे, ताकि यह पता लगाया जा सके कि kubernetes इस्तेमाल करने वाले लोग किस तरह के उदाहरण सबसे ज़्यादा चाहते हैं और उन्हें दस्तावेज़ के तौर पर दर्ज करना चाहते हैं. इस सुविधा में, चीट शीट में पहले से मौजूद kubectl कमांड को बेहतर बनाना या चीट शीट में नए कमांड जोड़ना शामिल है.
लक्ष्य II - दस्तावेज़ों की उपयोगिता में बढ़ोतरी:
दस्तावेज़ों को ज़्यादा मददगार बनाने के लिए, ये काम किए जा सकते हैं:
• शुरुआत में मिलने वाली समस्याओं को खत्म करें • kubectl कमांड को एक तय क्रम में फिर से सेट करें, ताकि लॉजिकल फ़्लो को जारी रखा जा सके
बेहतर कमांड / उपयोगकर्ता के केस के बारे में पूरी जानकारी की मदद से, पहली बार में आने वाली मुश्किलों को खत्म करें. ऐसा करना आसान लग सकता है, लेकिन इससे सीखने वाले नए लोगों को सीखने में परेशानी हो सकती है. उदाहरण के लिए, जब मैंने kubectl के ज़रिए, kubernetes का इस्तेमाल करना शुरू किया, तब मुझे पता नहीं था कि पॉड और डिप्लॉयमेंट में क्या अंतर है. शुरुआत में मैंने, nodejs में लिखी गई बैकएंड सेवा का इस्तेमाल किया. कुछ घंटों के बाद, मैं इसे बंद करना चाहती थी, इसलिए मैंने पॉड को मिटाने की कोशिश की, लेकिन खुद से ठीक होने की वजह से उन्हें फिर से बनाया गया. मैं इस प्रोसेस को लेकर परेशान थी और सोच रही थी कि इसे फिर से क्यों बनाया जा रहा है और इसे क्यों नहीं मिटाया जा रहा. वेब पर कुछ खोजने के बाद मुझे पता चला कि पॉड को मिटाना, किसी डिप्लॉयमेंट को मिटाने जैसा नहीं है. अच्छी तरह देख सकने वाले व्यक्ति के लिए यह आसान लग सकता है, लेकिन इस तरह की अस्पष्टता को खत्म करने की एक साफ़ वजह यह है कि एक अच्छे दस्तावेज़ और अच्छे दस्तावेज़ के बीच का फ़र्क़ साफ़ तौर पर बताया जाता है.
यह पक्का करने के लिए कि लॉजिकल फ़्लो में कोई रुकावट न आए, kubectl कमांड को किसी खास क्रम में फिर से अरेंज करना. अगर आप मुझसे मिलते-जुलते हैं और आपको कहानी सुनाने की कला में बहुत ज़्यादा भरोसा है, तो आपके मन में यह सवाल उठ सकता होगा कि कहानी सुनाने की कला को ऐसी दस्तावेज़ शीट में कैसे शामिल किया जाए जिसमें टर्मिनल के निर्देशों की सूची हो. जैसे, यह किया जा सकता है. जो भी हम सीखते हैं उसका एक तार्किक फ़्लो होता है - अगर आप चाहें, तो एक शुरुआती और आखिरी पॉइंट. Cubectl, कमांड लाइन टूल है, लेकिन इसमें साफ़ तौर पर लर्निंग कर्व मौजूद है. असल में, यह लर्निंग कर्व और कुबेरनेट के लर्निंग कर्व से मेल खाता है. ज़्यादातर लोग, kubectl (वेब यूआई का इस्तेमाल करने वाले लोगों को छोड़कर) के ज़रिए कुबरनेट के इस्तेमाल से अपना सफ़र शुरू करते हैं. साथ ही, यह सीखने की प्रक्रिया और कुबेरनेट के सीखने की प्रक्रिया से काफ़ी हद तक जुड़ा है. इसलिए, इन निर्देशों के क्रम को बदलकर और कहानी सुनाने की कला के एलिमेंट को पेश करके, दस्तावेज़ों को काफ़ी बेहतर बनाया जा सकता है. जैसे कि हॉरिज़ॉन्टल पॉड ऑटो स्केलिंग जैसी सुविधाओं के बारे में रीयल दुनिया के उदाहरणों और इलस्ट्रेशन की मदद से, संसाधनों के बारे में बताने के बाद ही ऐसा किया जा सकता है.
लक्ष्य III - दस्तावेज़ की उपयोगिता में सुधार:
हाल ही में, Cubernetes वेबसाइट को Docsy Hugo पर माइग्रेट करना शानदार है. साथ ही, दस्तावेज़ों के नज़रिए में भी एक बड़ा बदलाव आया है. हालांकि, माइग्रेशन पूरा हो गया है, लेकिन डॉक्यूमेंट स्पेस में कई सुधार करने की गुंजाइश है.
मैं आपको इन बदलावों के बारे में सुझाव दे रहा हूं
• मुख्य दस्तावेज़ों में मौजूद ऐक्टिव सेक्शन पर, बायां पैनल अपने-आप स्क्रोल होता है. इसकी मदद से मौजूदा, आगे, और पिछले सेक्शन पर नज़र रखी जा सकती है. • क्लिपबोर्ड पर कॉपी करें - कुछ निर्देश लंबे हो सकते हैं और इस तरह के निर्देशों पर काम करते समय, कॉपी करने की सुविधा मददगार हो सकती है. • दस्तावेज़ फ़ाइलों का कॉन्टेंट फ़ॉर्मैट - माइग्रेशन के बाद, कुछ पेजों का कॉन्टेंट सही तरीके से फ़ॉर्मैट नहीं होता है. उदाहरण के लिए: kubectl की खास जानकारी में संसाधन टाइप सेक्शन. इससे उपयोगकर्ता अनुभव खराब होता है.
ये ऐसे बदलाव हैं जो kubernetes वेबसाइट पर उपयोगकर्ता अनुभव को बेहतर बना सकते हैं. साथ ही, उपयोगकर्ता की उत्पादकता को भी बढ़ा सकते हैं.