Orbit
Orbit मे अपना प्रोजेक्ट README देखना
The Docs tab renders your repository's README inside KPanel, so the project's own documentation is one click from its deployments instead of in a browser tab someone has to go and find.
Docs टैब आपके रिपॉजिटरी के README को KPanel के अंदर रेंडर करता है, इसलिए प्रोजेक्ट का अपना डॉक्यूमेंटेशन इसके डिप्लॉयमेंट्स के एक क्लिक की दूरी पर होता है, न कि किसी ब्राउज़र टैब में जिसे कोई ढूंढने के लिए जाए।
Docs टैब कहां है
Orbit खोलें, प्रोजेक्ट पर क्लिक करें, और प्रोजेक्ट टैब स्ट्रिप में Overview ग्रुप के तहत Docs चुनें।
कोई कॉन्फ़िगरेशन की आवश्यकता नहीं है। यदि प्रोजेक्ट के पास इसकी रूट में README के साथ एक कनेक्टेड रिपॉजिटरी है, तो टैब इसे रेंडर करता है।
कौन सी फाइल दिखाई जाती है
Orbit कनेक्टेड रिपॉजिटरी की डिफ़ॉल्ट शाखा से README को प्राप्त करता है।
GitHub पर यह कई पारंपरिक नामों को क्रम में आजमाता है: README.md, readme.md, README.MD, README, और readme.txt, पहली फाइल को लेता है जो मौजूद है। GitLab और Bitbucket पर यह README.md को ढूंढता है।
केवल रिपॉजिटरी की रूट को जांचा जाता है। सबडायरेक्टरी के अंदर का README, एक मोनोरेपो ऐप की रूट डायरेक्टरी सहित, नहीं उठाया जाता है।
कंटेंट लगभग पांच मिनट के लिए कैश किया जाता है। अपने README में एक परिवर्तन पुश करें और टैब अभी भी संक्षेप में पुरानी टेक्स्ट दिखाएगा। यह सामान्य है; यह मान लेने के बजाय कि परिवर्तन नहीं आया, प्रतीक्षा करें और रीलोड करें।
क्या रेंडर होता है
README को मार्कडाउन के रूप में रेंडर किया जाता है: हेडिंग्स, सूचियां, टेबल, लिंक, इनलाइन कोड और फेंस्ड कोड ब्लॉक सभी आपकी अपेक्षानुसार दिखाई देते हैं।
README के अंदर सापेक्ष इमेज पाथ रिपॉजिटरी की ओर इशारा करते हैं, KPanel की ओर नहीं, इसलिए इमेजें जो आपके प्रदाता की अपनी साइट पर काम करती हैं वे यहां हल नहीं हो सकती हैं। यदि कोई इमेज महत्वपूर्ण है, तो एक पूर्ण URL का उपयोग करें।
खाली स्थितियां
जब दिखाने के लिए कुछ नहीं होता है तो दो स्थितियां सामग्री को बदल देती हैं:
- कोई रिपॉजिटरी कनेक्ट नहीं, Connect repository बटन के साथ। पहले एक कनेक्ट करें: GitHub रिपॉजिटरी को कनेक्ट करना, GitLab रिपॉजिटरी को कनेक्ट करना या Bitbucket रिपॉजिटरी को कनेक्ट करना देखें।
- कोई README नहीं मिला, आपको अपनी रिपॉजिटरी की रूट में एक
README.mdजोड़ने के लिए प्रेरित करता है, आपके प्रदाता पर एक बनाने के लिए एक लिंक के साथ।
दोनों प्रदाता के बाहर लिंक करते हैं ताकि आप तुरंत कार्य कर सकें, और जनसंख्या वाला दृश्य फाइल को स्वयं View on लिंक ले जाता है जब आप इसे संपादित करना चाहते हैं।
एक README लिखना जो रेंडर करने लायक है
क्योंकि यह टैब डिप्लॉय हिस्ट्री के बगल में बैठता है, एक Orbit प्रोजेक्ट के लिए सबसे उपयोगी README एक ऑपरेशनल होता है। कोई इसे खोलता है क्योंकि वे प्रोजेक्ट को अभी सौंपे गए हैं और सुरक्षित रूप से कुछ बदलने की जरूरत है।
एक संरचना जो काम करती है:
यह क्या है। एक पैराग्राफ। प्रोजेक्ट क्या करता है और यह किसे सेवा देता है।
इसे स्थानीय रूप से चलाना। सटीक कमांड, पैकेज मैनेजर सहित। pnpm install && pnpm dev एक पैराग्राफ को हराता है जो एक ही चीज का वर्णन करता है।
पर्यावरण चर। कौन से मौजूद हैं और प्रत्येक किसके लिए है। कभी भी मान नहीं: वे प्रोजेक्ट के पर्यावरण चर में हैं, रिपॉजिटरी में एक फाइल में नहीं। Orbit में पर्यावरण चर देखें।
यह कैसे डिप्लॉय होता है। कौन सी शाखा प्रोडक्शन है, क्या टैग डिप्लॉय होते हैं, और कौन से गेट लागू हैं। Orbit डिप्लॉयमेंट पाइपलाइन टैब की ओर इशारा करें, न कि इसे दोहराएं, क्योंकि टैब पुराना नहीं हो सकता और आपका README हो सकता है।
इसे कैसे रोल बैक करें। दो वाक्य और डिप्लॉयमेंट को रोल बैक करना के लिए एक लिंक। यह वह चीज है जो लोगों को अपने सबसे बुरे समय पर चाहिए, और यह उस जगह पर है जहां वे देखेंगे।
इसका मालिक कौन है। एक टीम या एक व्यक्ति। प्रोजेक्ट उन लोगों को जीवित रखते हैं जिन्होंने उन्हें सेट किया।
कभी भी एक README में क्रेडेंशियल न डालें। एक कनेक्शन स्ट्रिंग, एक API कुंजी या एक रिपॉजिटरी में प्रतिबद्ध पासवर्ड स्थायी रूप से हिस्ट्री में है, और बाद के प्रतिबद्धता में इसे हटाना इसे नहीं हटाता है। यदि यह हुआ है, तो हिस्ट्री को स्क्रब करने का प्रयास करने के बजाय क्रेडेंशियल को रोटेट करें।
एक लाइव स्टेटस बैज जोड़ना
चूंकि README को यहां और अपने प्रदाता पर रेंडर किया जाता है, एक डिप्लॉय स्टेटस बैज जोड़ने लायक है। Orbit हर प्रोजेक्ट के लिए एक प्रकाशित करता है।
Settings खोलें और Status badge कार्ड को खोजें। यह एक लाइव पूर्वावलोकन और तीन कॉपी बटन दिखाता है: बैज URL, एक मार्कडाउन स्निपेट, और एक HTML स्निपेट। अपने README के शीर्ष पर मार्कडाउन पेस्ट करें।
बैज एक छोटा SVG है जो प्रोजेक्ट के प्रोडक्शन पर्यावरण की वर्तमान स्थिति की रिपोर्ट करता है: deployed, building, failed, queued, या no deployments। इसे कोई प्रमाणीकरण की आवश्यकता नहीं है, इसलिए यह रिपॉजिटरी को पढ़ने वाले किसी के लिए भी रेंडर करता है, और यह KPanel में प्रोजेक्ट के लिए वापस लिंक करता है।
यह आपको एक README देता है जो एक दृष्टि पर दिखाता है कि प्रोडक्शन वर्तमान में स्वस्थ है या नहीं। यह एक ही सबसे उच्च मूल्य वाली लाइन है जो आप इसमें जोड़ सकते हैं।
इसे ईमानदार रखना
एक README जो एक सेटअप का वर्णन करता है जो प्रोजेक्ट के पास अब नहीं है, कोई README से भी बदतर है, क्योंकि लोग इस पर विश्वास करते हैं। दो आदतें इसे सटीक रखती हैं:
- लिंक करें, न कि डुप्लिकेट। कुछ भी जो KPanel में दृश्यमान है, जैसे कि बिल्ड सेटिंग्स, गेट और पर्यावरण कॉन्फ़िगरेशन, को पुनः कहा जाना चाहिए, न कि लिंक किया जाना चाहिए।
- इसे एक ही पुल रिक्वेस्ट में अपडेट करें। यदि कोई परिवर्तन प्रोजेक्ट कैसे चलता है यह बदल देता है, तो README परिवर्तन उस पुल रिक्वेस्ट में होना चाहिए, बाद के सफाई में नहीं।
समस्या निवारण
टैब एक पुराना संस्करण दिखाता है। पांच मिनट का कैश। प्रतीक्षा करें और रीलोड करें।
कोई README नहीं मिला, लेकिन एक है। जांचें कि यह रिपॉजिटरी रूट में है और README.md नाम है। GitLab और Bitbucket पर नाम को बिल्कुल मेल खाना होगा।
रिपॉजिटरी कनेक्ट है लेकिन टैब कहता है कि यह नहीं है। कनेक्शन ने एक्सेस खो दिया हो सकता है, उदाहरण के लिए यदि एकीकरण को प्रदाता की ओर से हटाया गया था। प्रोजेक्ट सेटिंग्स से इसे दोबारा कनेक्ट करें।
इमेजें लोड नहीं होती हैं। सापेक्ष पाथ यहां हल नहीं होते हैं। निरपेक्ष URL का उपयोग करें।
बैज कोई डिप्लॉयमेंट नहीं दिखाता है। प्रोडक्शन पर्यावरण में कभी भी सफल डिप्लॉयमेंट नहीं हुआ है। एक बार डिप्लॉय करें और यह अपडेट हो जाता है।
अगले कहां जाएं
- Orbit डिप्लॉयमेंट पाइपलाइन, README जो आमतौर पर वर्णन करने का प्रयास करता है उसका लाइव संस्करण।
- Orbit प्रोजेक्ट सेटिंग्स स्टेटस बैज और बाकी कॉन्फ़िगरेशन के लिए।
- Orbit में पर्यावरण चर उन मानों के लिए जो एक README में कभी नहीं होने चाहिए।