تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- Jenkins X
- الكاتب التقني:
- نيتين
- اسم المشروع:
- إعادة بناء موقع مستندات Jenkins X الحالي ومصفوفة قدرات Jenkins X
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
الهدف الرئيسي من هذا المشروع هو إعادة هيكلة مستندات Jenkins X الحالية أثناء إصلاح المشاكل المتعلّقة بالمستندات، بالإضافة إلى تحضير مصفوفة إمكانات Jenkins X المعدَّلة بالإضافة إلى مستندات المستخدم حول استخدام Jenkins X لدى مقدّمي خدمات السحابة الإلكترونية للمؤسسات. بالإضافة إلى ذلك، يتضمن هذا المشروع أيضًا العمل على تطوير البنية الأساسية لبيئة معاينة Jenkins X استنادًا إلى نظام OpenShift، بالتعاون مع دانيال.
كجزء من إعادة هيكلة وثائق Jenkins X الحالية، تتضمن بعض المشكلات التي سأعمل عليها ما يلي:
- تمهيد في موارد EKS: مشكلة
- تعذُّر Vault في EKS عند التشغيل: المشكلة
- متغيرات المستند لـ jx Boot: المشكلة
- المستندات اللازمة لإعداد Vault: المشكلة
- مشكلة تعذُّر ترقية عملية الترقية من الجهاز المحلي إلى Vault
- ملاحظات حول الوثائق: العلاقة بين "create" و"install jx" و"boot" مقابل "استيراد": المشكلة
- توثيق هللم في كل مكان: المشكلة
- تحسين المستندات لماذا لا يتم استبدال ChartMuseum وMonocular وDoor Registry بمشكلة Nexus
- تعذر تغيير Docker Registry عند استخدام التمهيد + 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 في بيئات المعاينة
المُخرَجات النهائية للمشروع:
- إصلاح المشاكل عبر الإصدارات الصحفية المذكورة أعلاه وحلّ مشاكل المستندات المذكورة أعلاه، مع مراعاة إعادة تنظيم مستندات Jenkins X الحالية.
- تم تعديل مصفوفة Jenkins X Capability Matrix بالإضافة إلى مستندات المستخدم حول استخدام Jenkins X مع مقدِّمي خدمات السحابة الإلكترونية المختلفين (خدمات Kubernetes بشكل رئيسي AKS وEKS وGKE).
- الإعداد التلقائي للبنية الأساسية لبيئة معاينة Jenkins X استنادًا إلى نظام OpenShift، بالتعاون مع دانيال.
تم اقتراح جدول زمني مبدئي (إلى جانب المهام):
الترابط بين أفراد المنتدى (17 أغسطس - 13 سبتمبر)
- يمكنك إعداد بيئة التطوير للوثائق الفنية بالإضافة إلى الحصول على إمكانية الوصول إلى البنى الأساسية السحابية للعمل على مهام المشروع.
- المناقشة مع مرشدي المشروع حول الجدول الزمني المؤقت المقترح، المُخرَجات النهائية للمشروع بالإضافة إلى المهام (إلى جانب أولويتهم).
- فهم عملية عمل المؤسسة وعملية مراجعة العلاقات العامة والمشاركة في المجتمع وتجهيزها جيدًا.
- راجِع حالة وثائق 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 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 Capabilites.
قبل 10 ديسمبر 2020 يقدم كل من الكاتب الفني والموجّهين تقييم المشروع.
ما الفوائد التي سيعود بها المشروع المقترح على Jenkins X ومجتمعه؟ سيساعد هذا المشروع منتدى Jenkins X في تحسين المستندات للمستخدمين النهائيين وكذلك للمطوّرين كمرجع حول البنية الفنية والتوافق والاستخدام والتكامل في Jenkins X. بعد إنجاز هذا المشروع المقترح، ستتوفر وثائق مستخدم كاملة ومحددة بشكل جيد وتم إثبات صحتها تقنيًا لـ Jenkins X بالإضافة إلى مصفوفة Jenkins X Capability Matrix لتوافقها مع مقدّمي خدمات السحابة الإلكترونية المختلفين.
ما هي المزايا المستقبلية التي تخطّط للعمل عليها مع Jenkins X؟ بعد نهاية برنامج Season of Docs 2020 من Google، أنوي أن أصبح مساهمًا على المدى الطويل في مشروع Jenkins X كعضو نشط في المنتدى. سأكون دائمًا على أتمّ الاستعداد لمساعدة الآخرين (المبتدئين) وتشجيعهم على المشاركة في منتدى Jenkins X. سأكون دائمًا على استعداد للعمل على أفكار مشروعات Jenkins X الأخرى.
بعض الأسباب التي تجعلني أكثر ملاءمة للعمل في هذا المشروع:
- أنا منهجي ومنظم للغاية. أتوقع بشدة أن أبقى على اطلاع دائم بتقدم المشروع لكل من مرشدي المشروع ومجتمع المؤسسة عبر منشورات المدونة مرة واحدة في الأسبوع، والاجتماعات الأسبوعية المجدولة لمستندات SIG وعبر رسائل البريد الإلكتروني بشكل منتظم.
- سوف يطلبون التوجيه بالإضافة إلى الملاحظات من المرشدين وأعضاء المجتمع بشكل متكرر، وذلك للتقدم في المهام وضمان أن يكون الجميع على وفاق (بما في ذلك الإشارة إلى أي تحديات و/أو نقاط حظر تمت مواجهتها).
- الالتزام بجميع رموز المصدر المكتوبة بشكل منتظم، من أجل مراجعة التعليمة البرمجية من المرشد والمساهمين و توثيق العمل المنجز للرجوع إليه لأعضاء المجتمع.
- لديّ جميع المهارات التقنية المطلوبة اللازمة للعمل على فكرة المشروع هذه، وقد ناقشت اقتراح المشروع مع الموجهين "دين" و"كارا" و"دانيال". لقد حصلت على فهم متعمق لاقتراح المشروع وتسليماته.
- لديّ خبرة في العمل بالمهارات الفنية (Google Cloud وAzure Cloud وAWS وKubernetes وOpenShift وHugo وغيرها) اللازمة لتقديم مستندات كاملة بالإضافة إلى حلّ معظم المشاكل الحالية المتعلّقة بالمستندات. لدي موقف إيجابي يمكنه فعل ذلك حيث يمكنه إنجاز عمل المشروع في الوقت المحدد مع القليل من الإشراف.