क्रिएटिव कॉमंस प्रोजेक्ट

इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.

प्रोजेक्ट की खास जानकारी

ओपन सोर्स संगठन:

Creative Commons

टेक्निकल राइटर:

JackieBinya

प्रोजेक्ट का नाम:

WordPress के बुनियादी थीम के इस्तेमाल के बारे में गाइड

प्रोजेक्ट की अवधि:

स्टैंडर्ड लंबाई (तीन महीने)

प्रोजेक्ट का विवरण

GSOD-2020 के लिए, तकनीकी लेखक के तौर पर आवेदन करने के दौरान, मेरी मुलाकात ह्यूगो सोलर से कई बार हुई. वे Creative Commons WordPress बेस थीम के दस्तावेज़ से जुड़े प्रोजेक्ट के मेंटर हैं.

मैंने शुरुआत में उनसे WordPress की बुनियादी थीम के इस्तेमाल से जुड़ी गाइड बनाने के मकसद को समझने में मदद मांगी थी. उन्होंने मुझे इस प्रोजेक्ट में शामिल होने में तुरंत मदद की. इसके बाद, हमारे बीच हुए सभी इंटरैक्शन में, CC WordPress बेस थीम के दस्तावेज़ के मकसद को बेहतर बनाने के बारे में बातचीत हुई.

जब मुझे लगा कि मुझे प्रोजेक्ट की ज़रूरतों और मकसद के बारे में पता चल गया है, तब मैंने CC WordPress बेस थीम के इस्तेमाल से जुड़ी गाइड का ड्राफ़्ट बनाया.

इंटर्न के आवेदन के लिए, Creative Commons के आधिकारिक टेंप्लेट का इस्तेमाल करके प्रस्ताव बनाया गया था. इसमें, WordPress की नई बेस थीम के दस्तावेज़ की खास जानकारी, प्रोजेक्ट के प्रस्तावित स्ट्रक्चर, और लेआउट के बारे में जानकारी मिलती है. साथ ही, दस्तावेज़ बनाने के चरण के लिए टाइमलाइन और डिलीवरबल के बारे में जानकारी भी मिलती है.

इसके बाद, ह्यूगो सोलर ने मेरे ड्राफ़्ट प्रस्ताव की समीक्षा की और मुझे इसमें सुधार करने के लिए सुझाव दिए. इस पूरी प्रोसेस के दौरान, वह प्रोजेक्ट के बारे में सवालों के जवाब देने के लिए हमेशा उपलब्ध रहे.

हमने आपके सुझावों को लागू कर दिया है. साथ ही, डी&आई बैजिंग दस्तावेज़ बनाने के लिए हमारा फ़ाइनल प्रस्ताव, नीचे दिए गए लिंक में Google दस्तावेज़ के तौर पर उपलब्ध है

https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing

इसके अलावा, मेरे प्रस्ताव की खास जानकारी यहां दी गई है:

Creative Commons - WordPress की बुनियादी थीम के इस्तेमाल से जुड़ी गाइड जैकलीन बिन्या ने 28 जून, 2020 को तैयार किया गया प्रस्ताव

प्रोजेक्ट सारांश इस प्रोजेक्ट का अंतिम लक्ष्य Creative Commons WordPress बेस थीम के लिए समृद्ध, सहज, दिलचस्प, और सुंदर तरीके से पेश किए गए समुदाय के सामने पेश करने वाला दस्तावेज़ तैयार करना है.

प्रोजेक्ट प्लान समस्या फ़िलहाल, Creative Commons WordPress Base थीम का कोई दस्तावेज़ उपलब्ध नहीं है. इस वजह से, कम्यूनिटी में इस थीम का असरदार तरीके से इस्तेमाल नहीं किया जा सकता. मेरा लक्ष्य, थीम के इस्तेमाल से जुड़ी पूरी गाइड बनाना है. साथ ही, WP Base थीम के मौजूदा कोडबेस में एब्स्ट्रैक्शन लागू करना है, ताकि थीम का इस्तेमाल आसानी से किया जा सके.

