این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان متن باز:
- جنکینز ایکس
- نویسنده فنی:
- نیتین
- نام پروژه:
- بازسازی سایت Jenkins X Docs و Jenkins X Capabilities Matrix
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
هدف اصلی این پروژه بازسازی اسناد جنکینز X موجود در حین رفع مشکلات مربوط به اسناد و همچنین آماده سازی ماتریس به روز شده قابلیت های Jenkins X به همراه مستندات کاربر در مورد استفاده از Jenkins X در ارائه دهندگان ابر سازمانی است. علاوه بر این، این پروژه همچنین شامل کار بر روی توسعه زیرساخت محیط پیش نمایش Jenkins X بر اساس OpenShift با همکاری دانیل است.
به عنوان بخشی از بازسازی اسناد موجود جنکینز X، برخی از مسائلی که من روی آنها کار خواهم کرد، عبارتند از:
- بوت در منابع EKS: مسئله
- Vault در EKS با Boot: Issue شکست می خورد
- Document envars برای jx boot: Issue
- اسناد مورد نیاز برای راه اندازی Vault: مسئله
- ارتقاء بوت از محلی به طاق انجام نشد: مشکل
- بازخورد اسناد رابطه «ایجاد» در مقابل «نصب jx» در مقابل «بوت» در مقابل «وارد کردن»: مشکل
- مستندات هلم در همه جا وجود دارد: شماره
- بهبود اسناد که چرا ChartMuseum، Monocular و Docker Registry با Nexus Issue جایگزین نمی‌شوند
- تغییر رجیستری Docker هنگام استفاده از Boot + GKE: Issue ممکن نیست
- تغییر دامنه از nip.io به دامنه سفارشی انجام نشد: مشکل
برای ماتریس قابلیت‌های Jenkins X، کار شامل (همانطور که در زیر ذکر شد) برای خدمات Kubernetes سازمانی ارائه شده توسط هر یک از ارائه‌دهندگان Cloud مانند Google Cloud (GKE)، خدمات وب آمازون (AWS EKS) و Azure Cloud (AKS) است.
- نصب Jenkins X روی ابر از طریق اسکریپت های terraform و
jx boot - بررسی سازگاری نسخه‌های Kubernetes با Jenkins X در این سرویس‌های ارائه‌دهنده ابری kubernetes.
- هر قابلیت دیگری (ذخیره‌سازی مخفی برای اسرار، نسخه‌های کنترل منبع یا موارد دیگر) که باید با دین و اعضای انجمن جنکینز ایکس بحث شود.
با توجه به کار بر روی راه اندازی زیرساخت محیطی پیش نمایش Jenkins X بر اساس OpenShift، کار شامل موارد زیر است:
- طراحی سند در زیرساخت محیط پیش نمایش Jenkins X در پلتفرم OpenShift
- ایجاد خودکار محیط های پیش نمایش Jenkins X در OpenShift
- اسناد Jenkins X را در محیط های پیش نمایش به روز کنید
تحویل پروژه:
- با توجه به بازسازی اسناد جنکینز X موجود، مشکلات اسناد ذکر شده در بالا را از طریق روابط عمومی رفع می کند.
- به روز رسانی ماتریس قابلیت های Jenkins X همراه با مستندات کاربر در مورد استفاده از Jenkins X با ارائه دهندگان مختلف ابری (سرویس های Kubernetes عمدتاً AKS، EKS و GKE).
- راه اندازی خودکار زیرساخت محیط پیش نمایش Jenkins X بر اساس OpenShift، با همکاری دانیل.
جدول زمانی آزمایشی (همراه با وظایف) پیشنهاد شده:
پیوند جامعه (17 اوت - 13 سپتامبر)
- راه اندازی محیط توسعه برای اسناد فنی و همچنین دسترسی به زیرساخت های Cloud برای کار بر روی وظایف پروژه.
- بحث و گفتگو با مربیان پروژه در مورد جدول زمانی آزمایشی پیشنهادی، تحویل پروژه ها و همچنین وظایف (همراه با اولویت آنها).
- فرآیند کار سازمان، فرآیند بررسی روابط عمومی را درک کنید و به خوبی با آن تجهیز شوید و با جامعه درگیر شوید.
- وضعیت اسناد فعلی جنکینز X را مرور کنید.
هفته 1 (14 سپتامبر - 20 سپتامبر)
- دستورالعمل‌های راه‌اندازی Jenkins X در فضای ابری، وضعیت فعلی و اسناد را بدانید.
- بحث و گفتگو با Deane، در مورد قابلیت‌های فعلی Jenkins X (برای تأیید در ارائه‌دهندگان مختلف ابری).
- بحث با دانیل در مورد وضعیت فعلی زیرساخت محیط پیش نمایش Jenkins X بر اساس OpenShift.
- کار (با همکاری دانیل) برای طراحی معماری برای زیرساخت محیط پیش نمایش Jenkins X در OpenShift.
هفته 2 (21 سپتامبر - 27 سپتامبر)
- کار بر روی ماتریس قابلیت Jenkins X برای GKE cloud: نصب Jenkins X و تهیه پیش‌نویس یادداشت‌های کاربر.
- روی یکی از اسناد-موضوعات برای بهبود اسناد موجود جنکینز X کار کنید.
هفته 3 (28 سپتامبر - 4 اکتبر)
- کار بر روی ماتریس قابلیت Jenkins X برای GKE cloud: نصب Jenkins X و تهیه پیش‌نویس یادداشت‌های کاربر.
- روی یکی از اسناد-موضوعات برای بهبود اسناد موجود جنکینز X کار کنید.
- روی سند طراحی برای زیرساخت محیط پیش نمایش Jenkins X بر اساس OpenShift کار کنید.
هفته 4 (5 اکتبر - 11 اکتبر)
- اسناد کاربر را برای Jenkins X در GKE نهایی کنید.
- روی یکی از اسناد-موضوعات برای بهبود اسناد موجود جنکینز X کار کنید.
هفته 5 (12 اکتبر - 18 اکتبر)
- کار بر روی ماتریس قابلیت Jenkins X برای ابر Azure (AKS): نصب Jenkins X و تهیه پیش‌نویس یادداشت‌های کاربر.
- روی یکی از اسناد-موضوعات برای بهبود اسناد موجود جنکینز X کار کنید.
- پس از دریافت بازخورد از اعضای انجمن، سند طراحی زیرساخت محیط پیش نمایش Jenkins X را بر اساس OpenShift نهایی کنید.
هفته 6 (19 اکتبر - 25 اکتبر)
- کار بر روی ماتریس قابلیت Jenkins X برای ابر Azure (AKS): نصب Jenkins X و تهیه پیش‌نویس یادداشت‌های کاربر.
- روی یکی از اسناد-موضوعات برای بهبود اسناد موجود جنکینز X کار کنید.
هفته 7 (26 اکتبر - 1 نوامبر)
- کار بر روی ماتریس قابلیت Jenkins X برای ابر Azure (AKS): نصب Jenkins X و تهیه پیش‌نویس یادداشت‌های کاربر.
- روی یکی از اسناد-موضوعات برای بهبود اسناد موجود جنکینز X کار کنید.
- روی راه‌اندازی زیرساخت‌های محیطی پیش‌نمایش Jenkins X بر اساس OpenShift کار کنید.
هفته 8 (2 نوامبر - 8 نوامبر)
- اسناد کاربر را برای Jenkins X در AKS نهایی کنید.
- روی یکی از اسناد-موضوعات برای بهبود اسناد موجود جنکینز X کار کنید.
هفته 9 (9 نوامبر - 15 نوامبر)
- کار بر روی ماتریس قابلیت Jenkins X برای AWS (EKS): نصب Jenkins X و تهیه پیش‌نویس یادداشت‌های کاربر.
- روی یکی از اسناد-موضوعات برای بهبود اسناد موجود جنکینز X کار کنید.
- روی راه‌اندازی زیرساخت‌های محیطی پیش‌نمایش Jenkins X بر اساس OpenShift کار کنید.
هفته 10 (16 نوامبر - 22 نوامبر)
- کار بر روی ماتریس قابلیت Jenkins X برای AWS (EKS): نصب Jenkins X و تهیه پیش‌نویس یادداشت‌های کاربر.
- روی یکی از اسناد-موضوعات برای بهبود اسناد موجود جنکینز X کار کنید.
هفته 11 (23 نوامبر - 29 نوامبر)
- اسناد کاربر را برای Jenkins X در EKS نهایی کنید.
- روی یکی از اسناد-موضوعات برای بهبود اسناد موجود جنکینز X کار کنید.
- مستندات زیرساخت محیطی پیش نمایش Jenkins X را در سایت Jenkins X docs نهایی کنید.
هفته 12 (30 نوامبر - 5 دسامبر)
- محصولات تحویلی پروژه را نهایی کنید و در صورت وجود کد را بر اساس بازخوردها مجدداً اصلاح کنید.
- عملکرد سایت اسناد جنکینز X از جمله پیوندها، تصاویر، لینک ها و موارد دیگر را آزمایش کنید.
- کنترل و ناوبری تعریف شده توسط کاربر در سایت اسناد جنکینز X را بررسی کنید.
- ارائه نهایی ماتریس Jenkins X Capabilites را بررسی کنید.
قبل از 10 دسامبر 2020، هم نویسنده فنی و هم مربیان ارزیابی پروژه را ارسال می کنند.
پروژه پیشنهادی چه مزایایی برای جنکینز ایکس و جامعه آن دارد؟ این پروژه به جامعه Jenkins X کمک می کند تا مستندات را برای کاربران نهایی خود و همچنین توسعه دهندگان برای ارجاع به معماری فنی، سازگاری، استفاده و یکپارچه سازی Jenkins X بهبود بخشد. با تکمیل این پروژه پیشنهادی، پس از آن یک مستندات کاربر کامل، کاملاً تعریف شده و تأیید شده فنی از جنکینز X به همراه ماتریس قابلیت Jenkins X برای سازگاری آن با ارائه دهندگان مختلف ابری وجود خواهد داشت.
قصد دارید در آینده با جنکینز X کار کنید؟ پس از پایان برنامه Google Season of Docs 2020، من قصد دارم به عنوان عضوی فعال در انجمن، در پروژه Jenkins X مشارکت طولانی مدت داشته باشم. من همیشه در اطراف خواهم بود تا به دیگران (تازه واردان) کمک کنم و آنها را تشویق کنم تا در انجمن جنکینز ایکس شرکت کنند. من همیشه مایلم روی سایر ایده های پروژه جنکینز ایکس کار کنم.
برخی از دلایلی که من را برای کار روی این پروژه مناسب تر می کند:
- من بسیار روشمند و منظم هستم. من به شدت انتظار دارم که از طریق پست های وبلاگ هفته ای یک بار، جلسات هفتگی SIG-docs برنامه ریزی شده و از طریق ایمیل به طور منظم از پیشرفت پروژه هم به مربیان پروژه و هم برای جامعه سازمان مطلع باشم.
- به طور مکرر به دنبال راهنمایی و همچنین بازخورد از مربیان و اعضای جامعه خواهد بود تا در انجام وظایف پیشرفت کند و اطمینان حاصل شود که همه در یک صفحه قرار دارند (شامل ذکر هر گونه چالش و/یا نقاط مسدود کننده ای که با آن مواجه می شوید).
- تعهد تمام کد منبع نوشته شده به طور منظم، به منظور بازبینی کد از مربی، مشارکت کنندگان و مستندسازی کار انجام شده برای ارجاع به اعضای انجمن.
- من تمام مهارت های فنی مورد نیاز برای کار بر روی این ایده پروژه را دارم و در مورد پیشنهاد پروژه با مربیان دین، کارا و دانیل صحبت کرده ام. من درک عمیقی از طرح پیشنهادی پروژه و موارد قابل تحویل آن دارم.
- من تجربه کار با مهارت های فنی (Google Cloud، Azure Cloud، AWS، Kubernetes، OpenShift، Hugo، و دیگران) را دارم که برای ارائه یک مستندات کامل و همچنین حل اکثر مسائل مربوط به مستندات فعلی لازم است. من دارای نگرش مثبتی هستم که می توانم کار پروژه را با نظارت اندک به موقع انجام دهم.