এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- ক্লাউড নেটিভ কম্পিউটিং ফাউন্ডেশন (CNCF)
- কৌশলী লেখক:
- শ্রীতি
- প্রকল্পের নাম:
- এসএমআই এবং সম্পর্কিত পরিষেবা মেশের ডকুমেন্টেশন উন্নত করুন
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
সার্ভিস মেশ টেকনোলজি মূলত আপনার সমস্ত নিরাপত্তা, ব্যবস্থাপনা এবং নিরীক্ষণের প্রয়োজনীয়তাগুলি পরিচালনা করার মাধ্যমে ক্রমবর্ধমান পরিষেবার মূল্য প্রদানের লক্ষ্যে। সার্ভিস মেশ ইন্টারফেস (এসএমআই) সর্বাধিক সাধারণ পরিষেবা জাল ব্যবহারের ক্ষেত্রে (ট্রাফিক নীতি, টেলিমেট্রি এবং স্থানান্তর) এর জন্য API-এর একটি সেট সংজ্ঞায়িত করে এবং পরিষেবা মেশগুলির মধ্যে সামঞ্জস্যতা সক্ষম করে, যেগুলি পরিষেবা থেকে পরিষেবা যোগাযোগ পরিচালনার জন্য নিবেদিত অবকাঠামো স্তর। মাইক্রো সার্ভিস পরিবেশ। এই ইন্টারফেসগুলির প্রমিতকরণ একটি বর্ধিত শেষ-ব্যবহারকারীর অভিজ্ঞতা প্রদান করবে এবং এইভাবে, এসএমআই এবং সম্পর্কিত পরিষেবা মেশের জন্য একটি ভবিষ্যত লক্ষ্য।
বর্তমান অবস্থা:
ব্যবহারকারীর নির্দেশিকা: SMI হল একটি অপেক্ষাকৃত নতুন স্যান্ডবক্স প্রকল্প, এপ্রিল, 2020-এ CNCF-কে দান করা হয়েছে৷ ফলস্বরূপ, প্রকল্পটিতে শেষ-ব্যবহারকারীর ডকুমেন্টেশনের অভাব রয়েছে৷ মেশেরি হল একটি সার্ভিস ম্যানেজমেন্ট প্লেন যা বিভিন্ন পরিষেবা মেশের কার্যকারিতা গ্রহণ, কনফিগারেশন, অপারেশন এবং পরিচালনার সুবিধার্থে সমস্ত ধরণের পরিষেবাগুলির জন্য পারফরম্যান্স বেঞ্চমার্কিং সহ এবং যে কোনও পরিষেবা জালের উপরে চলমান অ্যাপ্লিকেশনগুলি থেকে মেট্রিক্স সংগ্রহ এবং প্রদর্শনকে অন্তর্ভুক্ত করে। এইভাবে, আমি Meshery-এর জন্য একটি নির্দেশিকা দিয়ে শুরু করতে চাই, যা সমগ্র SMI ব্যবহারকারী সম্প্রদায়ের জন্য একটি সূচনা বিন্দু হিসেবে কাজ করবে।
ব্যবহারকারীর টিউটোরিয়াল: বিদ্যমান SMI প্ল্যাটফর্মগুলির মধ্যে: নমুনা অ্যাপ্লিকেশন, Learn Layer5, বর্তমানে SMI-এর জন্য একটি শিক্ষার যন্ত্র হিসেবে কাজ করে এবং SMI স্পেসিফিকেশন যাচাইকরণের জন্য নমুনা অ্যাপ্লিকেশন হিসেবে কাজ করে৷ কিন্তু অন্যথায়, SMI প্রকল্পগুলির সম্পূর্ণরূপে শেষ-ব্যবহারকারীর টিউটোরিয়ালের অভাব রয়েছে, যা প্রকল্পগুলির উচ্চ প্রযুক্তিগত প্রকৃতির কারণে এটি একটি গুরুতর বাধা। SMI এবং সম্পর্কিত পরিষেবা মেশের সুবিধা এবং ব্যবহার প্রদর্শনের জন্য Meshery হল নিখুঁত অ্যাপ্লিকেশন, তাই আমি SMI-এর বৈশিষ্ট্যগুলি প্রদর্শন করার জন্য এটিকে বেস টুল হিসাবে ব্যবহার করব।
API ডকুমেন্টেশন: এই মুহূর্তে অস্তিত্বহীন। এসএমআই এবং বিভিন্ন সম্পর্কিত প্রকল্পগুলির একটি প্ল্যাটফর্মে তাদের API শেষ পয়েন্টগুলি সংজ্ঞায়িত করা হয়েছে; একটি উদাহরণ হিসাবে, মেশেরির শেষ পয়েন্টগুলি server.go (https://github.com/layer5io/meshery/blob/master/router/server.go) এ সংজ্ঞায়িত করা হয়েছে, তবে সেগুলি বাহ্যিকভাবে ভালভাবে মন্তব্য করা বা নথিভুক্ত করা হয়নি। এটি API এর অর্থপূর্ণ ডকুমেন্টেশনের মাধ্যমে সমাধান করা যেতে পারে এবং ব্যবহারকারীদের জন্য এর শেষ পয়েন্টগুলি পরীক্ষা করার এবং এর বৈশিষ্ট্যগুলির পূর্বরূপ দেখার উপায় যুক্ত করে উন্নত করা যেতে পারে।
বিশ্লেষণ:
ব্যবহারকারীর টিউটোরিয়াল তৈরি করা হয়েছে যাতে ব্যবহারকারী জড়িত থাকতে পারে এবং সফ্টওয়্যারটির পরীক্ষা-নিরীক্ষা করতে পারে। ব্যবহারকারীর মনোযোগ ধরে রাখতে তাদের ইন্টারেক্টিভ এবং নান্দনিকভাবে আকর্ষণীয় হতে হবে এবং সবচেয়ে গুরুত্বপূর্ণভাবে ব্যবহার করা সহজ।
যাইহোক, ব্যবহারকারীর নির্দেশিকা লেখা বা হোস্ট করার জন্য, একটি আরও পরিপক্ক বিন্যাস বাঞ্ছনীয় হবে কারণ ব্যবহারকারীর নির্দেশিকাগুলি প্রায়শই একটি রেফারেন্স গাইড বা সমস্যাগুলির দ্রুত সমাধান করার জায়গা হিসাবে কাজ করে৷ ইন্টারেক্টিভ হওয়ার পরিবর্তে, তাদের সুগঠিত হতে হবে এবং স্পষ্টতা, সুসংগততা এবং ভাল ব্যবহারকারী প্রবাহের উন্নতিতে ফোকাস করতে হবে।
এর একটি সম্ভাব্য সমাধান হল Google কোডল্যাব ব্যবহার করে আলাদা ইউজার টিউটোরিয়াল তৈরি করা এবং জেকিলের সাহায্যে একটি স্বাধীন ব্যবহারকারী গাইড তৈরি করা এবং শেষ পর্যন্ত ব্যবহারকারী এবং ভবিষ্যত সহযোগীদের উভয়কে একটি সুসংহত অভিজ্ঞতা দেওয়ার জন্য API ডকুমেন্টেশনের সাথে একীভূত করা। .
লক্ষ্য শ্রোতা: এসএমআই প্রকল্পগুলি তাদের অধীনস্থ সমস্ত প্রকল্পগুলিতে স্থাপনা এবং অপারেশনাল অনুশীলন, শেখার পরিবেশ এবং কর্মক্ষমতা বেঞ্চমার্ক প্রদান করে। এটি ব্যক্তি এবং সংস্থা উভয়কেই পূরণ করে।
ব্যবহারকারীর নির্দেশিকা: আমি প্রাথমিক ব্যবহারকারীদের টার্গেট করব, ব্যবহারকারীর প্রান্তে প্রাক-বিদ্যমান আইটি জ্ঞানের কোনো অনুমান ছাড়াই। লক্ষ্য: শিক্ষানবিস ব্যবহারকারীর কারণ: প্রধানত একটি বিশাল রেফারেন্স গাইড হিসাবে ব্যবহৃত হয়, যা সময়ের সাথে আপডেট করা প্রয়োজন। ব্যবহারকারীর কাছে একটি পরিষেবা জাল সেট আপ করতে এবং কাজ করার জন্য প্রয়োজনীয় সমস্ত তথ্য রয়েছে তা নিশ্চিত করতে এতে গভীরভাবে ব্যাখ্যা এবং সহায়ক টিপস অন্তর্ভুক্ত থাকবে। যেখানে প্রয়োজন সেখানে ভিডিও, ছবি, স্ক্রিনশট এবং GIF যোগ করে গাইডটিকে আরও আকর্ষক এবং ব্যবহারকারী বান্ধব করা হবে।
ব্যবহারকারীর টিউটোরিয়াল: লক্ষ্য: শিক্ষানবিস ব্যবহারকারীর কারণ: ব্যবহারকারীর মনোযোগ ধরে রাখতে এবং সফ্টওয়্যারটির একটি মসৃণ পরীক্ষা চালানোর অনুমতি দেওয়ার জন্য টিউটোরিয়ালগুলিকে আকর্ষক এবং নান্দনিকভাবে আকর্ষণীয় করে তোলার উপর ফোকাস থাকবে, যা পরিষেবা মেশ ইন্টারফেসের আরও ভাল বোঝার দিকে নিয়ে যাবে।
এপিআই এন্ডপয়েন্ট ডকুমেন্টেশন: টার্গেট: অ্যাডভান্সড ইউজারস রিজন: এই বিভাগটি সার্ভিস মেশের আরও জটিল বৈশিষ্ট্য ব্যবহার করার উপর ফোকাস করে, যা আইটি জ্ঞানের মৌলিক স্তরের সাথে উন্নত ব্যবহারকারীদের স্বার্থে বেশি। উন্নত ব্যবহারকারীরা সংক্ষিপ্ত টিউটোরিয়ালের সন্ধান করবে যা প্রয়োজনে রেফারেন্স গাইড হিসাবেও ব্যবহার করা যেতে পারে। এন্ডপয়েন্ট ডকুমেন্টেশন এমনভাবে লিখতে হবে, যাতে এর সঠিকতা বা ধারাবাহিকতার সাথে আপস না করে আপডেট করা সহজ হয়। এটি একটি স্বয়ংক্রিয় প্রক্রিয়া হওয়া উচিত।
সম্পদ: ব্যবহারকারীর টিউটোরিয়াল: গুগল ডেভেলপারস কোডল্যাব - ইন্টারেক্টিভ এবং ব্যাপক শেষ-ব্যবহারকারীর টিউটোরিয়াল তৈরি করতে ব্যবহৃত হয়। সুবিধা: - স্যান্ডবক্স টিউটোরিয়াল তৈরি করতে পারে। - একটি হ্যান্ড-অন পদ্ধতি আছে. - Google ডক্স ব্যবহার করে লেখা এবং মার্কডাউন টেক্সট সমর্থন করে। - Google Analytics ব্যবহার করে নিরীক্ষণ করা যেতে পারে - ব্যবহারকারীর ট্র্যাফিক পর্যবেক্ষণ করা সহজ। - ব্যবহার করা সহজ. নান্দনিকভাবে আনন্দদায়ক টিউটোরিয়াল তৈরি করে যা ব্যবহারকারীকে সরাসরি কোনো বিনিয়োগ ছাড়াই সফ্টওয়্যারের সাথে জড়িত হতে দেয়।
CLaaT (কোডেল্যাবস অ্যাজ এ থিং) প্রকল্প ব্যবহার করে Google কোডল্যাবগুলিকে উন্নত এবং সহজেই স্থাপন করা যেতে পারে - এটি এমন একটি প্রোগ্রাম যা মার্কডাউন ব্যবহার করে Google ডকে লেখা টিউটোরিয়ালগুলিকে কোডল্যাব (HTML) ফর্ম্যাটে রূপান্তর করতে ব্যবহৃত কমান্ড-লাইন টুল অফার করে৷
ব্যবহারকারীর নির্দেশিকা: জেকিল - meshery.io-এর বিদ্যমান ডকুমেন্টেশন, যা এখানে পাওয়া যাবে জেকিলে হোস্ট করা হয়েছে এবং ডকসি জেকিল থিম ব্যবহার করে। এটি মার্কডাউন, লিকুইড, এইচটিএমএল এবং সিএসএস ব্যবহার করে হোস্ট করার জন্য প্রস্তুত, স্ট্যাটিক ওয়েবসাইট তৈরি করে এবং রুবি ডেভেলপমেন্ট এনভায়রনমেন্টে চলে। সুবিধা: - GitHub সংগ্রহস্থল থেকে সরাসরি সাইট হোস্ট করতে পারেন। - এটি একটি খুব সক্রিয় সম্প্রদায়ের সাথে একটি ভাল সমর্থিত প্রকল্প - অন্য প্ল্যাটফর্মে স্থানান্তরিত করার বিষয়ে মাথা ঘামানোর ছাড়াই ব্যবহারকারীর নির্দেশিকা এবং বর্ধনগুলি বিদ্যমান SMI এবং Meshery ডকুমেন্টেশনে যোগ করা যেতে পারে।
API ডকুমেন্টেশন: SMI এবং Meshery-এর জন্য API ডকুমেন্টেশন তৈরি করতে Swagger (বিকল্পভাবে, Swaggo) ব্যবহার করা হবে। এটি API নথি লেখার জন্য একটি মার্জিত সমাধান। সুবিধা: - আপনার API ডিজাইন থেকে ডকুমেন্টেশন: আপনার API বিকশিত হওয়ার সাথে সাথে আপনার ডকুমেন্টেশন আপ-টু-ডেট থাকে তা নিশ্চিত করে। - আপনার API ডিজাইন থেকে ডকুমেন্টেশন: API সংজ্ঞা থেকে স্বয়ংক্রিয়ভাবে তৈরি করা যেতে পারে। - একাধিক ডকুমেন্টেশন সংস্করণ বজায় রাখুন - কাস্টমাইজড API ডিজাইন
প্রকল্পের লক্ষ্য: - একটি টুল হিসাবে Meshery ব্যবহার করে SMI এবং সম্পর্কিত পরিষেবা মেশের জন্য ইন্টারেক্টিভ এন্ড-ইউজার টিউটোরিয়াল তৈরি করতে Google ডেভেলপার কোডল্যাব ব্যবহার করুন। - পরিষেবা মেশের জন্য জেকিল ব্যবহার করে একটি শেষ-ব্যবহারকারীর গাইড তৈরি করুন। - SMI এর জন্য API এন্ডপয়েন্ট ডকুমেন্টেশন তৈরি করতে Swagger ব্যবহার করুন। - প্রকল্প সম্প্রদায়কে চালিত করুন যাতে ভবিষ্যতে এবং বর্তমান ব্যবহারকারী বা বিকাশকারীরা সহজেই SMI সম্প্রদায়ের নির্দেশনা এবং সংযমের অধীনে এটিতে যোগ করা চালিয়ে যেতে পারে।
টাইমলাইন: প্রস্তাবিত টাইমলাইনটি এখানে পাওয়া যাবে: https://docs.google.com/document/d/1If2mtBdWZer4qrh66NfXOWBx_3-tiA09jnoPMqy2lqs/edit#bookmark=kix.j1b6m64eubsl
কাঠামো: ব্যবহারকারী গাইডের জন্য প্রস্তাবিত কাঠামো এখানে পাওয়া যাবে: https://docs.google.com/document/d/1A3YYAMUTe06MojNWo8hdF4KZbvr-qVaaA2myzWeshHQ/edit?usp=sharing
কেন এই প্রকল্প? পরিষেবা জাল সম্প্রদায় একটি বিদ্যুত দ্রুত গতিতে প্রসারিত হচ্ছে, এটি CNCF-তে একটি স্যান্ডবক্স প্রকল্প হিসাবে সাম্প্রতিক একীকরণের দ্বারা সক্ষম হয়েছে৷ যাইহোক, প্রকল্পটি শেষ-ব্যবহারকারী এবং বিকাশকারীদের উভয়ের জন্য ডকুমেন্টেশনের গুরুতর অভাবের সাক্ষী। আমি অতীতে ইমোজিভোটো অ্যাপের সাথে লিঙ্কারডি, বুকইনফো অ্যাপ্লিকেশন সহ ইস্টিও এবং হ্যাশিকর্পের কনসাল সহ বিভিন্ন পরিষেবা মেশের সাথে খেলা করেছি। আমি SMI ট্র্যাফিক বিভাজন চেষ্টা করেছি এবং আমার পরিষেবা জাল কনফিগারেশনে বিভিন্ন বৈধতা নিয়ম প্রয়োগ করেছি। শেখার প্রক্রিয়াটি চিত্তাকর্ষক কিন্তু অত্যন্ত প্রযুক্তিগত এবং নতুন ব্যবহারকারীদের পাশাপাশি ডেভেলপারদের জন্য, পরিষেবা মেশ সম্প্রদায়ে তাদের প্রথম পদক্ষেপ নিতে বা তাদের নিজস্ব ব্যক্তিগত বা পেশাদার প্রকল্পের জন্য পরিষেবা মেশ ব্যবহার করার জন্য এটি একটি বন্ধ হতে পারে। আমি এই ব্যবধানটি পূরণ করতে চাই, যা শুধুমাত্র দক্ষ এবং ভাল নথিভুক্ত গাইড এবং টিউটোরিয়াল দিয়ে করা যেতে পারে।