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