এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- CERN-HSF
- কৌশলী লেখক:
- আরিয়াডনে
- প্রকল্পের নাম:
- রুসিও - রুসিও ডকুমেন্টেশনকে আধুনিকীকরণ (পুনঃগঠন ও পুনর্লিখন)
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
বিমূর্ত: রুসিও ফ্রেমওয়ার্কটি ভিন্নধর্মী ডেটা সেন্টার জুড়ে ভৌগোলিকভাবে বিতরণ করা বৈজ্ঞানিক ডেটার বিশাল ভলিউম পরিচালনা এবং সংগঠিত করার লক্ষ্যে তৈরি করা হয়েছিল। বিতরণ করা ডেটা পুনরুদ্ধার এবং অভিযোজিত প্রতিলিপির মতো ক্ষমতা প্রদান করে, ফ্রেমওয়ার্কটি অত্যন্ত স্কেলযোগ্য, মডুলার এবং এক্সটেনসিবল। এই ধরনের পরিষেবার জন্য ডকুমেন্টেশনের ভোক্তারা বিভিন্ন ব্যাকগ্রাউন্ড থেকে হবে এবং এটি অ্যাক্সেস করার সময় বিভিন্ন প্রয়োজনীয়তা থাকবে। এই ধরনের পরিষেবার জন্য ভাল ডকুমেন্টেশন তাই, সাধারণ সমস্যা এবং সমস্যা সমাধানের জন্য একটি রেফারেন্স হওয়ার সাথে সাথে শেষ-ব্যবহারকারীদের জন্য এটি গ্রহণ এবং ব্যবহারকে সহজ করা উচিত।
এই ধরনের ডকুমেন্টেশনের অনুপস্থিতিতে, দক্ষ ও কার্যকর ব্যবহারে উল্লেখযোগ্য বাধা থাকবে। এটি সম্ভাব্যভাবে সমর্থন খরচ বৃদ্ধির দিকে নিয়ে যেতে পারে এবং পণ্যের কর্পোরেট পরিচয়ে সুনামগত ঝুঁকি তৈরি করতে পারে। ডকুমেন্টেশন, সর্বোপরি, যোগাযোগের একটি মোড। যথাযথ সংস্করণের সাথে প্রাসঙ্গিক থাকাকালীন যোগাযোগ একটি পরিচালনাযোগ্য এবং অ্যাক্সেসযোগ্য কাঠামোর মধ্যে রয়েছে তা নিশ্চিত করা, তাই, আমরা সাফল্যের জন্য যোগাযোগ করছি তা নিশ্চিত করা।
এটি লেখার সময়, LHC-এ ATLAS এবং CMS পরীক্ষাগুলির উচ্চ-শক্তির প্রয়োজনীয়তাগুলিকে শক্তি দেওয়ার জন্য রুসিও ফ্রেমওয়ার্ক ব্যবহার করা হয়েছে। এটি এলএইচসি-র বাইরে বিভিন্ন বৈজ্ঞানিক সম্প্রদায়ের চাহিদাগুলিকে সমর্থন করার জন্যও ব্যবহৃত হচ্ছে, যেমন অ্যাস্ট্রোফিজিক্স; এর ফলে ডকুমেন্টেশন যতটা সম্ভব প্রাসঙ্গিক এবং যতটা সম্ভব অ্যাক্সেসযোগ্য হতে হবে। এই প্রকল্পের সাহায্যে, CERN রুসিও-এর শেষ-ব্যবহারকারীদেরকে সমস্ত প্রাসঙ্গিক ডকুমেন্টেশন অ্যাক্সেস করার জন্য একটি কেন্দ্রীভূত দৃষ্টিভঙ্গি প্রদানের মাধ্যমে ফ্রেমওয়ার্ক ব্যবহার করার সময় একটি নিরবচ্ছিন্ন অভিজ্ঞতা লাভ করতে সক্ষম করতে চায়।
বর্তমান অবস্থা: আজ অবধি ব্যবহারকারীর ডকুমেন্টেশন বিভিন্ন জায়গায় ছড়িয়ে রয়েছে এবং বৈজ্ঞানিক নিবন্ধ, কোডের উত্স সহ readthedocs.io, Google ড্রাইভ, গিটহাব, ডকারহাব বা উইকিসহ একাধিক ফর্ম্যাটে রয়েছে। একাধিক উত্স সংস্করণগুলির ট্র্যাকিং এবং ডকুমেন্টেশনের সঠিকতার সাথে সমস্যাগুলি উপস্থাপন করে। উপরন্তু, ডকুমেন্টেশনের একটি বিকেন্দ্রীকৃত মডেল একটি প্রদত্ত ব্যবহারের ক্ষেত্রে প্রাসঙ্গিক তথ্যের নেভিগেশন এবং সার্ফেসিংয়ের ক্ষেত্রে উল্লেখযোগ্য বাধা সৃষ্টি করে। বিশেষ করে উইকির ক্ষেত্রে, একটি নির্দিষ্ট পরীক্ষার জন্য প্রদত্ত তথ্য একই/অন্যান্য উত্সগুলিতে বসবাসকারী অন্যান্য উদাহরণগুলির জন্যও প্রযোজ্য হতে পারে। তবে একত্রীকরণ এবং যথাযথ সংযোগের অভাবের কারণে, এই তথ্যটি সুপ্ত এবং সম্ভাব্যভাবে, কম ব্যবহার করা হয়েছে।
কেন আপনার প্রস্তাবিত ব্যবহারকারী ডকুমেন্টেশন বর্তমানের তুলনায় একটি উন্নতি? বহুমুখী সমস্যার প্রেক্ষিতে, নীচের প্রস্তাবিত মডেলটি নেভিগেশন, সংস্করণ, ট্র্যাকিং এবং ডকুমেন্টেশনের সারফেসিংয়ের প্রতিবন্ধকতাগুলিকে নীচে বিশদভাবে দূর করে:
ডকুমেন্টেশন পুনর্গঠনের লক্ষ্য একটি শেষ-ব্যবহারকারীর জন্য নেভিগেট করার জন্য ব্যয় করা প্রচেষ্টাকে সহজ করা। তথ্য অনুসন্ধান করার সময় তাকে খরগোশের গর্তে নামতে হবে না কারণ সেগুলিকে সরলতার জন্য শ্রেণীবদ্ধ/লেবেল করা হবে। প্রশাসনিক দৃষ্টিকোণ থেকে, সংস্করণ এবং ট্র্যাকিং সহজ করা হবে যেহেতু পুনর্গঠন প্রয়োজনের ভিত্তিতে শ্রেণীবদ্ধ করার স্বাধীনতা প্রদান করবে। সমস্ত পুনর্গঠিত ডকুমেন্টেশন কেন্দ্রীভূত করা নিশ্চিত করা হবে যে সমস্ত তথ্য একাধিক উত্স উল্লেখ না করেই ব্যবহারকারীর কাছে দৃশ্যমান।
বিশ্লেষণ: প্রয়োজনীয়তা সংক্ষিপ্ত এবং পরামর্শদাতা দলের সাথে কথোপকথনের মাধ্যমে পড়ার পরে, রুসিও ডকুমেন্টেশনের বর্তমান অবস্থা সম্পর্কে আমার বাদ দেওয়া হয়েছে:
ডকুমেন্টেশনের ছয়টি প্রধান উত্স রয়েছে: - গুগল ড্রাইভ লিঙ্ক: https://drive.google.com/drive/folders/1EEN8l1dFjDSgavPrAMMooDjEodHP7aU7
কোডে সোর্স সহ Sphinx দ্বারা চালিত Readthedocs কোডের লিঙ্ক: https://github.com/rucio/rucio ReadtheDocs-এর লিঙ্ক: https://rucio.readthedocs.io/en/latest/
ডকারহাব লিঙ্ক: https://hub.docker.com/u/rucio
গিটহাব লিঙ্ক: https://github.com/rucio/rucio
উইকি লিঙ্ক: https://twiki.cern.ch/twiki/bin/view/AtlasComputing/AtlasDistributedComputing
বৈজ্ঞানিক প্রবন্ধ লিঙ্ক: https://arxiv.org/abs/1902.09857
এই উত্স জুড়ে ডকুমেন্টেশন বিভিন্ন বিন্যাসে আছে. যেমন Google ড্রাইভে স্লাইড এবং ডক্স আকারে ডকুমেন্টেশন রয়েছে, গিটহাবের ফাইলগুলি প্রাথমিকভাবে পুনর্গঠিত পাঠ্য মার্কআপ ভাষা ইত্যাদিতে রয়েছে। সংস্করণ এবং ট্র্যাকিংয়ের অভাব রয়েছে যার ফলে একাধিক উত্স জুড়ে অপ্রয়োজনীয় তথ্য প্রকাশিত হচ্ছে। তথ্যের লেবেলিং/শ্রেণীকরণে কোনো অভিন্নতা নেই। অতএব, অনুসন্ধান করার সময় পূর্বের অভিজ্ঞতা এবং দক্ষতা প্রয়োজন।
অগণিত বিন্যাস এবং উত্সের পরিপ্রেক্ষিতে, প্রত্যাশা হল তথ্য পুনর্গঠন করা এবং mkdocs ব্যবহার করে কেন্দ্রীকরণ করা। সরঞ্জাম সম্পর্কে আমার বোঝার উন্নতির দিকে, আমি তাদের ব্যবহারের সাথে গবেষণা করেছি এবং নিজেকে পরিচিত করেছি।
রায়: বিদ্যমান ডকুমেন্টেশন যথাযথ লিঙ্কিং ছাড়াই অসংগঠিত এবং বিক্ষিপ্ত। এটি বিন্যাসে কেন্দ্রীকরণ এবং অভিন্নতারও অভাব রয়েছে। এর ফলে ব্যবহারকারীদের অনুসন্ধানের জন্য অতিরিক্ত প্রচেষ্টা ব্যয় করতে হবে। এই ধরনের ফাঁকগুলি প্রশাসক/রক্ষণাবেক্ষণকারী/লিডের উপর অপ্রয়োজনীয় চাপও প্রবর্তন করে যার কারণে রক্ষণাবেক্ষণ এবং ডকুমেন্টেশন আপডেট করার জন্য সম্প্রদায়-চালিত পদ্ধতি বজায় রাখা কঠিন হয়ে পড়ে। ব্যবহারকারী এবং অবদানকারীর অভিজ্ঞতা যথেষ্ট অবনতি হয়েছে এবং এটি পুনরাবৃত্তি হবে
প্রস্তাবিত ডকুমেন্টেশনের জন্য কাঠামো: প্রয়োজনীয়তাগুলির একটি পুঙ্খানুপুঙ্খ বিশ্লেষণের পরে, আমি ডকুমেন্টেশনের একটি পুনর্গঠিত মডেলের মাধ্যমে প্রধান ব্যথার পয়েন্টগুলি সমাধান করার সিদ্ধান্ত নিয়েছি।
পুনর্গঠিত মডেলটি নীচে সংযুক্ত মক-আপে প্রদর্শিত হয়েছে এবং প্রতিটি ডকুমেন্টেশনকে নীচের 7টি বিভাগে শ্রেণীবদ্ধ করবে:
- সম্পর্কিত
- শুরু হচ্ছে
- ধারণা
- রুসিও ইন্টারফেস
- কাজ
- টিউটোরিয়াল
- উন্নত জানা-কিভাবে
অবশ্যই, এই প্রোগ্রামের সমাপ্তির পরে আমি কাজ করতে চাই এমন লিঙ্ক যোগ করার মতো উন্নতি আছে। 1000 টিরও বেশি সক্রিয় ব্যবহারকারীরা Rucio-এ 500 পেটাবাইট ডেটা অ্যাক্সেস করে, এর ডকুমেন্টেশনের প্রস্তাবিত পুনর্গঠন ব্যবহারকারীদের সমর্থন মেইলিং তালিকায় যাওয়ার প্রয়োজনীয়তা উল্লেখযোগ্যভাবে হ্রাস করতে সক্ষম হবে। লক্ষ্যমাত্রা হবে ক্লিকের সংখ্যা কমিয়ে এবং শ্রেণীকরণ ও লেবেলিংয়ের মাধ্যমে ডকুমেন্টেশনের সহজ সরফেসিংয়ের মাধ্যমে আরও ভালো ব্যবহারকারীর অভিজ্ঞতা। ব্যবহারকারী/অপারেশন/প্রশাসক কর্মীদের দৃষ্টিকোণ থেকে যা কিছু জানার আছে তা 3 বা তার কম ক্লিকের মধ্যে পাওয়া যাবে।
মক-আপ লিঙ্ক: https://drive.google.com/file/d/1vSYgOkB9s9eEr2soNs7ujMLHzDlKn_hr/view?usp=sharing)
প্রকল্পের লক্ষ্য: - বিভিন্ন উত্স থেকে পাওয়া অপ্রয়োজনীয় তথ্য বিশ্লেষণ এবং ছাঁটাই। অর্থাৎ প্রতিটি তথ্যের একটি সত্যের উৎস থাকতে হবে। - বিদ্যমান ডকুমেন্টেশনকে বিভিন্ন অংশে লেবেল ও শ্রেণীবদ্ধ করে পুনর্গঠন করুন - পুনর্গঠিত ডকুমেন্টেশনকে mkdocs-এর উপর ভিত্তি করে একটি কেন্দ্রীভূত ভিউতে স্থানান্তর করুন - ফাইল ফর্ম্যাট সীমাবদ্ধতার কারণে স্থানান্তরিত করা যাবে না এমন রিফরম্যাট/আমদানি ডকুমেন্টেশন - কোনো অনুপস্থিত নিশ্চিত করতে ডকুমেন্টেশনের কমিউনিটি চালিত পরিবর্তন সেট আপ করুন শূন্যস্থান পূরণ করা হয় - সংযোগের ক্ষেত্রে, তথ্যের আপডেট বা ত্রুটি সংশোধনের ক্ষেত্রে।
এই সিস্টেমের জন্য বেয়ারবোনগুলি ইতিমধ্যেই রয়েছে, তবে, আমার মডেলটি যথাযথ ডকুমেন্টেশন সহ অবদান ও শাসনের জন্য সঠিক নির্দেশিকা স্থাপন করে বিদ্যমান সিস্টেমে উন্নতি করবে। তদ্ব্যতীত, আমি ট্র্যাকিং সমস্যা এবং প্রকল্পের সামগ্রিক স্বাস্থ্যের জন্য গিটহাব প্রকল্প বোর্ডগুলিকে অন্তর্ভুক্ত করার কল্পনা করি।
টাইমলাইন: - 16 ই আগস্টের আগে --> ডকুমেন্টেশন এবং রুসিওর বর্তমান সংস্করণগুলির সাথে নিজেকে পরিচিত করুন --> নতুন কৌশল এবং প্রযুক্তিগত লেখার দক্ষতা শিখুন যা প্রকল্পের মেয়াদে সহায়ক হবে --> ডকুমেন্টেশন সমস্যাগুলিতে অবদান রাখুন, যদি থাকে, রিপোর্ট করা হয়েছে গিটহাবে
সম্প্রদায়ের বন্ধন (আগস্ট 17 - সেপ্টেম্বর 13) --> সময় অঞ্চলের পার্থক্যের জন্য একটি যোগাযোগের চ্যানেল এবং সময় সেট আপ করুন (পুনে 3 ঘন্টা 30 মিনিট এগিয়ে আছে) --> লক্ষ্যগুলির পরিমার্জনের দিকে প্রধান ব্যথার পয়েন্টগুলি চিহ্নিত করতে হবে - -> কথোপকথনে জড়িত হয়ে সম্প্রদায়, সংস্থা এবং কাঠামো সম্পর্কে আরও জানুন৷ --> কার্যকরীতা এবং বাস্তবায়নের সম্ভাব্যতার জন্য পরামর্শদাতা এবং সংস্থার অন্যান্য মূল সদস্যদের সাথে প্রস্তাবিত ডকুমেন্টেশন কাঠামোর মূল্যায়ন। --> প্রস্তাবিত বৈশিষ্ট্যের চূড়ান্তকরণ এবং বিদ্যমান ডকুমেন্টেশনে করা প্রয়োজন হতে পারে এমন অন্য কোনো পরিবর্তন।
ডকুমেন্টেশন পিরিয়ড (14শে সেপ্টেম্বর - 30ই নভেম্বর) আমি এখানে প্রণয়নকৃত প্রস্তাবিত বিন্যাসের ভিত্তিতে, আমি ডকুমেন্টেশন সময়কালে যে প্রধান মাইলফলকগুলি অর্জন করার পরিকল্পনা করছি তার একটি ব্রেকডাউন প্রদান করেছি।
--> মাইলফলক #1: শ্রেণীকরণ এবং লেবেলিং ETC: 28th সেপ্টেম্বর, 2020 উপলব্ধ ডকুমেন্টেশনকে একীভূত করা এবং তাদের লেবেল করা পুনর্গঠন এবং ছাঁটাই প্রক্রিয়াটিকে ব্যাপকভাবে সহজ করবে।
--> মাইলস্টোন #2: বিশ্লেষণ, ছাঁটাই এবং পুনর্গঠন ETC: 19ই অক্টোবর, 2020 মাইলস্টোন #1 এর সময় শ্রেণীবদ্ধ করা ডকুমেন্টেশনগুলি ডুপ্লিকেট + তথ্যের অপ্রয়োজনীয় উত্সগুলির জন্য বিশ্লেষণ করা হবে। প্রকল্পের তথ্যে যেমন বলা হয়েছে, আমরা উপলব্ধ সমস্ত তথ্যের জন্য সত্যের একটি উৎসকে লক্ষ্য করছি।
--> মাইলফলক #3: কেন্দ্রীয়করণ এবং পুনর্বিন্যাস: ETC: 9th নভেম্বর, 2020 একবার ডকুমেন্টেশনটি সঠিকভাবে ছাঁটাই এবং পুনর্গঠন হয়ে গেলে, আমি প্রথমে এটিকে পুনরায় ফর্ম্যাট করার লক্ষ্য রাখব। বিভিন্ন উত্সের কারণে, বিন্যাসগুলি ভিন্ন এবং প্রথমে একটি উপযুক্ত বিন্যাসে রূপান্তরিত করা প্রয়োজন। একবার এটি সম্পন্ন হলে, কেন্দ্রীকরণ প্রক্রিয়া সহজ করা হবে।
--> মাইলফলক # 4: ট্র্যাকিং বোর্ড সেট আপ করা + গভর্নেন্স/অবদানের চারপাশে ডকুমেন্টেশন ETC: 23 নভেম্বর, 2020 এই ধাপটি নিশ্চিত করার জন্য যে প্রকল্পের সমাপ্তির পরে, ডকুমেন্টেশন আপডেট করা অব্যাহত থাকে। নির্দেশিকা প্রণয়ন এবং প্রকল্প বোর্ড স্থাপন প্রশাসনিক সদস্যদের উপর সম্প্রদায়ের অবদানের জন্য এবং কার্যকরভাবে ট্র্যাক করার জন্য বোঝা কমিয়ে দেবে।
--> প্রকল্প মূল্যায়ন (30শে নভেম্বর - 5ই ডিসেম্বর) একটি প্রকল্প প্রতিবেদন এবং আমার পরামর্শদাতাদের মূল্যায়ন জমা দিন ডক্সের সিজনে অংশগ্রহণকারী হিসাবে আমার অভিজ্ঞতার একটি প্রতিবেদন লিখুন এবং জমা দিন৷
কেন এই প্রকল্প? আমি বিশ্বাস করেছি যে ভাল-লিখিত এবং সংস্করণযুক্ত ডকুমেন্টেশন সহ সম্পূরক কোড আরও গ্রহণ এবং আরও ভাল ব্যবহার সক্ষম করার একমাত্র উপায়। ব্যক্তিগতভাবে, CERN যেভাবে পদার্থবিদ্যার বিভিন্ন ক্ষেত্রে অত্যাধুনিক গবেষণার পথপ্রদর্শক করেছে তাতে আমি মুগ্ধ হয়েছি। এই ধরনের পরীক্ষা-নিরীক্ষার সময় প্রক্রিয়াকৃত, স্থানান্তরিত এবং উত্পন্ন তথ্যের স্কেল দেওয়া, সংস্থার মধ্যে রেফারেন্স এবং ভবিষ্যতে ব্যবহারের জন্য ডেটা কীভাবে পরিচালনা করা হয় তা নিয়ে আমি সর্বদা কৌতূহলী ছিলাম। কিছু আশ্চর্যজনক বৈজ্ঞানিক গবেষণা এবং আবিষ্কারগুলিকে শক্তিশালী করছে এমন একটি কাঠামোর জন্য ডকুমেন্টেশনের উন্নতিতে অবদান রাখা একটি সম্মানের বিষয়।
কেন আমি এই প্রকল্পের জন্য সঠিক ব্যক্তি? পূর্বশর্তগুলি পূরণ করার পাশাপাশি, আমি নিশ্চিত যে আমি এই প্রকল্পের জন্য সঠিক ব্যক্তি হতে পারব:
আমি ইতিমধ্যে Kubernetes এর জন্য বিদ্যমান ডকুমেন্টেশন পরিবর্তন করার জন্য কাজ করছি। এই অবদানগুলির ফলে আমাকে 1.19 কুবারনেটস রিলিজ চক্রের জন্য একটি রিলিজ ডক্স শ্যাডো হিসাবে তালিকাভুক্ত করা হয়েছে যেখানে আমি রিলিজের সময় যুক্ত হওয়া নতুন বৈশিষ্ট্যগুলির জন্য ডকুমেন্টেশন কার্যকরভাবে রক্ষণাবেক্ষণ এবং আপগ্রেড করতে অবদান রাখি। আমি বিশ্বাস করি যে ভাল ডকুমেন্টেশন একটি মহান পণ্য/পরিষেবার জন্য মেরুদণ্ড। এটি পদ্ধতিগত বা প্রযুক্তিগত যাই হোক না কেন, তথ্য যা ভালভাবে লেখা, সংক্ষিপ্ত এবং সহজে অ্যাক্সেসযোগ্য তা গ্রহণকে চালনা করতে এবং আরও ভাল ব্যবহারে সহায়তা করতে একটি প্রেরণা হবে। আমার কর্মজীবন জুড়ে ডেটা-চালিত বিতরণ করা সিস্টেমগুলির সাথে কাজ করার পরে, আমি বিশ্বাস করি যে এই ধরনের সিস্টেমগুলির জন্য ডকুমেন্টেশনের ক্ষেত্রে প্রয়োজনীয়তার জটিলতাগুলি বোঝার জন্য আমি সবচেয়ে ভাল অবস্থানে আছি। আমি নিজে একজন শেষ ব্যবহারকারী হয়েছি, আমি খারাপভাবে লিখিত/ভুল ডকুমেন্টেশনের সমস্যাগুলির সাথে পরিচিত এবং পুনর্গঠনের সময় সেগুলি বিবেচনায় রাখার জন্য সতর্ক থাকব।