This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

कुबेरनेटेस डॉक्स में योगदान दे

कुबेरनेटस सभी योगदानकर्ताओ से सुधार का स्वागत करता है चाहे वो नए हो या अनुभवी!

इस वेबसाइट की देख रेख कुबेरनेटस SIG Docs द्वारा की जाती है।

कुबेरनेटस प्रलेखन योगदानकर्ता :

  • मौजूदा विषयों को सुधारते हैं
  • नए विषय बनाते हैं
  • प्रलेखन का अनुवाद करते हैं
  • कुबेरनेटस रिलीज चक्र मे प्रलेखन की देख रेख और प्रकाशन करते हैं

शुरू करना

कोई भी प्रलेखन के बारे मे इशू खोल सकता है या कुबेरनेटस वेबसाइट kubernetes/website GitHub रिपॉजिटरी मे बदलाव पुल अनुरोध (PR) द्वारा कर सकता है। आपको Git और Github की जानकारी होनी चाहिए ताकि आप कुबेरनेटेस समुदाय मे प्रभावी रूप से काम कर सकें।

प्रलेखन मे सहयोग करने के लिए:

  1. योगदानकर्ता समझौता लाइसेन्स पर हस्ताक्षर करें।
  2. प्रलेखन रिपॉजिटरी और वेबसाइट की स्टैटिक साइट जनरेटर से खुद को परिचित करें।
  3. सुनिश्चित करें की आपको पुल अनुरोध करना और बदलाओ की समीक्षा करना आता हो।

flowchart TB subgraph third[PR ओपन करे] direction TB U[ ] -.- Q[विषय सुधारे] --- N[विषय निर्माण करे] N --- O[डॉक्स का अनुवाद करे] O --- P[K8s रिलीज़ चक्र के प्रलेखन
को संचालित /प्रकाशित करें] end subgraph second[समीक्षा] direction TB T[ ] -.- D[kubernetes/website
रिपॉजिटरी
को देखें] --- E[Hugo स्टैटिक साइट
जनरेटर
को देखें] E --- F[मूलभूत GitHub
कमांड समझें] F --- G[ओपन PR की समीक्षा करे
और समीक्षा प्रक्रिया
को बदलें] end subgraph first[साइनअप] direction TB S[ ] -.- B[CNCF
योगदानकर्ता
लइसेंस समझौता
पर हस्ताक्षर करें] --- C[sig-docs स्लैक चैनल
में जुड़ें] C --- V[kubernetes-sig-docs
मेलिंग लिस्ट में जुड़ें] V --- M[साप्ताहिक
sig-docs कॉल
या स्लैक बैठक में शामिल हों] end A([fa:fa-user नए
योगदानकर्ता]) --> first A --> second A --> third A --> H[सवाल पूछे!!!] classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,C,D,E,F,G,H,M,Q,N,O,P,V grey class S,T,U spacewhite class first,second,third white
आकृति - नए योगदानकर्ताओं के लिए योगदान शुरू करने का रास्ता

ऊपर दी गई आकृति नए योगदानकर्ता के लिए दिशानिर्देश हैं। Sign up या review के लिए आप इनमे से कुछ या सभी निर्देशों का पालन कर सकते हैं। अब आप PR ओपन करने के लिए तैयार हैं जो आपके योगदान के उद्देश को पूरा करे जो Open PR खंड मे सूचीबद्ध हैं। आपके सभी प्रश्नों का सदैव स्वागत है।

कुबेरनेटस समुदाय मे कुछ कार्यों के लिए अधिक विश्वास और अभिगम की आवश्यकता होती है। भूमिका और अनुमति के बारे मे ज्यादा जानकारी के लिए
SIG Docs मे भाग लेना को देखें।

आपका पहला योगदान

आप अपने पहले योगदान की तैयारी के लिए दिए गए दिशानिर्देश को देख सकते हैं। नीचे दिया हुआ चित्र दिशानिर्देश और उसकी विस्तार मे जानकारी देता है।

flowchart LR subgraph second[पहला योगदान] direction TB S[ ] -.- G[दूसरे K8s मेम्बर्स के
PRs की समीक्षा करें] --> A[अपने पहले इशू (गुफ फर्स्ट इशू)
के लिए kubernetes/website
की इशू सूची पर जाएं] --> B[PR ओपन करें!!] end subgraph first[सूचित तैयारी] direction TB T[ ] -.- D[योगदान अवलोकन को पढे] -->E[K8s विषय
और विषय गाइड को पढ़ें] E --> F[Hugo पेज
विषय के प्रकार
और shortcodes के बारे मे जाने] end first ----> second classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,D,E,F,G grey class S,T spacewhite class first,second white
आकृति - आपके पहले योगदान की तैयारी

