این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- بنیاد محاسبات بومی ابری (CNCF)
- نویسنده فنی:
- سیام ساندار ک
- نام پروژه:
- نمونه های بیشتر و بهتر Kubectl
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
انگیزه این پروژه ارتقای برگه تقلب و اسناد مرجع kubectl موجود است.
اینها اهداف نهایی این پروژه هستند: • ایجاد نمونه های بیشتر و بهتر کوبکتل. • نمونه های kubectl را به برگه تقلب kubectl اضافه کنید. • Refactor kubectl docs برای حداکثر سودمندی.
هدف I - نمونه هایی برای kubectl:
از نزدیک با گروه‌های ذینفع ویژه CLI کار خواهد کرد تا به زمینه، چه نوع نمونه‌هایی که کاربران کوبرنتس بیشتر از همه می‌خواهند و مستندسازی آن، دست یابد. این می تواند از بهبود دستورات kubectl موجود در برگه تقلب تا افزودن دستورات جدید به برگه تقلب متغیر باشد.
هدف دوم - افزایش سودمندی اسناد:
به منظور افزایش سودمندی اسناد، موارد زیر را می توان انجام داد:
• حذف مبارزات مبتدی • تنظیم مجدد دستور kubectl در یک نظم خاص برای اطمینان از تداوم در جریان منطقی
مبارزات مبتدی را از طریق توضیحات بهتر دستور/کاربر حذف کنید. این می تواند ساده به نظر برسد، اما می تواند به طور قابل توجهی بر مبتدیان تأثیر بگذارد تا یادگیری خود را ادامه دهند یا آن را رها کنند. به عنوان مثال، زمانی که با kubernetes از طریق kubectl شروع کردم، از تفاوت‌های بین pods و Deployment مطمئن نبودم. در ابتدا من یک سرویس باطن را که در nodejs نوشته شده بود مستقر کردم. بعد از چند ساعت می خواستم آن را پایین بیاورم، بنابراین سعی کردم غلاف را حذف کنم، اما به دلیل ماهیت خود ترمیمی غلاف ها دوباره ایجاد شدند. من به نوعی از آنچه در حال وقوع است گیج شده بودم و متعجب بودم که چرا دوباره ایجاد می شود و حذف نمی شود. پس از چند جستجو در وب، متوجه شدم که حذف پادها مانند حذف یک استقرار نیست. برای یک چشم آموزش دیده، این ممکن است ساده به نظر برسد، اما توضیح واضحی که این نوع ابهامات را برطرف می کند، چیزی است که یک مستند خوب را از یک سند عالی متمایز می کند.
تنظیم مجدد دستور kubectl به ترتیب خاصی برای اطمینان از تداوم در جریان منطقی. اگر شما فردی مثل من هستید که به داستان سرایی اعتقاد زیادی دارید، احتمالاً از خود می پرسید که چگونه می توانید عناصر داستان سرایی را در یک برگه سند که فهرستی از دستورات ترمینال دارد، بیاورید، من می گویم، می توان این کار را انجام داد. هر چیزی که یاد می گیریم همیشه یک جریان منطقی دارد - اگر بخواهید یک نقطه شروع و یک پایان. Kubectl به عنوان یک ابزار خط فرمان، بدیهی است که منحنی یادگیری دارد، در واقع منحنی یادگیری آن با منحنی یادگیری خود Kubernetes منطبق است. از آنجایی که تقریباً همه سفر خود را با kubernetes از طریق kubectl آغاز می کنند (به جز افرادی که از وب UI استفاده می کنند) و از آنجایی که منحنی یادگیری آن به شدت با منحنی یادگیری kubernetes همراه است، اسناد را می توان به میزان قابل توجهی با تغییر ترتیب این دستورات و دستورات بهبود بخشید. عناصر داستان سرایی را به آن معرفی می کند. به عنوان مثال، ویژگی هایی مانند مقیاس خودکار غلاف افقی را می توان پس از توضیح منابع با مثال ها و تصاویر دنیای واقعی توضیح داد.
هدف III - بهبود قابلیت استفاده از Docs:
مهاجرت اخیر وب سایت Kubernetes به Docsy Hugo بسیار عالی است و یک تغییر عظیم در دیدگاه اسناد است. اگرچه مهاجرت موفقیت آمیز بود، اما هنوز جا برای پیشرفت های زیادی در فضای اسناد وجود دارد.
در اینجا برخی از تغییراتی است که من پیشنهاد می کنم،
• پیمایش خودکار صفحه سمت چپ به بخش فعال فعلی در اسناد اصلی - این می تواند برای پیگیری بخش های فعلی، آینده و گذشته مفید باشد. • کپی در کلیپ بورد - برخی از دستورات ممکن است طولانی باشند، عملکرد کپی می تواند در حین کار با این نوع دستورات مفید باشد. • قالب بندی محتوای فایل های سند - پس از مهاجرت، محتوای چند صفحه به روش مناسبی فرمت نمی شود. به عنوان مثال: بخش نوع منبع در نمای کلی kubectl. این باعث کاهش تجربه کاربر می شود.
اینها تغییراتی است که می تواند تجربه کاربر را در وب سایت kubernetes افزایش دهد و همچنین می تواند بهره وری کاربر را افزایش دهد.