HeadlinesBriefing favicon HeadlinesBriefing.com

GitHub Wiki एंटी-पैटर्न: Wiki के बजाय /docs उपयोग करें

Hacker News •
×

"क्या मुझे विकी या GitHub पर डॉक्स फ़ोल्डर का उपयोग करना चाहिए?" चर्चा हर कुछ महीनों में फिर से सामने आती है। Shawn Wang के थ्री स्ट्राइक्स नियम का पालन करते हुए, लेखक का तर्क है कि GitHub पर विकी का उपयोग एक एंटी-पैटर्न है। विकी का एकमात्र लाभ इसकी निरंतर उपलब्धता है, लेकिन इसमें वर्जनिंग, लोकल एक्सेस, पीयर रिव्यू और ब्रांडिंग विकल्पों का अभाव है। इसके विपरीत, एक /docs फ़ोल्डर दस्तावेज़ीकरण को कोड के साथ एकीकृत करता है, वर्जनिंग का समर्थन करता है, पुल रिक्वेस्ट समीक्षाओं को सक्षम करता है, और Vale और स्पेलचेक जैसे टूल के साथ काम करता है। चूंकि विकी अपलोड का समर्थन नहीं करता, छवियों को कहीं और होस्ट किया जाना चाहिए। डॉक्स प्रकाशित करने के लिए, just-the-docs जैसे थीम के साथ GitHub Pages और एक /docs फ़ोल्डर का उपयोग करें। डॉक्स को कोड के साथ वर्जन रखने के लिए gh-pages ब्रांच से बचें। जैसे-जैसे प्रोजेक्ट बढ़ते हैं, डॉक्स एक अलग रेपो में जा सकते हैं, लेकिन योगदानकर्ता पहले से ही वर्कफ़्लो के आदी होंगे। लेखक ट्विटर पर प्रतिक्रिया आमंत्रित करता है।