এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- gRPC-গেটওয়ে
- কৌশলী লেখক:
- iamrajiv
- প্রকল্পের নাম:
- জিআরপিসি-গেটওয়ের বিদ্যমান ডক্স সাইট রিফ্যাক্টরিং
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
বিমূর্ত:
ব্যবহারকারী ডক্স সাইটটি শেষ ব্যবহারকারীদের একটি পণ্য বা পরিষেবা ব্যবহার করতে সহায়তা করার জন্য ডিজাইন করা হয়েছে৷ ভাল ব্যবহারকারী ডক্স সাইটটি অত্যন্ত গুরুত্বপূর্ণ কারণ এটি ব্যবহারকারীদের সফ্টওয়্যার ব্যবহার করার উপায়, এর বৈশিষ্ট্য, টিপস, কৌশলগুলি এবং সফ্টওয়্যার ব্যবহার করার সময় যে সাধারণ সমস্যাগুলির সম্মুখীন হয় তা সমাধান করার উপায় প্রদান করে৷ এটি সমর্থন খরচও হ্রাস করে এবং পণ্যের কর্পোরেট পরিচয়ের অংশ। ভাল ব্যবহারকারী ডক্স সাইট পণ্য স্বাস্থ্যকর একটি চিহ্ন, ডেভেলপার দল. ভাল ব্যবহারকারী ডক্স সাইট ছাড়া, একজন ব্যবহারকারী কীভাবে কার্যকরভাবে এবং দক্ষতার সাথে উপরের জিনিসগুলি করতে হয় তা জানেন না। ব্যবহারকারীর ডক্স সাইট একটি পণ্যের সাফল্য নিশ্চিত করতে একটি গুরুত্বপূর্ণ ভূমিকা পালন করতে পারে কারণ দুর্দান্ত যোগাযোগ যে কোনও ব্যবসা বা পণ্যের কেন্দ্রে থাকে এবং সর্বদা থাকবে এবং দুর্দান্ত ডকুমেন্টেশন কেবল সেই যোগাযোগটিকে গ্রহণ করে এবং এটিকে একটি পরিচালনাযোগ্য কাঠামোতে রাখে যা প্রত্যেকে সাফল্যের জন্য অ্যাক্সেস করতে পারে।
এই লেখার সময়, জিআরপিসি-গেটওয়ে রিপোজিটরিটি আনুমানিক 1200 বার কাঁটা হয়েছে এবং 184 জন এই সংগ্রহস্থলে অবদান রেখেছেন যা দেখায় যে সারা বিশ্বে প্রচুর মানুষ জিআরপিসি-গেটওয়ে ব্যবহার করে এবং এর ব্যবহারকারী পড়তে চায় কিভাবে gRPC-গেটওয়ে ব্যবহার করতে হয় তার নির্দেশনার জন্য ডকুমেন্টেশন। যাইহোক, gRPC-Gateway ব্যবহারকারীর ডকুমেন্টেশন এবং ডক্স সাইটটি বর্তমানে পুরানো এবং অসম্পূর্ণ এবং gRPC-গেটওয়ে সম্প্রদায় এই প্রকল্পটি ব্যবহার করতে চায় বিদ্যমান ডক্স সাইটটিকে রিফ্যাক্ট করার জন্য তার ডক্স সাইটটিকে উন্নত করার জন্য শেষ-ব্যবহারকারীরা ব্যবহার করার সময় একটি বিরামহীন অভিজ্ঞতা পেতে সক্ষম করতে gRPC-গেটওয়ে।
বর্তমান অবস্থা:
বর্তমানে, gRPC-গেটওয়ে ডক্স সাইটের দুটি প্রধান সমস্যা রয়েছে:-
• প্রথম সমস্যাটি হল খারাপ এবং পুরানো ডক্স ওয়েবসাইট যা সাইটের স্টাইলিং এবং কাঠামো এবং ব্যবহৃত থিমটি অপ্রচলিত, অসম্পূর্ণ, নেভিগেট করা বা তথ্য খুঁজে পাওয়া কঠিন, ভাল ডক্স ওয়েবসাইটের অনেক বৈশিষ্ট্য কভার করে না। gRPC-Gateway-এর বিদ্যমান ডক্স সাইটের রিফ্যাক্টরিং এর মধ্যে থাকবে ওয়েবসাইটের স্টাইলিং, ডকুমেন্ট সার্চ ইত্যাদির মতো বৈশিষ্ট্য যোগ করা, ওয়েবসাইটের UI উন্নত করা, সঠিক সাইডবারে টিউটোরিয়াল এবং উদাহরণ সংগঠিত করা এবং একটি নতুন ডিজাইন করে বিদ্যমান ফ্লোচার্ট ও ছবি আপডেট করা ইত্যাদি এটি আমার প্রাথমিক লক্ষ্য হবে এবং আমার কাজটি বিদ্যমান ডক্স সাইটের স্টাইলিং এবং পুনর্গঠনের উপর ভিত্তি করে আরও বেশি হবে৷
• দ্বিতীয় সমস্যা, জিআরপিসি-গেটওয়ের বিদ্যমান ডকুমেন্টেশন, টিউটোরিয়াল এবং উদাহরণ ইত্যাদি রিফ্যাক্টর করার প্রয়োজন রয়েছে যা ফাইল জুড়ে টাইপোগ্রাফিক্যাল এবং ব্যাকরণগত ভুলগুলি সরিয়ে, গো স্নিপেটগুলির সঠিক প্রান্তিককরণ এবং Gofmt অনুযায়ী Go স্নিপেটগুলিকে রিফ্যাক্টর করার মাধ্যমে করা যেতে পারে। বিন্যাস এছাড়াও, যদি তাই হয় আমরা প্রয়োজনে আরও ডকুমেন্টেশন, টিউটোরিয়াল এবং উদাহরণ যোগ করতে পারি বা আমরা এটিকে রিফ্যাক্টর করার পরে বিদ্যমান ফাইলগুলি পুনরায় ব্যবহার করতে পারি। এটি আমার গৌণ লক্ষ্য এবং আমি আমার প্রাথমিক লক্ষ্য অর্থাৎ বিদ্যমান ডক্স সাইটের স্টাইলিং এবং পুনর্গঠন সম্পূর্ণ করার পরে এটি করব৷
আমার প্রস্তাবিত ডকস সাইটটি বর্তমানের চেয়ে উন্নতি কেন?
প্রস্তাবিত ব্যবহারকারীর ডক্স ওয়েবসাইটটি একটি শেষ-ব্যবহারকারীর জন্য দক্ষতা, ধারাবাহিকতা এবং মানসিক শান্তি উন্নত এবং নিশ্চিত করার জন্য কাঠামোগত হবে। এটি একটি ভাল চেহারা দেবে এবং ভাল-শৈলীকৃত বিভাগ এবং বৈশিষ্ট্য সহ লিখিত গাইড এবং এর সাথে সম্পর্কিত ফ্লোচার্ট এবং চিত্রগুলি সহ UI।
gRPC-গেটওয়ে ডকুমেন্টেশন পদ্ধতি এবং উদাহরণের একটি ভাল বিবরণ প্রদান করে। তবে এটি এখনও পুরানো জেকিল থিম ব্যবহার করছে এবং আধুনিক দিনে আমাদের কাছে আরও ভাল এসএসজি (স্ট্যাটিক সাইট জেনারেটর) জেকিল থিম রয়েছে। এছাড়াও, পৃষ্ঠাগুলির পুনর্গঠন এবং নতুন উদাহরণ এবং টিউটোরিয়াল যোগ করে এবং পূর্ববর্তী বিষয়বস্তুগুলিকে আপডেট ও পুনর্লিখন করে ব্যবহারকারীদের জন্য এটিকে আরও উপযোগী করে তোলার প্রয়োজন রয়েছে।
প্রস্তাবিত লক্ষ্য এবং ধারণাগুলির কাঠামো এবং রোডম্যাপ:
এই প্রকল্পের প্রাথমিক লক্ষ্য:-
উপরের লক্ষ্য এবং ধারণাগুলি নিম্নলিখিত উপায়ে বাস্তবায়ন করা যেতে পারে: -
বর্তমান জেকিল থিমকে আরও ভাল এবং শক্তিশালী থিমে স্থানান্তর করা হচ্ছে। জেকিল থিমগুলি আবার ব্যবহার করার কারণ হল যে রক্ষণাবেক্ষণকারীদের পক্ষে প্রকল্পের কার্যপ্রবাহে অবদান রাখা এবং বোঝা সহজ হবে কারণ তারা ইতিমধ্যে বিদ্যমান জেকিল ফ্রেমওয়ার্ক এবং থিম সম্পর্কে সচেতন যা নতুন জেকিল থিমের অনুরূপ।
ইন্টারনেট জুড়ে বিভিন্ন জেকিল থিমের মধ্য দিয়ে যাওয়ার পরে আমি নিম্নলিখিত বৈশিষ্ট্যের কারণে এই https://idratherbewriting.com/documentation-theme-jekyll/ থিম স্যুটটিকে gRPC-Gateway ডক্স সাইটের জন্য সেরা পেয়েছি:
• মার্কডাউন:- যাতে প্রযুক্তিগত লেখকদের ইনস্টলেশন নিয়ে চিন্তা করতে হবে না। তারা সহজভাবে .md ফাইলে লিখতে পারে। যে কেউ ওয়েবসাইটে প্রদর্শিত সম্পাদনা বোতামে ক্লিক করতে পারেন (নতুন বৈশিষ্ট্য) এবং এটিকে আরও ভাল করার জন্য অবদান রাখতে পারেন (গিটহাবের পৃষ্ঠাটির জন্য পরিবর্তন/সুপারিশ করতে পারেন)। এটি ব্যবহারকারীদের নতুন বিষয়বস্তু যোগ করতে বা এটিকে উন্নত করতে সামগ্রী সম্পাদনা করতে নিযুক্ত করবে৷
• ডকুমেন্টেশন অনুসন্ধান:- ব্যবহারকারীর একটি সার্চ বক্স থাকা উচিত যাতে তারা সহজে এবং দ্রুত প্রাসঙ্গিক বিষয়বস্তু খুঁজে বের করতে পারে।
• মন্তব্য বিভাগ:- ব্যবহারকারীর পোস্ট এবং টিউটোরিয়ালগুলিতে মন্তব্য করার এবং তাদের মতামত শেয়ার করার বিকল্প থাকতে পারে। তারা প্রকল্প ডকুমেন্টেশনের উপর অন্যান্য মানুষের মতামত পড়তে সক্ষম হতে পারে।
• নতুন রিলিজ নোট এবং ব্লগ:- ওয়েবসাইটটি নতুন ব্লগ পোস্ট এবং বর্তমান উন্নয়ন এবং রোডম্যাপ সম্পর্কে খবর সহ আপডেট করা উচিত। তাই ব্লগিং ধরনের ল্যান্ডিং পেজে উপস্থিত থাকা উচিত।
• দ্রুত বিকাশ:- বেশিরভাগ SSG (স্ট্যাটিক সাইট জেনারেটর) ফ্রেমওয়ার্ক সার্ভারে চলছে এবং ফাইলের পরিবর্তনগুলি UI-তে অবিলম্বে প্রতিফলিত হয়। এছাড়াও স্থাপন এবং নির্মাণ প্রক্রিয়া সহজ হওয়া উচিত. ভবিষ্যতে, যদি আমরা কাঠামো পরিবর্তন করতে চাই, আমরা ব্যবহার করি। তারপর এটা সহজ হতে হবে. বেশিরভাগ ফ্রেমওয়ার্ক মার্কডাউন লেখাকে সমর্থন করে তাই শুধু .md ফাইলগুলি সরানো এবং কিছু পরিবর্তন যথেষ্ট হওয়া উচিত।
এখানে আমি বিদ্যমান ওয়েবসাইট পৃষ্ঠাগুলিকে নতুন ওয়েবসাইট বিভাগ এবং পৃষ্ঠাগুলিতে বিভক্ত করছি:
• অবতরণ পাতা:-
ল্যান্ডিং পৃষ্ঠায় জিআরপিসি-গেটওয়ের প্রধান বৈশিষ্ট্যগুলি নির্দেশ করা উচিত।
- gRPC-গেটওয়ে দিয়ে শুরু করা (ব্যবহারকারী গাইডে পুনঃনির্দেশ)
- সহজ ইনস্টলেশন নির্দেশাবলী (সংক্ষিপ্ত আদেশ)
- কেন জিআরপিসি-গেটওয়ে ব্যবহার করুন
- জিআরপিসি-গেটওয়ে ব্যবহার করে প্রকল্প
তাই মৌলিক ধারণা হল দীর্ঘ বিবরণ লেখার পরিবর্তে, ল্যান্ডিং পেজে প্রধান পয়েন্টগুলি প্রদর্শন করুন এবং বিস্তারিত জানার জন্য লিঙ্ক প্রদান করুন।
• gRPC-গেটওয়ে ব্যবহারকারী গাইড পৃষ্ঠা:-
- ইনস্টলেশন গাইড.
- gRPC-গেটওয়ে দিয়ে দ্রুত শুরু করুন।
• gRPC-গেটওয়ে ডেভেলপার গাইড পৃষ্ঠা:-
ডেভেলপমেন্ট গাইড, কন্ট্রিবিউশন গাইড, গিট সেটআপ, কোড অফ কন্ডাক্ট, ডকুমেন্টেশন সেটআপ, ডেভেলপমেন্ট ওয়ার্কফ্লো ইত্যাদি অনুরূপ পৃষ্ঠাগুলির ভিতরে নির্দেশ করে। তাই সমস্ত ফাইল রিফ্যাক্টরিং এবং পুনর্বিন্যাস করা প্রয়োজন। প্রধান উন্নয়ন পৃষ্ঠায় এই সমস্ত পৃষ্ঠা থাকা উচিত এবং প্রতিটি ধাপে হাইপারলিঙ্ক তৈরি করা হবে।
• gRPC-গেটওয়ে পৃষ্ঠা সম্পর্কে:-
সমস্ত অবদানকারীদের তালিকা টিম বিভাগগুলিতে উপস্থিত থাকা উচিত দ্রুত লিঙ্ক এবং রিলিজ নোট, ব্যবহারকারীদের বর্তমান gRPC-Gateway খবরগুলি পড়তে তাদের জড়িত করার জন্য সাম্প্রতিক ব্লগগুলি যুক্ত করা হবে৷
• ব্লগ, রিলিজ নোট এবং টিউটোরিয়াল পৃষ্ঠা:-
আমি মনে করি যে ওয়েবসাইটে একটি ব্লগিং বিকল্প থাকা উচিত. তাই সংবাদ ও প্রকাশ সহজে যোগাযোগ করা যেতে পারে। টিউটোরিয়াল পৃষ্ঠায় কিছু জনপ্রিয় আলোচনা এবং নিবন্ধ থাকবে যা gRPC-Gateway API এবং ধারণাগুলিকে স্পষ্ট করে। অবদানকারীরা টিউটোরিয়াল পৃষ্ঠায় তাদের টিউটোরিয়াল লিঙ্ক যোগ করতে পারেন।
উপরের টাস্কটি সম্পূর্ণ করার পরে v2 শাখায় একই পরিবর্তনগুলি আপডেট করুন এবং এমনকি জিআরপিসি-গেটওয়ের মাস্টার শাখার সাথেও তৈরি করুন।
এই প্রকল্পের দ্বিতীয় লক্ষ্য:-
জিআরপিসি-গেটওয়ে ডকুমেন্টেশনকে আরও শক্তিশালী এবং পাঠযোগ্য করার জন্য অন্যান্য পরিবর্তনগুলি করা দরকার:-
• ব্যাকরণগত, টাইপোগ্রাফিক ত্রুটিগুলি ঠিক করা এবং gRPC-গেটওয়ের সমস্ত বিদ্যমান ফাইল জুড়ে সাইটে লিঙ্ক এবং পোস্টগুলি সংগঠিত করা এবং সারিবদ্ধ করা।
• gRPC-গেটওয়েতে প্রয়োজন হলে আরও ডকুমেন্টেশন এবং বিষয়বস্তু যোগ করা কারণ বেশিরভাগ বৈশিষ্ট্যের খুব ছোট ডকুমেন্টেশন রয়েছে যেমন AWS, ব্যাকগ্রাউন্ড এবং ব্যবহার ইত্যাদিতে সাইটের ডকুমেন্টেশন বিভাগে।
• Refactoring Go স্নিপেট GRPC-Gateway Gofmt ফর্ম্যাট অনুযায়ী
উপরের টাস্কটি সম্পূর্ণ করার পরে v2 শাখায় একই পরিবর্তনগুলি আপডেট করুন এবং এমনকি জিআরপিসি-গেটওয়ের মাস্টার শাখার সাথেও তৈরি করুন।
আমি কেন এই প্রকল্পের জন্য সঠিক ব্যক্তি:
আমি বিশ্বাস করি আমি এই প্রকল্পের জন্য সঠিক ব্যক্তি কারণ: -
• প্রতিষ্ঠানের ডকুমেন্টেশন উন্নত করার ক্ষেত্রে আমার অতীত অভিজ্ঞতা আছে এবং আমি যেকোন সংস্করণ নিয়ন্ত্রণ ব্যবস্থা ব্যবহার করতে পারি, তাই GitHub-এ কমান্ড চালাতে কোনো সমস্যা হবে না। • তাছাড়া, যা আমাকে চালিত করে তা হল এমন প্রকল্পগুলিতে কাজ করা যা মানুষের জন্য মূল্য তৈরি করে। আমি বিশ্বাস করি যে আপনি যদি কাউকে সবচেয়ে কার্যকর উপায়ে কিছু করতে চান তবে আপনি এটি নথিভুক্ত করুন। আপনার প্রক্রিয়াগুলি নথিভুক্ত করার মাধ্যমে, আপনি জড়িত যে কারও জন্য দক্ষতা, ধারাবাহিকতা এবং মানসিক শান্তি নিশ্চিত করেন। • আমি gRPC-Gateway-এর কর্মপ্রবাহ এবং কোডবেসের সাথে পরিচিত কারণ আমি গত দুই মাস থেকে gRPC-গেটওয়েতে অবদান রাখছি এবং 11 PR মার্জ করেছি।