समाधान Gatsby जैसे आधुनिक फ़्रेमवर्क का इस्तेमाल करके, फ़्यूचरिस्टिक दस्तावेज़ बनाएं. Gatsby में स्टार्टर होते हैं, जिनका इस्तेमाल करके WordPress की नई बेस थीम के दस्तावेज़ को बूटस्ट्रैप किया जा सकता है. gatsby-gitbook-starter एक स्टार्टर का उदाहरण है. यह स्टार्टर, सर्च इंजन ऑप्टिमाइज़ेशन (एसईओ), मार्कडाउन, और Algolia ( स्टैटिक साइटों में खोज के लिए इंटिग्रेट करने के लिए इस्तेमाल किया जाने वाला टूल) के साथ काम करता है. इसके अलावा, Gatsby की जनरेट की गई किसी भी साइट को आसानी से ऑप्टिमाइज़ किया जा सकता है, ताकि वह अंतरराष्ट्रीय मानकों के मुताबिक और सुलभता से जुड़ा हो. दस्तावेज़ बनाते समय, मेरा मकसद इसे ज़्यादा से ज़्यादा आसान बनाना है. इसके लिए: - दस्तावेज़ को आसानी से समझने लायक तरीके से लिखा जाता है. साथ ही, इसमें किसी भी तरह की गड़बड़ी और ज़्यादा जटिल तकनीकी शब्दों का इस्तेमाल नहीं किया जाता. - सीखने-सिखाने के लिए विज़ुअल का इस्तेमाल करने के लिए, दस्तावेज़ों में ग्राफ़िक और मीडिया कॉन्टेंट का इस्तेमाल किया जाता है. - सामान्य टास्क को पूरा करने का तरीका बताने वाले उदाहरणों का इस्तेमाल करना.जैसे, पसंद के मुताबिक बनाने की सुविधा.

मुझे उम्मीद है कि इन एब्स्ट्रैक्शन को लागू करने से, यह पक्का किया जा सकेगा कि WP बेस थीम के ज़्यादातर मुख्य फ़ंक्शन, जैसे कि हुक का इस्तेमाल, WordPress के एडमिन पैनल से किया जा सके. इसके अलावा, मुझे एक अलग रिपॉज़िटरी में WP Base Theme के लिए स्टार्टर चाइल्ड थीम बनानी है. स्टार्टर चाइल्ड थीम होने पर, नए उपयोगकर्ताओं को आसानी से और तेज़ी से साइन अप करने का अनुभव मिलेगा. दस्तावेज़ तैयार होने और मंज़ूरी मिलने के बाद, उसे ऑनलाइन पब्लिश और होस्ट किया जाएगा.

CC WordPress के बेस थीम के इस्तेमाल के बारे में बताने वाली गाइड का सुझाया गया स्ट्रक्चर - सबमिट किए गए दस्तावेज़ को नीचे दिए गए अलग-अलग सेक्शन में बांटा जाएगा. इसके बाद, सुझाए गए हर सेक्शन में मौजूद सब-लिस्ट के आइटम, उस सेक्शन में मौजूद असल कॉन्टेंट के बारे में ज़्यादा जानकारी देते हैं.

खास जानकारी वाला सेक्शन - Creative Commons(CC) WordPress की बेस थीम की परिभाषा, मकसद, और सुविधाओं के बारे में बताएं. * परिभाषा: CC WP Base Theme के बारे में कम शब्दों में बताएं. * मकसद: CC WP Base Theme के मकसद/ इरादों के बारे में बताएं * सुविधाएं: CC WP Base Theme की सुविधाओं के बारे में बताएं

शुरू करने का सेक्शन - ज़रूरी शर्तें * CC WordPress बेस थीम को इंस्टॉल करने की ज़रूरी शर्तों के बारे में बताएं. जैसे, - WordPress वर्शन - PHP वर्शन - Composer वगैरह - इंस्टॉल करने की गाइड * बताएं कि उपयोगकर्ता, CC WordPress थीम को इंस्टॉल करने के लिए, zip का इस्तेमाल कैसे कर सकते हैं * बताएं कि उपयोगकर्ता, GitHub से WP बेस थीम को क्लोन करके कैसे शुरू कर सकते हैं. * बताएं कि उपयोगकर्ता, प्रोजेक्ट में डिपेंडेंसी कैसे इंस्टॉल कर सकते हैं. * बताएं कि उपयोगकर्ता, डिपेंडेंसी Queulat को कैसे कॉन्फ़िगर कर सकते हैं. * बताएं कि उपयोगकर्ता अपने लोकल WordPress डेवलपमेंट एनवायरमेंट में थीम को कैसे चालू कर सकते हैं.

