تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخص المشروع
- مؤسسة مفتوحة المصدر:
- Jenkins X
- الكاتب الفني:
- Nitin
- اسم المشروع:
- إعادة بناء موقع مستندات Jenkins X الحالي ومصفوفة إمكانات Jenkins X
- طول المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
يتمثل الهدف الرئيسي من هذا المشروع في إعادة صياغة مستندات Jenkins X الحالية أثناء حلّ المشاكل المتعلّقة بالمستندات، بالإضافة إلى إعداد مصفوفة قدرات Jenkins X المعدّلة مع مستندات المستخدم حول استخدام Jenkins X على موفّري خدمات السحابة الإلكترونية للمؤسسات. بالإضافة إلى ذلك، يشمل هذا المشروع أيضًا العمل على تطوير البنية الأساسية لبيئة معاينة Jenkins X استنادًا إلى OpenShift، وذلك بالتعاون مع "دانيال".
في إطار إعادة صياغة مستندات Jenkins X الحالية، تشمل بعض المشاكل التي سأعمل عليها ما يلي:
- التشغيل في موارد EKS: المشكلة
- تعذُّر تثبيت Vault في EKS مع Boot: مشكلة
- مستند envars لبدء jx: المشكلة
- المستندات المطلوبة لإعداد Vault: المشكلة
- تعذُّر ترقية التمهيد من الجهاز إلى الخزينة: مشكلة
- ملاحظات حول المستندات: العلاقة بين "إنشاء" و"تثبيت jx" و"تشغيل" و"استيراد": مشكلة
- تقديم وثائق هلم في كل مكان: المشكلة
- تحسين المستندات حول سبب عدم استبدال ChartMuseum وMonocular وDocker Registry بمشكلة Nexus
- تعذُّر تغيير Docker Registry عند استخدام Boot + GKE: المشكلة
- تعذُّر تغيير النطاق من nip.io إلى نطاق خاص: مشكلة
وبالنسبة إلى مصفوفة إمكانات Jenkins X، يتضمّن العمل (كما هو مذكور أدناه) خدمات Kubernetes للمؤسسات التي يوفّرها كل مزوّد من مقدّمي خدمات السحابة الإلكترونية، أي Google Cloud (GKE) وAmazon Web Services (AWS EKS) وAzure Cloud (AKS)
- تثبيت Jenkins X على السحابة الإلكترونية عبر نصوص برمجية تستخدم شكل terraform و
jx boot - التحقّق من توافق إصدارات Kubernetes مع Jenkins X على خدمات Kubernetes لمقدّمي خدمات السحابة الإلكترونية هؤلاء
- أي إمكانات أخرى (مساحة تخزين Vault للسرّيات أو إصدارات التحكّم في المصدر أو غيرها) لمناقشتها مع "دين" وأعضاء منتدى Jenkins X
في ما يتعلّق بالعمل على إعداد البنية الأساسية لبيئة معاينة Jenkins X المستندة إلى OpenShift، يتضمّن العمل ما يلي:
- مستند التصميم حول بنية بيئة معاينة Jenkins X على منصة OpenShift
- إنشاء بيئات معاينة Jenkins X تلقائيًا في OpenShift
- تعديل مستندات Jenkins X في البيئات التجريبية
مُخرَجات المشروع النهائية:
- إصلاحات من خلال طلب إعادة النظر في مشاكل المستندات المذكورة أعلاه، مع مراعاة إعادة صياغة مستندات Jenkins X الحالية
- تم تعديل مصفوفة إمكانات Jenkins X ومستندات المستخدمين حول استخدام Jenkins X مع مقدّمي خدمات سحابة إلكترونية مختلفين (خدمات Kubernetes بشكل أساسي AKS وEKS وGKE).
- الإعداد التلقائي لبيئة معاينة Jenkins X بناءً على نظام OpenShift، بالتعاون مع Daniel.
المخطط الزمني الأوّلي (مع المهام) المقترَح:
المساهمة المجتمعية (17 أغسطس - 13 سبتمبر)
- إعداد بيئة تطوير للوثائق الفنية، بالإضافة إلى الحصول على إذن الوصول إلى البنى الأساسية في Cloud للعمل على مهام المشروع
- المناقشة مع مرشدي المشروع حول الجدول الزمني المؤقت المقترح، والمُخرَجات النهائية للمشروع بالإضافة إلى المهام (إلى جانب أولويتها).
- فهم عملية عمل المؤسسة وعملية مراجعة العلاقات العامة وتجهيزها جيدًا، والمشاركة مع المجتمع.
- راجِع حالة مستندات Jenkins X الحالية.
الأسبوع 1 (من 14 إلى 20 أيلول (سبتمبر))
- فهم تعليمات إعداد Jenkins X على السحابة الإلكترونية والحالة الحالية والمستندات
- مناقشة مع "دين" حول إمكانات Jenkins X الحالية (التي يجب التحقّق منها لدى مقدّمي خدمات سحابة إلكترونية مختلفين)
- مناقشة مع "دانيال" حول الحالة الحالية للبنية الأساسية لبيئة معاينة Jenkins X المستندة إلى OpenShift
- العمل (بالتعاون مع "دانيال") على تصميم بنية أساسية لبيئة معاينة Jenkins X على OpenShift
الأسبوع 2 (من 21 إلى 27 أيلول/سبتمبر)
- العمل على مصفوفة قدرات Jenkins X لسحابة GKE: تثبيت Jenkins X وإعداد مسودة ملاحظات المستخدمين
- العمل على إحدى مشاكل المستندات لتحسين مستندات Jenkins X الحالية
الأسبوع 3 (من 28 أيلول (سبتمبر) إلى 4 تشرين الأول (أكتوبر))
- العمل على مصفوفة إمكانات Jenkins X لسحابة GKE: تثبيت Jenkins X وإعداد مسودة ملاحظات المستخدمين
- العمل على إحدى مشاكل المستندات لتحسين مستندات Jenkins X الحالية
- العمل على مستند التصميم لبنية بيئة معاينة Jenkins X المستندة إلى OpenShift
الأسبوع 4 (من 5 تشرين الأول (أكتوبر) إلى 11 تشرين الأول (أكتوبر))
- أكمِل مستندات المستخدم الخاصة بـ Jenkins X على GKE.
- العمل على إحدى مشاكل المستندات لتحسين مستندات Jenkins X الحالية
الأسبوع 5 (من 12 إلى 18 تشرين الأول (أكتوبر))
- العمل على مصفوفة إمكانات Jenkins X لسحابة Azure (AKS): تثبيت Jenkins X وإعداد مسودة ملاحظات المستخدمين
- العمل على إحدى مشاكل المستندات لتحسين مستندات Jenkins X الحالية
- وضع اللمسات الأخيرة على مستند التصميم الخاص ببنية بيئة معاينة Jenkins X المستندة إلى OpenShift، بعد الحصول على ملاحظات من أعضاء المنتدى
الأسبوع 6 (من 19 إلى 25 تشرين الأول/أكتوبر)
- يمكنك العمل على مصفوفة إمكانات Jenkins X لخدمة Azure Cloud (AKS): تثبيت Jenkins X وإعداد مسودة ملاحظات المستخدم.
- العمل على إحدى مشاكل المستندات لتحسين مستندات Jenkins X الحالية
الأسبوع 7 (من 26 تشرين الأول (أكتوبر) إلى 1 تشرين الثاني (نوفمبر))
- العمل على مصفوفة إمكانات Jenkins X لسحابة Azure (AKS): تثبيت Jenkins X وإعداد مسودة ملاحظات المستخدمين
- عالِج مشكلة في المستندات لتحسين مستندات Jenkins X الحالية.
- العمل على إعداد البنية الأساسية لبيئة معاينة Jenkins X استنادًا إلى OpenShift
الأسبوع 8 (من 2 إلى 8 تشرين الثاني (نوفمبر))
- أكمِل مستندات المستخدمين الخاصة بخدمة Jenkins X على AKS.
- العمل على إحدى مشاكل المستندات لتحسين مستندات Jenkins X الحالية
الأسبوع 9 (من 9 تشرين الثاني (نوفمبر) إلى 15 تشرين الثاني (نوفمبر))
- العمل على مصفوفة إمكانات Jenkins X لـ AWS (EKS): تثبيت Jenkins X وإعداد مسودة ملاحظات المستخدمين
- عالِج مشكلة في المستندات لتحسين مستندات Jenkins X الحالية.
- العمل على إعداد البنية الأساسية لبيئة معاينة Jenkins X استنادًا إلى OpenShift
الأسبوع 10 (من 16 إلى 22 تشرين الثاني (نوفمبر))
- العمل على مصفوفة إمكانات Jenkins X لـ AWS (EKS): تثبيت Jenkins X وإعداد مسودة ملاحظات المستخدمين
- عالِج مشكلة في المستندات لتحسين مستندات Jenkins X الحالية.
الأسبوع 11 (من 23 تشرين الثاني (نوفمبر) إلى 29 تشرين الثاني (نوفمبر))
- أكمِل مستندات المستخدمين الخاصة بخدمة Jenkins X على EKS.
- العمل على إحدى مشاكل المستندات لتحسين مستندات Jenkins X الحالية
- أكمِل مستندات بنية بيئة معاينة Jenkins X على موقع Jenkins X الإلكتروني المخصص للمستندات.
الأسبوع 12 (من 30 تشرين الثاني (نوفمبر) إلى 5 كانون الأول (ديسمبر))
- أكمِل المُخرَجات النهائية للمشروع وأعِد صياغة الرمز البرمجي إن توفّر، استنادًا إلى الملاحظات.
- اختبِر عمل موقع مستندات Jenkins X الإلكتروني، بما في ذلك الروابط والصور والروابط التشعّبية وغيرها.
- تحقّق من عناصر التحكّم والتنقّل التي يحدّدها المستخدم في موقع Jenkins X الإلكتروني المخصّص للمستندات.
- اطّلِع على العرض النهائي لمصفّحة قدرات Jenkins X.
قبل 10 ديسمبر 2020 يقدم كل من الكاتب الفني والموجهين تقييمًا للمشروع.
ما هي فوائد المشروع المقترَح لـ Jenkins X ومجتمعه؟ سيساعد هذا المشروع منتدى Jenkins X على تحسين المستندات المخصّصة للمستخدمين النهائيين والمطوّرين للاطّلاع على البنية الفنية لـ Jenkins X والتوافق والاستخدام والدمج. بعد الانتهاء من هذا المشروع المقترح، سيكون هناك مستندات كاملة ومحدّدة بشكل جيد تم التحقق منها للمستخدمين من Jenkins X بالإضافة إلى مصفوفة إمكانات Jenkins X لتوافقها مع مقدمي خدمات السحابة الإلكترونية المختلفين.
ما هي المزايا المستقبلية التي تخطّط للعمل عليها مع Jenkins X؟ بعد انتهاء برنامج Google Season of Docs لعام 2020، أخطّط لأن أصبح مساهمًا على المدى الطويل في مشروع Jenkins X بصفتي عضوًا نشطًا في المنتدى. سأكون دائمًا متاحًا لمساعدة الآخرين (المستجدين) وتشجيعهم على المشاركة في منتدى Jenkins X. سأكون على استعداد دائمًا للعمل على أفكار مشاريع أخرى في Jenkins X.
بعض الأسباب التي تجعلني أكثر ملاءمة للعمل في هذا المشروع:
- أنا منهجي ومنظم للغاية. أتوقع بشدة أن أبقى على اطلاع دائم بالتقدم المحرز في المشروع لكل من مرشدي المشروع ومنتدى المؤسسة عبر مشاركات المدونة مرة واحدة في الأسبوع، والاجتماعات الأسبوعية لمستندات SIG وعبر رسائل البريد الإلكتروني بشكل منتظم.
- سنطلب الإرشادات والملاحظات من المرشدين وأعضاء المنتدى بشكل متكرر، وذلك للتقدّم في المهام والتأكّد من أنّ الجميع على دراية بالموضوع نفسه (بما في ذلك الإشارة إلى أيّ تحديات و/أو نقاط عرقلة تواجهها).
- الالتزام بكتابة جميع رموز المصدر بصورة منتظمة، وذلك حتى تتم مراجعة الكود من قِبل المرشد والمساهمين وتوثيق العمل المنجز كمرجع لأعضاء المنتدى.
- لديّ كل المهارات الفنية المطلوبة للعمل على فكرة المشروع هذه، ولقد ناقشتُ اقتراح المشروع مع المرشدين "دين" و"كارا" و"دانيال". لقد فهمتُ بشكلٍ معمّق مقترح المشروع ومخرجاته.
- لديّ خبرة في العمل بالمهارات الفنية (Google Cloud وAzure Cloud وAWS وKubernetes وOpenShift وHugo وغيرها) اللازمة لتقديم مستندات شاملة بالإضافة إلى حلّ معظم المشاكل الحالية المتعلقة بالمستندات. لديّ أسلوب إيجابي يمكنني من إنجاز عمل المشروع في الوقت المحدّد مع القليل من الإشراف.