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