এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- CERN-HSF
- কৌশলী লেখক:
- সবিতাআর
- প্রকল্পের নাম:
- অলপিক্স স্কোয়ার্ড ডকুমেন্টেশনের পুনর্গঠন ও স্ট্রীমলাইনিং
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
ওভারভিউ আমি দুটি প্রধান কারণের জন্য CERN-HSF এর Allpix Squared প্রকল্প বেছে নিয়েছি:
দক্ষতা বৃদ্ধি: এই প্রকল্পের বিদ্যমান ডকুমেন্টেশন ব্যাপক এবং একাধিক বিষয়বস্তু বিন্যাসকে একীভূত করে। এই বিস্তৃত ডক স্যুটের অডিটিং এবং পুনর্গঠন আমাকে আমার তথ্য আর্কিটেকচার এবং লেখার দক্ষতা পোলিশ করতে সাহায্য করবে। উপরন্তু, প্রকল্প ডোমেন (কণা পদার্থবিদ্যা!) আমার কাছে নতুন। এটা আমাকে আমার ডেভেলপার ইন্টারঅ্যাকশন দক্ষতা বাড়াতে চ্যালেঞ্জ করে। আমি বিশ্বাস করি যে প্রযুক্তিগত লেখকরা বিকাশকারীদের থেকে ইনপুটগুলি প্রক্রিয়া করতে পারে এবং ব্যবহারকারীদের যেকোনো স্তরের জন্য দরকারী সামগ্রী উপস্থাপন করতে পারে, যদি আমরা আমাদের প্রয়োজনীয় পটভূমি গবেষণা করি এবং সঠিক প্রশ্ন জিজ্ঞাসা করি। এই প্রকল্পটি আমাকে এই তত্ত্ব পরীক্ষা করতে দেবে!
প্রযুক্তিগত জ্ঞান-কীভাবে: এই প্রকল্পের জন্য হুগো প্রয়োজন - একটি টুল যা আমার শেখার তালিকার শীর্ষে রয়েছে। আমি LaTeX-Markdown-Hugo-GitLab-CI ওয়ার্কফ্লো শেখার জন্য উন্মুখ।
প্রযুক্তিগত লেখক অন্বেষণ পর্বের সময়, আমি প্রকল্পের পরামর্শদাতাদের সাথে সংক্ষিপ্তভাবে যোগাযোগ করেছি এবং বিদ্যমান ডক স্যুট কাঠামোর সাথে নিজেকে পরিচিত করেছি। আমি আমার উইন্ডোজ মেশিনে হুগো এবং ডকসি সঠিকভাবে কনফিগার করতে পারি কিনা তা পরীক্ষা করার জন্য আমি একটি ডেমো ওয়েবসাইট (https://ap2-demo.netlify.app/) তৈরি করেছি। আমি নেটলিফাইতে ওয়েবসাইটটি স্থাপন করতে সক্ষম হয়েছিলাম কিন্তু গিটল্যাব পৃষ্ঠাগুলিতে নয়। এই প্রকল্পটির বর্তমান স্থাপনার কর্মপ্রবাহ বজায় রাখার জন্য, আমি গিটল্যাব পৃষ্ঠাগুলিতে Hugo Docsy থিম স্থাপন করার একটি উপায় খুঁজে বের করব।
প্রত্যাশিত প্রকল্পের ফলাফল - একটি সুবিন্যস্ত প্রকল্প ওয়েবসাইট যা ডকুমেন্টেশন, কোড রেফারেন্স, টিউটোরিয়াল এবং সংবাদকে একীভূত করে। - একটি পুনর্গঠিত এবং পর্যালোচিত ব্যবহারকারী ম্যানুয়াল যা ব্যবহারকারী এবং বিকাশকারীদের জন্য উদ্দিষ্ট বিষয়বস্তুকে আলাদা করে এবং পূর্বে অনুপস্থিত তথ্য অন্তর্ভুক্ত করে। - কীভাবে ডকুমেন্টেশন, প্রায়শই জিজ্ঞাসিত প্রশ্নাবলী, এবং সাধারণভাবে সম্মুখীন সমস্যাগুলির উপলব্ধ উদাহরণ থেকে একটি টিউটোরিয়াল ওয়ার্কফ্লো।
প্রজেক্ট টুলস Allpix Squared এর বর্তমান ডকুমেন্টেশন GitLab এবং Gitlab CI ছাড়াও LaTeX, Doxygen, Pandoc এবং Hugo ব্যবহার করে। প্রকল্পের পরামর্শদাতারা এবং আমি ম্যাথজ্যাক্স প্লাগইনগুলির সাহায্যে ল্যাটেক্স থেকে মার্কডাউনে সামগ্রী স্থানান্তরিত করার বিষয়ে চ্যাট করেছি। আমি সফল হলে, ডক ওয়ার্কফ্লোতে তখন Hugo, Markdown, Doxygen, git এবং Gitlab CI জড়িত হবে। একই ওয়েবসাইট/প্ল্যাটফর্মের মধ্যে টিউটোরিয়াল রাখতে, আমি Hugo এবং Markdown ব্যবহার করব। আমি টিউটোরিয়ালের জন্য Codelabs-as-a-Tool (ClaaT) ব্যবহার করার সম্ভাব্যতা সম্পর্কে আগ্রহী। এই জুলাইয়ে, আমি ClaaT-Hugo ওয়ার্কফ্লো পরীক্ষা করব এবং নির্বাচিত হলে পরামর্শদাতাদের সাথে আলোচনা করব।
প্রকল্পের সময়কাল আমি অলপিক্স স্কোয়ার্ড প্রকল্পটি স্ট্যান্ডার্ড তিন মাসের মধ্যে (সেপ্টেম্বর 14, 2020 - নভেম্বর 30, 2020) সম্পূর্ণ করার জন্য অনুরোধ করছি, যে সময়ে আমি প্রায় ব্যয় করব৷ এটিতে প্রতি সপ্তাহে 15 ঘন্টা। এই ঘন্টাগুলিতে পরামর্শদাতা মিটিং এবং সম্পর্কিত ইমেলগুলি প্রয়োজন অনুসারে অন্তর্ভুক্ত থাকবে। আমি সম্প্রদায় বন্ধন এবং প্রকল্প চূড়ান্তকরণের জন্য GSoD সময়সীমা মেনে চলব।
প্রকল্পের কাজগুলি এখানে আমি কীভাবে বিদ্যমান অলপিক্স স্কয়ার ডক স্যুটে আমার প্রস্তাবিত আপডেটগুলি বাস্তবায়ন করতে চাই: 1. গবেষণা, আলোচনা এবং বিকল্পগুলি অন্বেষণ করুন (আগস্ট 17 - সেপ্টেম্বর 13, 2020): - প্রকল্পের প্রয়োজনীয়তাগুলি বুঝুন - সনাক্ত করতে অলপিক্স স্কোয়ার সফ্টওয়্যারটি ইনস্টল করুন বর্তমান ডক্সে অনুপস্থিত তথ্য, যদি থাকে। - প্রয়োজনীয় শংসাপত্রের জন্য অনুরোধ করুন। - Allpix Squared এর বিভিন্ন ব্যবহারকারীদের জন্য ব্যবহারকারীর কর্মপ্রবাহ তৈরি করুন - ব্যবহারকারীর ভূমিকা অনুসারে বিষয়বস্তু শ্রেণীবদ্ধ করুন - LaTeX ফাইলগুলিকে মার্কডাউনে রূপান্তরের প্রভাব পরীক্ষা করুন - উত্স সংগ্রহস্থলগুলি একত্রিত করুন বা একাধিক গিট রিপোজিটরিগুলির সাথে কীভাবে কাজ করবেন তা বুঝতে পারেন - বোনাস: টিউটোরিয়ালগুলির জন্য একটি বিকল্প হিসাবে CLaaT পরীক্ষা করুন - বোনাস: অবদানকারীদের ডক্স টাইমলাইন বজায় রাখতে সাহায্য করার জন্য একটি দ্রুত স্টাইল গাইড/শর্টকোড রেফারেন্স লেখক: সম্প্রদায় বন্ধন পর্ব
বিষয়বস্তু পুনর্গঠন, পর্যালোচনা এবং উন্নত করুন (সেপ্টেম্বর 14 - অক্টোবর 19, 2020): প্রতি সপ্তাহে দুটি কাজ, প্রতি টাস্কে প্রায় 5-7 ঘন্টা। এই টাইমলাইনে অপ্রত্যাশিত বিলম্ব বা সমস্যাগুলি পরিচালনা করার জন্য একটি বাফার সপ্তাহ অন্তর্ভুক্ত রয়েছে।
- ব্যবহারকারীর কর্মপ্রবাহকে মাথায় রেখে বিদ্যমান সামগ্রী এবং ব্যবহারকারীর শ্রেণিবিন্যাস পর্যালোচনা করুন
- বিভিন্ন ব্যবহারকারীদের জন্য রূপরেখা এবং পুনর্গঠিত বিষয়বস্তু কর্মপ্রবাহ পরীক্ষা করুন
- উৎস এবং অনুপস্থিত বিষয়বস্তু উন্নত
- LaTeX ফাইলগুলিকে মার্কডাউনে রূপান্তর করুন
- বিষয়বস্তু ব্যবহারকারী গাইড এবং বিকাশকারী গাইড সারণী চূড়ান্ত করুন
- ব্যবহারকারী এবং বিকাশকারী গাইডের পিডিএফ তৈরি করুন
- বোনাস: উদাহরণ এবং সমস্যা থেকে টিউটোরিয়ালের জন্য কাঠামোগত বিষয়বস্তু
- বোনাস: উদাহরণের জন্য একটি টিউটোরিয়াল ওয়ার্কফ্লো সেটআপ করুন টাইমলাইন: 5 সপ্তাহ (ডক ডেভেলপমেন্ট ফেজ)
ওয়েবসাইট তৈরি করুন (অক্টোবর 19 - নভেম্বর 30, 2020): প্রতি সপ্তাহে 1-2টি টাস্ক, প্রতি টাস্কে প্রায় 5-7 ঘন্টা। এই টাইমলাইনে সমস্যাগুলি সমাধান করার জন্য একটি বাফার সপ্তাহ রয়েছে এবং চূড়ান্ত আউটপুটটি সূক্ষ্ম-টিউন করা হয়েছে।
- প্রকাশনার কার্যপ্রবাহ বুঝুন এবং পরীক্ষা করুন
- Hugo এবং Docsy ব্যবহার করে একটি ওয়েবসাইট কাঠামো তৈরি করুন
- Docsy ব্যবহার করে কিভাবে বর্তমান স্বয়ংক্রিয় স্থাপনা এবং কর্মপ্রবাহ বজায় রাখা যায় তা পরীক্ষা করুন
- ডক্সিজেন থেকে সামগ্রী টানুন
- ল্যাটেক্স বা মার্কডাউন বিষয়বস্তু থেকে ব্যবহারকারীর ম্যানুয়াল, বিকাশকারী গাইড এবং টিউটোরিয়াল তৈরি করুন
- প্রকল্প ওয়েবসাইটের চেহারা এবং অনুভূতি চূড়ান্ত করুন (লোগো, রঙ, টেমপ্লেট, লেআউট, লিঙ্ক, ব্যবহারযোগ্যতা এবং গিটল্যাব সিআই/সিডি) টাইমলাইন: 6 সপ্তাহ (ডক ডেভেলপমেন্ট ফেজ)