এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- ক্লাউড নেটিভ কম্পিউটিং ফাউন্ডেশন (CNCF)
- কৌশলী লেখক:
- অপরাধী
- প্রকল্পের নাম:
- Kubernetes ওয়েবসাইট কিভাবে API রেফারেন্স পরিবেশন করে তা আপডেট করুন
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
বর্তমানে, কুবারনেটস এপিআই রেফারেন্সগুলি হল বড় HTML ডকুমেন্ট যা ওয়েবসাইট রিপোজিটরির বাইরে হোস্ট করা স্ক্রিপ্ট দ্বারা সোয়াগার স্পেক্স থেকে তৈরি করা হয়, তারপর এই ওয়েবসাইট রিপোজিটরিতে যোগ করা হয়।
অন্য দিকে, কুবারনেটস ডকুমেন্টেশন ওয়েবসাইটটি ডকসি হুগো থিম ব্যবহার করে ওয়েবসাইট রিপোজিটরিতে মার্কডাউন ফর্ম্যাটে লেখা ডকুমেন্টেশন থেকে Hugo দিয়ে তৈরি করা হয়েছে।
এই প্রকল্পের লক্ষ্য হল কুবারনেটস এপিআই রেফারেন্সের প্রজন্মকে সেই প্রক্রিয়ার সাথে একীভূত করা যা ডকুমেন্টেশন ওয়েবসাইট তৈরি করে।
বিশেষভাবে, আমরা ডকসি হুগো থিম দ্বারা সরবরাহিত swaggerui শর্টকোড , swagger-ui এর চারপাশে মোড়ক এবং নির্দিষ্ট টুলিং-এ ফোকাস করব, কুবারনেটস ডকুমেন্টেশনের প্রবাহে API স্পেসিফিকেশনের অংশগুলি সন্নিবেশ করতে সক্ষম করে৷
নির্দিষ্ট টুলিংয়ের প্রয়োজন হবে কারণ swagger-ui একটি swagger ফাইলে বর্ণিত সম্পূর্ণ স্পেসিফিকেশন আউটপুট করতে সক্ষম, কিন্তু এর কিছু অংশ নয় (8 দেখুন) । Kubernetes API শুধুমাত্র একটি অংশে প্রদর্শন করার জন্য খুব বড় (আউটপুটের একটি উদাহরণ) । আমরা দুটি পন্থা বিবেচনা করব:
প্রথম পন্থা হল (10) এ উপলব্ধ উৎস থেকে প্রতিটি কুবারনেটস API গ্রুপের জন্য একটি (core/v1, apps/v1, ...) বেশ কয়েকটি সোয়াগার ফাইল তৈরি করা এবং এই ফাইলগুলিকে কুবারনেটসের নির্দিষ্ট স্থানে swaggerui সর্টকোডের ইনপুট হিসাবে ব্যবহার করা। ডকুমেন্টেশন ওয়েবসাইট,
দ্বিতীয় পন্থা হল এমন একটি টুল তৈরি করা যা (11) এ পাওয়া Kubernetes API-এর সম্পূর্ণ সোয়াগার ফাইলটি ইনপুট হিসাবে পায় এবং একটি নির্দিষ্ট এন্ডপয়েন্ট বা সীমিত সংখ্যক এন্ডপয়েন্টের জন্য একটি নতুন সোয়াগার ফাইল আউটপুট করে এবং এর সাথে সম্পর্কিত সংস্থান এবং সংজ্ঞাগুলি ব্যবহার করে। কুবারনেটস ডকুমেন্টেশন ওয়েবসাইটের নির্দিষ্ট জায়গায় swaggerui শর্টকোডের ইনপুট হিসাবে এই swagger ফাইলগুলি।
যেহেতু স্পেসিফিকেশনের উত্সগুলি (10 এবং 11) ডকুমেন্টেশনের উত্সগুলির চেয়ে অন্যান্য সংগ্রহস্থলে থাকে, সেগুলি পরিবর্তন করার সময় আমাদের ডকুমেন্টেশন রিপোজিটরিতে স্বয়ংক্রিয়ভাবে আপডেট করার একটি উপায় খুঁজে বের করতে হবে৷
যেহেতু Kubernetes ডকুমেন্টেশন বিভিন্ন ভাষায় উপলব্ধ, আমরা Kubernetes API রেফারেন্সের জন্য অনুবাদ প্রকাশ করার সম্ভাবনার দিকে বিশেষ মনোযোগ দেব।