सामान्य परंपराएँ (General Conventions)
Examples:
यह सर्वोत्तम प्रक्रियाओं मार्गदर्शिका का यह भाग सामान्य परंपराओं को समझाता है।
चार्ट नाम
चार्ट के नाम छोटे अक्षरों (लोअरकेस) और संख्याओं में होने चाहिए। शब्दों को डैश (-) से अलग किया जा सकता है:
उदाहरण:
drupal
nginx-lego
aws-cluster-autoscaler
चार्ट नामों में बड़े अक्षर (uppercase) या अंडरस्कोर (_) का उपयोग नहीं किया जा सकता।
चार्ट नामों में डॉट्स (.) का उपयोग नहीं किया जाना चाहिए।
संस्करण संख्याएँ (Version Numbers)
जहाँ संभव हो, Helm संस्करण संख्याओं को दर्शाने के लिए
SemVer 2 का उपयोग करता है।
(ध्यान दें कि Docker इमेज टैग हमेशा SemVer का पालन नहीं करते हैं, और इस कारण यह एक दुर्भाग्यपूर्ण अपवाद माना जाता है।)
जब Kubernetes लेबल्स में SemVer संस्करणों को संग्रहीत किया जाता है, तो परंपरागत रूप से +
अक्षर को _
में बदल दिया जाता है,
क्योंकि लेबल्स में +
चिह्न की अनुमति नहीं होती।
YAML स्वरूपण (Formatting YAML)
YAML फ़ाइलों को दो स्थानों (two spaces) से इनडेंट किया जाना चाहिए (और कभी भी टैब का उपयोग नहीं करना चाहिए)।
Helm और Chart शब्दों का उपयोग (Usage of the Words Helm and Chart)
Helm और helm शब्दों के उपयोग के लिए कुछ परंपराएँ हैं:
- Helm पूरे प्रोजेक्ट को संदर्भित करता है।
helm
क्लाइंट-साइड कमांड को संदर्भित करता है।chart
शब्द को बड़े अक्षरों में लिखने की आवश्यकता नहीं है, क्योंकि यह एक विशेष संज्ञा (proper noun) नहीं है।- हालाँकि,
Chart.yaml
को बड़े अक्षरों में लिखा जाना आवश्यक है क्योंकि फ़ाइल नाम केस सेंसिटिव होता है।
यदि संदेह हो, तो Helm (बड़े 'H' के साथ) का उपयोग करें।