अगले कदम

सिग डॉक्स मे शामिल हो

SIG Docs योगदानकर्ताओ का एक समूह है जो कुबेरनेटेस प्रलेखन और वेबसाईट की देख रेख और उसे प्रकाशित करता है। SIG Docs मे शामिल होना कुबेरनेटस योगदानकर्ताओ (फीचर विकास या उससे अन्यथा) के लिए कुबेरनेटस परियोजना पर प्रभाव डालने का बेहतरीन तरीका है।

SIG Docs भिन्न प्रकार से संवाद करते हैं:

योगदान करने के अन्य तरीके

1 - SIG Docs में भाग लेना

SIG Docs, कुबेरनेट्स प्रोजेक्ट के विशेष रुचि समूहों (special interest groups) में से एक है, जो समग्र रूप से कुबेरनेट्स के लिए दस्तावेज़ीकरण लिखने, अपडेट करने और रखरखाव करने पर केंद्रित है। SIG के बारे में अधिक जानकारी के लिए community github repo से SIG Docs देखें।

SIG Docs सभी योगदानकर्ताओं से सामग्री और समीक्षा का स्वागत करता है। कोई भी pull request (PR) खोल सकता है, और कोई भी सामग्री के बारे में issues दर्ज कर सकता है या प्रगति में pull requests पर टिप्पणी कर सकता है।

आप सदस्य (member), समीक्षक (reviewer), या अनुमोदक (approver) भी बन सकते हैं। इन भूमिकाओं के लिए अधिक पहुंच की आवश्यकता होती है और परिवर्तनों को अनुमोदित करने और commit करने की कुछ जिम्मेदारियां होती हैं। कुबेरनेट्स समुदाय में सदस्यता कैसे काम करती है, इसके बारे में अधिक जानकारी के लिए community-membership देखें।

इस दस्तावेज़ का शेष भाग कुछ अनूठे तरीकों की रूपरेखा प्रस्तुत करता है जिनसे ये भूमिकाएं SIG Docs के भीतर कार्य करती हैं, जो कुबेरनेट्स के सबसे सार्वजनिक-सामना वाले पहलुओं में से एक -- कुबेरनेट्स वेबसाइट और दस्तावेज़ीकरण -- को बनाए रखने के लिए जिम्मेदार है।

SIG Docs अध्यक्ष

प्रत्येक SIG, जिसमें SIG Docs शामिल है, एक या अधिक SIG सदस्यों को अध्यक्षों के रूप में चुनता है। ये SIG Docs और कुबेरनेट्स संगठन के अन्य भागों के बीच संपर्क बिंदु हैं। उन्हें समग्र रूप से कुबेरनेट्स प्रोजेक्ट की संरचना और इसके भीतर SIG Docs कैसे काम करता है, इसका व्यापक ज्ञान होना आवश्यक है। अध्यक्षों की वर्तमान सूची के लिए Leadership देखें।

SIG Docs टीमें और स्वचालन

SIG Docs में स्वचालन दो अलग-अलग तंत्रों पर निर्भर करता है: GitHub टीमें और OWNERS फ़ाइलें।

GitHub टीमें

GitHub पर SIG Docs टीमों की दो श्रेणियां हैं:

  • @sig-docs-{language}-owners अनुमोदक और लीड हैं
  • @sig-docs-{language}-reviews समीक्षक हैं

प्रत्येक को उस समूह में सभी के साथ संवाद करने के लिए GitHub टिप्पणियों में उनके @name के साथ संदर्भित किया जा सकता है।

कभी-कभी Prow और GitHub टीमें बिना सटीक मिलान के ओवरलैप करती हैं। issues, pull requests के असाइनमेंट और PR अनुमोदन का समर्थन करने के लिए, स्वचालन OWNERS फ़ाइलों से जानकारी का उपयोग करता है।

OWNERS फ़ाइलें और front-matter

कुबेरनेट्स प्रोजेक्ट GitHub issues और pull requests से संबंधित स्वचालन के लिए prow नामक एक स्वचालन उपकरण का उपयोग करता है। कुबेरनेट्स वेबसाइट रिपॉजिटरी दो prow plugins का उपयोग करती है:

  • blunderbuss
  • approve

