জেনপাইপস প্রকল্প

এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷

প্রকল্পের সারসংক্ষেপ

ওপেন সোর্স সংস্থা:

জেনপাইপস

কৌশলী লেখক:

শালু

প্রকল্পের নাম:

'রিড দ্য ডক্স'-এ GenPipes ডক্স সেট আপ করুন

প্রকল্পের দৈর্ঘ্য:

স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)

প্রকল্প বর্ণনা

আমি 'রিড দ্য ডক্স'-এ জেনপাইপস ডকুমেন্টেশন সেট আপ করার লক্ষ্য অর্জনের জন্য একটি 3-পদক্ষেপ পরিকল্পনা প্রস্তাব করছি।

ধাপ 1: PoC

• নতুন ব্যবহারকারী/গবেষক হিসেবে GenPipes-এর বিদ্যমান ডকুমেন্টেশন পর্যালোচনা করুন

  • অনুপস্থিত তথ্য, ভুলত্রুটি সনাক্ত করুন
  • নতুন ডক বিষয়ের পরামর্শ দিন (যদি প্রয়োজন হয়)
  • নতুন ব্যবহারকারীদের উপর ফোকাস সহ লক্ষ্য দর্শকদের সম্বোধন করার জন্য খসড়া তথ্য আর্কিটেকচার মানচিত্র।

  (দ্রষ্টব্য: এই ধাপের সময়, আমাদের একটি নতুন গিটহাব রিপোজিটরি সেটআপ সংক্রান্ত জেনপাইপস পরামর্শদাতাদের ইনপুটও প্রয়োজন হতে পারে যেখানে আরটিডির জন্য জেনপাইপ ডক্স হোস্ট করা যেতে পারে। এই গিটহাব রেপোটি আরটিডি বিল্ড পাইপলাইনে সমস্ত ডক্স আমদানি করতে ব্যবহার করা যেতে পারে। এর জন্য অন্তর্দৃষ্টি প্রয়োজন হতে পারে GenPipes রেপো নিয়ম এবং ডক সোর্স ম্যানেজমেন্ট নির্দেশিকা যদি কোনো মেনে চলার প্রয়োজন হয়। অন্যথায় স্ট্যান্ডার্ড ব্যবহার করা যেতে পারে, afaik। এছাড়াও PoC এর জন্য, আমি আমার GitHub অ্যাকাউন্ট ব্যবহার করে একটি নমুনা RTD রেপো সেটআপ ডেমো করতে পারি - যেমন, https://gpdocs .readthedocs.io/en/latest/ - এটি একটি নমুনা যা আমি এই প্রস্তাবের জন্য তৈরি করেছি)

• পূর্ববর্তী ধাপে পর্যালোচনা এবং বিশ্লেষণের উপর ভিত্তি করে, প্রস্তাবিত জেনপাইপস ডকুমেন্টেশন স্ট্রাকচার/ইনডেক্সের একটি বেয়ারবোন কঙ্কাল তৈরি করুন এবং এটি RTD সাইটে রাখুন

  • এর মধ্যে GitHub রেপো তৈরি (উদাহরণস্বরূপ স্ফিংস টুলিং সহ) এবং মৌলিক ডকুমেন্টেশন ফাইলগুলি জড়িত
  • এটিতে একটি নতুন TOC সৃষ্টিও জড়িত যা বিভিন্ন বিভাগ / তথ্যের প্রবাহের জন্য নতুন ব্যবহারকারী এবং পাকা ব্যবহার উভয়কেই মাথায় রাখে।

• বেয়ারবোনস কঙ্কাল TOC পর্যালোচনা / অনুমোদন পান

  GenPipes GSoD মূল্যায়ন পর্বের সময়, আমি RTD এ হোস্ট করা এই নমুনার মাধ্যমে GenPipes-এর জন্য মান তৈরি করার চেষ্টা করেছি। অনুগ্রহ করে মনে রাখবেন, এটি শুধুমাত্র ডেমোর উদ্দেশ্যে, সুরক্ষিত লিঙ্ক, আরটিডিতে এখনও সর্বজনীনভাবে তালিকাভুক্ত করা হয়নি। আমি বাছাই করা যাই না কেন, এই ডেমোটি GenPipes RTD প্রচেষ্টাকে জাম্পস্টার্ট করতে ব্যবহার করা যেতে পারে। আমি ইতিমধ্যে c3g/GenPipes GitHub রেপোতে উত্সগুলি পরীক্ষা করেছি। পরামর্শদাতা, রোলা এবং হেক্টর আগে স্কাইপ 'শেয়ার স্ক্রিন' আলোচনার সময় এটি পছন্দ করেছিলেন এবং তাই আমি ভেবেছিলাম GSoD গডসও এটি দেখতে চাইতে পারেন। আপাতত এটির বেয়ারবোনস কঙ্কাল কিন্তু আমি 30 জুলাই পর্যন্ত সময় অনুমতি দিলে এটি আপডেট করার পরিকল্পনা করছি।

https://genpipes.readthedocs.io/en/latest/

ধাপ 2: GenPipes ডক v0.9 ডকসেট তৈরি

• GSoD টাইমলাইনকে মাথায় রেখে RTD তে হোস্ট করার জন্য কোন বর্তমান বা বিদ্যমান GenPipes নথিগুলি আমদানি, লিঙ্ক বা স্ফিনক্স/প্রথম ভিত্তিক ডকুমেন্টেশনে রূপান্তর করা যেতে পারে তা শনাক্ত করুন

• চিহ্নিত নথিগুলিকে প্রথম বিন্যাসে রূপান্তর করুন, যদি প্রয়োজন হয়, যেখানে প্রযোজ্য সেখানে নতুনগুলি তৈরি করুন, যা সম্ভব / প্রাসঙ্গিক তা পুনরায় ব্যবহার করুন।

  • ধারণার প্রমাণ হিসাবে এই প্রাথমিক ডক সেটটি ReadTheDocs-এ আমদানি করুন - এটি একটি সুরক্ষিত রেপো হিসাবে সেখানে হোস্ট করুন। রিভিউ/আনুষ্ঠানিক পরিবর্তন না করা পর্যন্ত নতুন ব্যবহারকারীদের GenPipes মূল ডকুমেন্টেশনে যাওয়ার পরামর্শ দিয়ে একটি নোট আগাম রাখুন।

• পর্যালোচনা/কোর্স-সঠিক/আপডেট

ধাপ 3: RTD-এ প্রথম খসড়াটি পরিমার্জন, পর্যালোচনা এবং প্রকাশ করুন

• GenPipes TOC-তে প্রস্তাবিত GenPipes নতুন ডক কাঠামোর বিশদ বিবরণ পূরণ করুন – প্রথম কয়েকটি (GenPipes Readme), ধারণা, টিউটোরিয়াল ইত্যাদি ছাড়াও অতিরিক্ত ডক্স যোগ করুন।

• নতুন ব্যবহারকারী, অভিজ্ঞ GenPipes ব্যবহারকারী, GenPipes ডেভেলপার ইত্যাদিকে সম্বোধন করতে TOC-তে স্পষ্ট সীমানা যোগ করুন।

• GenPipes ডকসেট কীভাবে রক্ষণাবেক্ষণ করা যায়, ব্যবহারকারীদের দ্বারা সম্পাদনা করা যায় এবং যদি C3G বহিরাগত ডক অবদানকারীদের জন্য অনুমতি দেয় তবে RTD (sphinx builds) এর মাধ্যমে পার্ট অটোমেশন সহ একটি কাজের প্রক্রিয়ার পরামর্শ দিন। কোডিং নির্দেশিকাগুলির অনুরূপ ডক আপডেটগুলির জন্য এর জন্য কিছু নির্দেশিকা তৈরির প্রয়োজন হতে পারে৷ আরও উপ-পদক্ষেপ প্রয়োজন হতে পারে। যেমন, GenPipes ডক্সে PR অনুমোদনের আগে স্বয়ংক্রিয় বানান পরীক্ষা করুন।

রিপোর্ট

অবশেষে, পরামর্শদাতাদের অভিজ্ঞতা, লগ, প্রতিক্রিয়ার উপর ভিত্তি করে GSoD-এর জন্য একটি প্রতিবেদন তৈরি করুন।

অন্যান্য চিন্তা

ভবিষ্যতে (3 মাসের বেশি), যদি প্রযোজ্য হয়, আমি GenPipes-এর জন্য এটিকে দীর্ঘ মেয়াদে বজায় রাখতে সাহায্য করতে পারি। অথবা প্রয়োজনে অন্যদেরও প্রশিক্ষণ দিন। আমরা এই প্রথম 3 মাসের ফলাফলের উপর ভিত্তি করে এটি বের করতে পারি।

এছাড়াও, আমি অতিরিক্ত প্রজেক্ট প্রপোজাল আইডিয়ার পরামর্শ দেব - একটি GenPipes 3 পৃষ্ঠার ব্রিফ তৈরি করা যা সহজে অন-বোর্ডিংয়ে সাহায্য করে। আজ, একজন নতুন ব্যবহারকারীকে GenPipes দিয়ে শুরু করার আগে অনেক ঝাঁপিয়ে পড়তে হয় কারণ ডকুমেন্টেশন ভালো কিন্তু বিক্ষিপ্ত এবং নতুন ব্যবহারকারীদের জন্য উপযোগী নয়। এটি 3 মাসের মধ্যে করা যেতে পারে কিনা তা নিশ্চিত নই, তবে আমি চেষ্টা করে এটি একটি শট দিতে চাই।

এই একই প্রস্তাব এবং এটি কীভাবে এসেছে (ইতিহাস) তাও https://drive.google.com/file/d/1oKVp_7ZeYGMxhynfc97qUUcGNh2CNbX0/view?usp=sharing এ দেখা যেতে পারে