zzugab/juice-shop-with-kubeadm-and-tfकुबेरनेट्स पर कुबेडम और टेराफॉर्म का उपयोग करके OWASP Juice Shop का स्वचालित परिनियोजन, DevSecOps पाइपलाइनों के लिए एकीकृत Trivy भेद्यता स्कैनिंग के साथ।
GitLab के साथ शुरू करना आसान बनाने के लिए, यहाँ अनुशंसित अगले कदमों की सूची दी गई है।
पहले से ही प्रो? बस इस README.md को संपादित करें और इसे अपना बनाएं। इसे आसान बनाना चाहते हैं? नीचे दिए गए टेम्पलेट का उपयोग करें!
cd existing_repo
git remote add origin https://gitlab.com/zzugab/juice-shop-with-kubeadm-and-tf.git
git branch -M main
git push -uf origin main
GitLab में निर्मित सतत एकीकरण का उपयोग करें।
जब आप इस README को अपना बनाने के लिए तैयार हों, तो बस इस फ़ाइल को संपादित करें और नीचे दिए गए उपयोगी टेम्पलेट का उपयोग करें (या इसे जैसे चाहें संरचित करने के लिए स्वतंत्र महसूस करें - यह सिर्फ एक शुरुआती बिंदु है!). इस टेम्पलेट के लिए makeareadme.com का धन्यवाद।
हर प्रोजेक्ट अलग होता है, इसलिए विचार करें कि इनमें से कौन से अनुभाग आपके प्रोजेक्ट पर लागू होते हैं। टेम्पलेट में उपयोग किए गए अनुभाग अधिकांश ओपन सोर्स प्रोजेक्ट्स के लिए सुझाव हैं। यह भी ध्यान रखें कि जबकि README बहुत लंबा और विस्तृत हो सकता है, बहुत लंबा होना बहुत छोटे से बेहतर है। यदि आपको लगता है कि आपका README बहुत लंबा है, तो जानकारी काटने के बजाय दस्तावेज़ीकरण के किसी अन्य रूप का उपयोग करने पर विचार करें।
अपने प्रोजेक्ट के लिए एक स्व-व्याख्यात्मक नाम चुनें।
लोगों को बताएं कि आपका प्रोजेक्ट विशेष रूप से क्या कर सकता है। संदर्भ प्रदान करें और किसी भी संदर्भ का लिंक जोड़ें जिससे आगंतुक अपरिचित हो सकते हैं। सुविधाओं की सूची या पृष्ठभूमि उपखंड भी यहाँ जोड़ा जा सकता है। यदि आपके प्रोजेक्ट के विकल्प हैं, तो यह विभेदक कारकों को सूचीबद्ध करने के लिए एक अच्छी जगह है।
कुछ README पर, आप छोटी छवियां देख सकते हैं जो मेटाडेटा बताती हैं, जैसे कि प्रोजेक्ट के सभी परीक्षण पास हो रहे हैं या नहीं। आप अपने README में कुछ जोड़ने के लिए Shields का उपयोग कर सकते हैं। कई सेवाओं में बैज जोड़ने के निर्देश भी होते हैं।
आप जो बना रहे हैं उसके आधार पर, स्क्रीनशॉट या वीडियो भी शामिल करना एक अच्छा विचार हो सकता है (आप अक्सर वास्तविक वीडियो के बजाय GIF देखेंगे)। ttygif जैसे उपकरण मदद कर सकते हैं, लेकिन अधिक परिष्कृत विधि के लिए Asciinema देखें।
किसी विशेष पारिस्थितिकी तंत्र के भीतर, चीजों को स्थापित करने का एक सामान्य तरीका हो सकता है, जैसे Yarn, NuGet, या Homebrew का उपयोग करना। हालाँकि, इस संभावना पर विचार करें कि आपका README पढ़ने वाला कोई नौसिखिया है और अधिक मार्गदर्शन चाहता है। विशिष्ट चरणों को सूचीबद्ध करने से अस्पष्टता दूर होती है और लोगों को आपके प्रोजेक्ट का उपयोग जल्द से जल्द शुरू करने में मदद मिलती है। यदि यह केवल किसी विशिष्ट संदर्भ में चलता है जैसे किसी विशेष प्रोग्रामिंग भाषा संस्करण या ऑपरेटिंग सिस्टम या इसमें निर्भरताएँ हैं जिन्हें मैन्युअल रूप से स्थापित किया जाना चाहिए, तो एक आवश्यकताएँ उपखंड भी जोड़ें।
उदाहरणों का उदारतापूर्वक उपयोग करें, और यदि संभव हो तो अपेक्षित आउटपुट दिखाएं। उपयोग का सबसे छोटा उदाहरण इनलाइन रखना सहायक होता है, जबकि अधिक परिष्कृत उदाहरणों के लिंक प्रदान करें यदि वे README में शामिल करने के लिए बहुत लंबे हैं।
लोगों को बताएं कि वे मदद के लिए कहाँ जा सकते हैं। यह एक इश्यू ट्रैकर, चैट रूम, ईमेल पता आदि का कोई भी संयोजन हो सकता है।
यदि आपके पास भविष्य में रिलीज़ के लिए विचार हैं, तो उन्हें README में सूचीबद्ध करना एक अच्छा विचार है।
बताएं कि क्या आप योगदान के लिए खुले हैं और उन्हें स्वीकार करने के लिए आपकी क्या आवश्यकताएं हैं।
जो लोग आपके प्रोजेक्ट में बदलाव करना चाहते हैं, उनके लिए शुरू करने के तरीके पर कुछ दस्तावेज़ीकरण होना सहायक है। शायद कोई स्क्रिप्ट है जिसे उन्हें चलाना चाहिए या कुछ पर्यावरण चर जिन्हें उन्हें सेट करने की आवश्यकता है। इन चरणों को स्पष्ट करें। ये निर्देश आपके भविष्य के स्वयं के लिए भी उपयोगी हो सकते हैं।
आप कोड को लिंट करने या परीक्षण चलाने के लिए कमांड भी दस्तावेज़ित कर सकते हैं। ये कदम उच्च कोड गुणवत्ता सुनिश्चित करने और परिवर्तनों के अनजाने में कुछ तोड़ने की संभावना को कम करने में मदद करते हैं। परीक्षण चलाने के निर्देश विशेष रूप से सहायक होते हैं यदि इसके लिए बाहरी सेटअप की आवश्यकता होती है, जैसे ब्राउज़र में परीक्षण के लिए Selenium सर्वर शुरू करना।
उन लोगों के प्रति अपनी प्रशंसा दिखाएं जिन्होंने प्रोजेक्ट में योगदान दिया है।
ओपन सोर्स प्रोजेक्ट्स के लिए, बताएं कि यह कैसे लाइसेंस प्राप्त है।
यदि आपके प्रोजेक्ट के लिए आपकी ऊर्जा या समय समाप्त हो गया है, तो README के शीर्ष पर एक नोट डालें जिसमें कहा गया हो कि विकास धीमा हो गया है या पूरी तरह से बंद हो गया है। कोई आपके प्रोजेक्ट को फोर्क करना चुन सकता है या मेंटेनर या मालिक के रूप में आगे आने के लिए स्वयंसेवा कर सकता है, जिससे आपका प्रोजेक्ट जारी रह सके। आप मेंटेनर के लिए स्पष्ट अनुरोध भी कर सकते हैं।