ये दोनों plugins kubernetes/website GitHub रिपॉजिटरी के शीर्ष स्तर पर OWNERS और OWNERS_ALIASES फ़ाइलों का उपयोग करते हैं ताकि यह नियंत्रित किया जा सके कि रिपॉजिटरी के भीतर prow कैसे काम करता है।

एक OWNERS फ़ाइल में उन लोगों की सूची होती है जो SIG Docs समीक्षक और अनुमोदक हैं। OWNERS फ़ाइलें उपनिर्देशिकाओं में भी मौजूद हो सकती हैं, और उस उपनिर्देशिका और उसके वंशजों में फ़ाइलों के समीक्षक या अनुमोदक के रूप में कौन कार्य कर सकता है, इसे ओवरराइड कर सकती हैं। सामान्य रूप से OWNERS फ़ाइलों के बारे में अधिक जानकारी के लिए, OWNERS देखें।

इसके अलावा, एक व्यक्तिगत Markdown फ़ाइल अपने front-matter में समीक्षकों और अनुमोदकों को सूचीबद्ध कर सकती है, या तो व्यक्तिगत GitHub usernames या GitHub groups को सूचीबद्ध करके।

OWNERS फ़ाइलों और Markdown फ़ाइलों में front-matter का संयोजन निर्धारित करता है कि PR मालिकों को स्वचालित प्रणालियों से अपने PR की तकनीकी और संपादकीय समीक्षा के लिए किससे पूछना है, इस बारे में क्या सलाह मिलती है।

मर्जिंग कैसे काम करती है

जब एक pull request को सामग्री प्रकाशित करने के लिए उपयोग की जाने वाली branch में मिलाया जाता है, तो वह सामग्री https://kubernetes.io पर प्रकाशित होती है। यह सुनिश्चित करने के लिए कि हमारी प्रकाशित सामग्री की गुणवत्ता उच्च है, हम pull requests को मिलाने को SIG Docs अनुमोदकों तक सीमित रखते हैं। यहां बताया गया है कि यह कैसे काम करता है।

  • जब एक pull request में lgtm और approve दोनों labels होते हैं, कोई hold labels नहीं होते, और सभी tests पास हो जाते हैं, तो pull request स्वचालित रूप से मिल जाता है।
  • कुबेरनेट्स संगठन के सदस्य और SIG Docs अनुमोदक किसी दिए गए pull request के स्वचालित मिलाने को रोकने के लिए टिप्पणियां जोड़ सकते हैं (/hold टिप्पणी जोड़कर या /lgtm टिप्पणी रोककर)।
  • कोई भी कुबेरनेट्स सदस्य /lgtm टिप्पणी जोड़कर lgtm label जोड़ सकता है।
  • केवल SIG Docs अनुमोदक /approve टिप्पणी जोड़कर pull request को मिला सकते हैं। कुछ अनुमोदक अतिरिक्त विशिष्ट भूमिकाएं भी निभाते हैं, जैसे PR Wrangler या SIG Docs अध्यक्ष

आगे क्या है

कुबेरनेट्स दस्तावेज़ीकरण में योगदान के बारे में अधिक जानकारी के लिए, देखें:

2 - प्रलेखन शैली अवलोकन

इस खंड के विषय लेखन शैली, सामग्री स्वरूपण, और संगठन, और कुबेरनेट्स प्रलेखन के लिए विशिष्ट Hugo अनुकूलन का उपयोग करने पर मार्गदर्शन प्रदान करते हैं।

3 - साइट विश्लेषिकी देखना

इस पृष्ठ में Kubernetes.io विश्लेषिकी डैशबोर्ड के बारे में जानकारी है।

डैशबोर्ड देखें

यह डैशबोर्ड Google Data Studio का उपयोग करके बनाया गया है और Google Analytics का उपयोग करके Kubernetes.io पर एकत्रित जानकारी दिखाता है।

डैशबोर्ड का उपयोग करना

डिफ़ॉल्ट रूप से, डैशबोर्ड पिछले 30 दिनों के सभी एकत्रित विश्लेषण दिखाता है। विभिन्न दिनांक सीमा मे आने वाला डेटा देखने के लिए date selector का उपयोग करें। अन्य फ़िल्टरिंग विकल्प आपको उपयोगकर्ता का स्थान, साइट तक पहुंचने के लिए उपयोग किए जाने वाले उपकरण, उपयोग किए गए दस्तावेज़ों के अनुवाद, और बहुत से चीज़ों का डेटा देखने की अनुमति देते हैं।

यदि आप इस डैशबोर्ड में कोई समस्या देखते हैं, या किसी सुधार का अनुरोध करना चाहते हैं, तो कृपया एक इशू बनाएं