इस्तेमाल से जुड़ी गाइड - खास जानकारी * चाइल्ड थीम की परिभाषा बताएं * चाइल्ड थीम इस्तेमाल करने के फ़ायदे बताएं. * उपयोगकर्ताओं को बताएं कि WP Base थीम में बदलाव करने का सुझाया गया तरीका, चाइल्ड थीम का इस्तेमाल करना है. * उपयोगकर्ता को चाइल्ड थीम बनाने से पहले, इस बात को हाइलाइट करें कि WP की बेस थीम को इंस्टॉल और चालू करना ज़रूरी है.

चाइल्ड थीम का इस्तेमाल करना - बताएं कि उपयोगकर्ता, स्टार्टर का इस्तेमाल करके WP Base Theme की चाइल्ड थीम कैसे बना सकते हैं. वीडियो का इस्तेमाल करके बताएं कि उपयोगकर्ता, स्टार्टर से चाइल्ड थीम कैसे बना सकते हैं.

कस्टमाइज़ेशन नीचे दिए गए सब-सेक्शन में, हमने बताया है कि उपयोगकर्ता कैसे अपनी ज़रूरत के मुताबिक, WordPress कस्टमाइज़र और WordPress के एडमिन पैनल का इस्तेमाल करके, अपनी पसंद के मुताबिक बदलाव कर सकते हैं. हम अपने ब्यौरे को ज़्यादा आसान बनाने के लिए, ग्राफ़िक इलस्ट्रेशन का भी इस्तेमाल करेंगे. - साइट के ब्यौरे या टैगलाइन को पसंद के मुताबिक बनाएं. - कस्टम नेविगेशन मेन्यू - सीएसएस को पसंद के मुताबिक बनाना - पेज जोड़ना - पोस्ट जोड़ना - विजेट - WordPress के एडमिन पैनल से विजेट जोड़ना और हटाना - लाइव झलक के साथ कस्टमाइज़र का इस्तेमाल करके विजेट जोड़ना

बेहतर कस्टमाइज़ेशन सेक्शन - सीएसएस सेक्शन को पसंद के मुताबिक बनाना * उन कॉम्पोनेंट के बारे में बताएं जो थीम की स्टाइलिंग में शामिल होते हैं: - CC Vocabulary - Bulma - Sass * बताएं कि प्रोजेक्ट में Sass को कैसे सेट अप किया जाता है. इस जानकारी में इनके बारे में जानकारी होनी चाहिए: (i) प्रोजेक्ट स्ट्रक्चर में sass फ़ाइलों की जगह (ii)npm स्क्रिप्ट, जिनका इस्तेमाल sass बनाने और देखने के लिए किया जा सकता है * यह बताएं कि फिर उपयोगकर्ता चाइल्ड थीम में sass स्टाइल को पसंद के मुताबिक कैसे बना सकते हैं, जैसे कि खास npm डिपेंडेंसी को इंस्टॉल करके * बताएं कि कॉम्पोनेंट क्लास (class-component.php) को पसंद के मुताबिक कैसे बनाएं

• हुक सेक्शन

• खास जानकारी

  • हुक के बारे में बताना
  • बताएं कि उपयोगकर्ताओं को हुक का इस्तेमाल क्यों करना चाहिए.
  • उपलब्ध हुक के टाइप की जानकारी दें.

• ऐक्शन का इस्तेमाल करना

  • WP Base थीम में उपलब्ध कार्रवाइयों और उनकी पोज़िशन की सूची
  • बताएं कि इन कार्रवाइयों को कैसे लागू किया जा सकता है.

*फ़िल्टर का इस्तेमाल करना - थीम में उपलब्ध फ़िल्टर की सूची बनाएं और बताएं कि उन्हें कैसे लागू किया जा सकता है

थीम सेक्शन अपडेट करना - बताएं कि उपयोगकर्ता, थीम को कैसे अपडेट कर सकते हैं.

लाइसेंस सेक्शन * प्रोजेक्ट के लाइसेंस के बारे में बताएं. साथ ही, यह भी बताएं कि निजी प्रोजेक्ट में CC WP Base Theme का इस्तेमाल करने वाले लोगों के लिए इसका क्या मतलब है.

योगदान देने से जुड़ा सेक्शन * योगदान देने के बारे में पूरी जानकारी देने वाली गाइड जोड़ें * आचार संहिता के बारे में बताएं * कम्यूनिटी: Creative Commons के कम्यूनिटी चैनलों के बारे में जानकारी दें. साथ ही, यह भी बताएं कि योगदान देने वाले लोग इन चैनलों में कैसे हिस्सा ले सकते हैं वगैरह.