تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول ضمن "موسم المستندات" من Google.
ملخص المشروع
- مؤسسة البرامج المفتوحة المصدر:
- Jenkins X
- الكاتب الفني:
- نيتين
- اسم المشروع:
- إعادة بناء موقع مستندات Jenkins X الحالي ومصفوفة Jenkins X Capabilities
- طول المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
الهدف الرئيسي من هذا المشروع هو إعادة هيكلة مستندات Jenkins X الحالية مع إصلاح المشاكل المتعلّقة بالمستندات، بالإضافة إلى إعداد مصفوفة إمكانات Jenkins X المعدَّلة بالإضافة إلى مستندات المستخدِم حول استخدام Jenkins X لمقدّمي الخدمات السحابية للمؤسسات. بالإضافة إلى ذلك، يتضمن هذا المشروع العمل على تطوير البنية الأساسية لبيئة معاينة Jenkins X استنادًا إلى أداة OpenShift بالتعاون مع دانيال.
كجزء من إعادة بناء وثائق Jenkins X الحالية، تتضمن بعض المشكلات التي سأعمل عليها ما يلي:
- التشغيل في موارد EKS: المشكلة
- تعذُّر Vault في EKS مع التشغيل: المشكلة
- متغيرات المستند للتشغيل jx: المشكلة
- المستندات المطلوبة لإعداد Vault: المشكلة
- تعذُّر ترقية عملية التشغيل من الجهاز المحلي إلى Vault: المشكلة
- ملاحظات حول الوثائق العلاقة بين "create" و"install jx" و"boot" مقابل "الاستيراد": المشكلة
- توثيق المحتوى في كل مكان: المشكلة
- تحسين المستندات لماذا لا يتم استبدال 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 على السحابة الإلكترونية باستخدام نصوص برمجية مصغَّرة و
jx boot - جارٍ التحقّق من توافق إصدارات Kubernetes مع Jenkins X على خدمات kubernetes التي تقدّمها لمقدّمي الخدمات السحابية.
- أي إمكانات أخرى (مساحة تخزين في Vault للأسرار أو إصدارات عناصر التحكّم في المصدر أو غيرها) تتم مناقشتها مع "دين" وأعضاء منتدى Jenkins X
بالنسبة إلى العمل على إعداد البنية الأساسية لبيئة معاينة Jenkins X استنادًا إلى ميزة OpenShift، يتضمّن العمل ما يلي:
- مستند تصميم على البنية الأساسية لبيئة معاينة Jenkins X على منصة OpenShift
- إنشاء بيئات معاينة Jenkins X تلقائيًا في OpenShift
- تعديل مستندات Jenkins X في بيئات المعاينة
المُخرَجات النهائية للمشروع:
- يتم إصلاح مشاكل المستندات عبر العلاقات العامة (PR) ضِمن مشاكل المستندات المذكورة أعلاه، مع مراعاة إعادة بناء مستندات Jenkins X الحالية.
- تم تعديل مصفوفة قدرات Jenkins X بالإضافة إلى مستندات المستخدم حول استخدام Jenkins X مع مقدّمي خدمات مختلفين للسحابة الإلكترونية (خدمات Kubernetes بشكل أساسي AKS وEKS وGKE).
- الإعداد التلقائي لبيئة معاينة Jenkins X للبنية الأساسية استنادًا إلى OpenShift، بالتعاون مع Daniel.
الجدول الزمني المبدئي (إلى جانب المهام) المقترَح:
الترابط بين أفراد المنتدى (17 أغسطس - 13 سبتمبر)
- إعداد بيئة التطوير للوثائق الفنية بالإضافة إلى الحصول على إمكانية الوصول إلى البنى الأساسية للسحابة الإلكترونية للعمل على مهام المشروع.
- مناقشة مع مرشدي المشروع بشأن الجدول الزمني المؤقت المقترح، والمُخرَجات النهائية للمشروع بالإضافة إلى المهام (إلى جانب أولويتهم).
- فهم عملية عمل المؤسسة وعملية مراجعة العلاقات العامة والمشاركة في المجتمع والاستعداد لها جيدًا.
- راجِع حالة المستندات الحالية في Jenkins X.
الأسبوع 1 (14 سبتمبر - 20 سبتمبر)
- فهم تعليمات إعداد Jenkins X على السحابة الإلكترونية والحالة الحالية والوثائق
- مناقشة مع "دين" حول إمكانات Jenkins X الحالية (يتم التحقّق منها من خلال مقدّمي خدمات مختلفين للسحابة الإلكترونية).
- مناقشة مع "دانيال" حول الوضع الحالي لبيئة معاينة Jenkins X استنادًا إلى نظام OpenShift
- يمكنك العمل (بالتعاون مع Daniel) لتصميم بنية أساسية لبيئة معاينة Jenkins X على نظام OpenShift.
الأسبوع 2 (21 سبتمبر - 27 سبتمبر)
- العمل على مصفوفة إمكانيات Jenkins X لسحابة GKE Cloud: تثبيت Jenkins X وإعداد مسودة ملاحظات المستخدم
- عليك العمل على إحدى مشاكل المستندات لتحسين مستندات Jenkins X الحالية.
الأسبوع 3 (28 سبتمبر - 4 أكتوبر)
- العمل على مصفوفة إمكانيات Jenkins X لسحابة GKE Cloud: تثبيت Jenkins X وإعداد مسودة ملاحظات المستخدم
- عليك العمل على إحدى مشاكل المستندات لتحسين مستندات Jenkins X الحالية.
- يمكنك العمل على مستند تصميم البنية الأساسية لبيئة معاينة Jenkins X استنادًا إلى OpenShift.
الأسبوع 4 (5 أكتوبر - 11 أكتوبر)
- إنهاء مستندات المستخدم لـ Jenkins X على GKE
- عليك العمل على إحدى مشاكل المستندات لتحسين مستندات Jenkins X الحالية.
الأسبوع 5 (12 أكتوبر - 18 أكتوبر)
- العمل على مصفوفة قدرات Jenkins X لخدمة Azure Cloud (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 Cloud (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 Capabelites.
قبل 10 ديسمبر 2020 يقدم كل من الكاتب الفني والموجّهين تقييمًا للمشروع.
ما الفوائد التي تعود على المشروع المقترَح لـ Jenkins X ومجتمعه؟ سيساعد هذا المشروع مجتمع Jenkins X في تحسين الوثائق للمستخدمين النهائيين وكذلك للمطوّرين كمرجع حول البنية الفنية والتوافق والاستخدام والتكامل في Jenkins X. مع اكتمال هذا المشروع المقترح، ستكون هناك وثائق مستخدم كاملة ومحددة جيدًا وتم التحقق منها تقنيًا لـ Jenkins X إلى جانب مصفوفة إمكانية Jenkins X نظرًا لتوافقها مع مقدّمي خدمات السحابة الإلكترونية المختلفين.
ما هي المزايا المستقبلية التي تخطّط للعمل عليها مع Jenkins X؟ بعد انتهاء برنامج "موسم 2020" من "مستندات Google"، أخطّط لكي أصبح مساهمًا على المدى الطويل في مشروع Jenkins X كعضو نشط في المنتدى. سأكون دائمًا على أتمّ الاستعداد لمساعدة الآخرين (المبتدئون) وتشجيعهم على المشاركة في منتدى Jenkins X. سأكون دائمًا على استعداد للعمل على أفكار مشروع Jenkins X الأخرى.
بعض الأسباب التي تجعلني أكثر ملاءمة للعمل في هذا المشروع:
- أتمتع بأسلوب منهجي ومنظم للغاية. أتوقع بشدة أن أبقي على اطلاع دائم بتقدم المشروع لكل من مرشدي المشروع ومجتمع المؤسسة من خلال مشاركات المدونة مرة واحدة في الأسبوع، والاجتماعات الأسبوعية المجدولة بـ SIG وعبر رسائل البريد الإلكتروني على أساس منتظم.
- سنسعى للحصول على التوجيه وكذلك الملاحظات من المرشدين وأعضاء المجتمع بشكل متكرر، وذلك للتقدم في المهام وضمان أن يكون الجميع على وفاق (بما في ذلك الإشارة إلى أي تحديات و/أو نقاط عائق تمت مواجهتها).
- الالتزام بجميع رموز المصدر المكتوبة بصورة منتظمة، حتى تتم مراجعة الرمز من المرشد والمساهمين وتوثيق العمل المنجز للرجوع إليه لأعضاء المنتدى
- لدي جميع المهارات التقنية المطلوبة للعمل على فكرة المشروع هذه وقد ناقشت اقتراح المشروع مع المرشدين دين وكارا ودانيال. لقد حصلت على فهم متعمق لاقتراح المشروع والمُخرَجات النهائية له.
- لديّ خبرة في العمل باستخدام المهارات التقنية (Google Cloud وAzure Cloud وAWS وKubernetes وOpenShift وHugo وغيرها) اللازمة لتقديم مستندات كاملة بالإضافة إلى حلّ معظم المشاكل الحالية المتعلّقة بالمستندات. لدي موقف إيجابي من الشخص الذي يمكنه إنجاز عمل المشروع في الوقت المحدد مع القليل من الإشراف.