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

इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.

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

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

क्रिएटिव कॉमंस

तकनीकी लेखक:

JackieBinya

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

WordPress बेस थीम का इस्तेमाल करने की गाइड

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

मानक अवधि (तीन महीने)

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

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

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

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

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

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

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

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

इसके अलावा, मेरे प्रस्ताव का सारांश नीचे दिया गया है:

क्रिएटिव कॉमंस - WordPress की बेस थीम के इस्तेमाल की गाइड 28 जून, 2020 को जैकलीन बिन्या ने एक प्रस्ताव तैयार किया था

Project Sinopsis इस प्रोजेक्ट का मुख्य लक्ष्य, क्रिएटिव कॉमंस WordPress Base थीम के लिए, बेहतर, इस्तेमाल करने में आसान, दिलचस्प, और खूबसूरती से पेश किए जाने वाले, समुदाय के लिए दस्तावेज़ बनाना है.

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

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

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

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

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

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

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

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

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

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

• हुक सेक्शन

• खास जानकारी

  • हुक शब्द को समझाएं
  • बताएं कि दर्शकों को हुक का फ़ायदा क्यों उठाना होगा.
  • उपलब्ध हुक के बारे में आउटलाइन करें.

• कार्रवाइयों का इस्तेमाल करना

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

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

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

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

योगदान सेक्शन * योगदान देने वाली बेहतर गाइड जोड़ें * आचार संहिता की आउटलाइन करें * समुदाय: क्रिएटिव कॉमंस कम्यूनिटी चैनलों के बारे में जानकारी दें और बताएं कि योगदान देने वाले लोग इसमें कैसे हिस्सा ले सकते हैं वगैरह.