تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- Cloud Native Computing Foundation (CNCF)
- الكاتب التقني:
- الرفيقة
- اسم المشروع:
- تعديل كيفية عرض موقع Kubernetes الإلكتروني لمراجع واجهة برمجة التطبيقات
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
في الوقت الحالي، مَراجع واجهة برمجة تطبيقات Kubernetes هي مستندات HTML كبيرة يتم إنشاؤها باستخدام مواصفات Swagger من خلال النصوص البرمجية المستضافة خارج مستودع المواقع الإلكترونية، ثم تتم إضافتها إلى مستودع المواقع الإلكترونية هذا.
من ناحية أخرى، تم إنشاء الموقع الإلكتروني لمستندات Kubernetes باستخدام "هوغو" استنادًا إلى مستندات مكتوبة بتنسيق Markdown في مستودع الموقع الإلكتروني، وذلك باستخدام مظهر Docsy Hugo.
يهدف هذا المشروع إلى دمج عملية إنشاء مراجع واجهة برمجة التطبيقات Kubernetes API في عملية إنشاء الموقع الإلكتروني الخاص بالتوثيق.
سنركّز على وجه التحديد على رمز swaggerui القصير، الذي يحيط بـ swagger-ui، والذي يوفّره مظهر Docsy Hugo، وعلى أدوات معيّنة، ما يتيح إدراج أجزاء من مواصفات واجهة برمجة التطبيقات في تدفق مستندات Kubernetes.
ستحتاج إلى أدوات محدّدة لأنّ أداة swagger-ui قادرة على عرض المواصفات الكاملة الموضّحة في ملف كلمات التباهي، ولكن ليس جزءًا منها (راجِع 8). إنّ واجهة برمجة تطبيقات Kubernetes كبيرة جدًا ولا يمكن عرضها في جزء واحد فقط (مثال على الناتج). سنأخذ في الاعتبار أسلوبين:
إنشاء عدة ملفات للتباهي، ملف لكل مجموعة من مجموعات واجهة برمجة التطبيقات Kubernetes (الإصدار الأساسي/الإصدار الأول، التطبيقات/الإصدار الأول،...) من مصادر متوفرة على الرقم (10) واستخدام هذه الملفات كإدخال لرموز swaggerui للفرز في أماكن محددة في الموقع الإلكتروني لوثائق Kubernetes،
والطريقة الثانية هي إنشاء أداة تحصل كإدخال لملف التباهي الكامل لواجهة برمجة تطبيقات Kubernetes المتوفر في (11) وتُخرج ملف كلمات للدلالة على نقطة نهاية محددة أو عدد محدود من نقاط النهاية، بالإضافة إلى مواردها وتعريفاتها المرتبطة بها، ثم استخدام ملفات التباهي هذه كإدخال لرموز swaggerui القصيرة في أماكن محددة ضمن الموقع الإلكتروني لوثائق Kubernetes.
نظرًا لأن مصادر المواصفات (10 و11) موجودة في مستودعات أخرى غير مصادر الوثائق، فسنحتاج إلى إيجاد طريقة لتحديثها تلقائيًا في مستودع الوثائق عندما يتم تغييرها.
بما أنّ مستندات Kubernetes متوفّرة بلغات مختلفة، سنولي اهتمامًا خاصًا لإمكانية نشر الترجمات لمرجع واجهة برمجة التطبيقات Kubernetes.