تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- Cloud Native Computing Foundation (CNCF)
- الكاتب الفني:
- Syam Sundar K
- اسم المشروع:
- مزيد من أمثلة Kubectl وأفضلها
- طول المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
سيكون الغرض من هذا المشروع هو تحسين جدول kubectl الاحتياطي الحالي والمستندات المرجعية.
هذه هي الأهداف النهائية لهذا المشروع: • إنشاء المزيد من أمثلة kubectl. • إضافة أمثلة على kubectl إلى بطاقة kubectl المختصرة • أعِد ضبط مستندات kubectl للاستفادة إلى أقصى حدّ.
الهدف الأول: أمثلة على kubectl:
سنعمل عن كثب مع مجموعات الاهتمامات الخاصة بواجهة سطر الأوامر من أجل الحصول على سياق ونوع الأمثلة التي يريدها مستخدمو Kubernetes أكثر من غيرها وتوثيقها. يمكن أن يتراوح هذا من تحسين أوامر kubectl الحالية على ورقة المعلومات المرجعية إلى إضافة أوامر جديدة إلى ورقة المعلومات المرجعية.
الهدف الثاني: زيادة فائدة المستندات:
لزيادة فائدة المستندات، يمكن إجراء ما يلي:
• إزالة الصعوبات التي يواجهها المبتدئون • إعادة ترتيب أمر kubectl بترتيب معيّن لضمان الاستمرارية في التدفق المنطقي
تخلص من الصعوبات التي يواجهها المبتدئين من خلال تقديم تفسيرات أفضل لحالة المستخدم / الأمر قد يبدو هذا بسيطًا ولكنه قد يؤثر بشكل كبير على المبتدئين إما لمواصلة تعلمهم أو التخلي عنه. على سبيل المثال، عندما بدأت باستخدام Kubernetes من خلال kubectl، لم أكن متأكّدًا من الاختلافات بين وحدات pod وعمليات النشر. في البداية، لقد نزّلتُ خدمة خلفية مكتوبة بلغة nodejs. بعد بضع ساعات، أردت إيقافه، لذا حاولت حذف الحِزمة، ولكن بسبب طبيعة الحِزم في إصلاح نفسها، تم إنشاؤها مرة أخرى. لقد انتابني بعض الارتباك بشأن ما يحدث وتساءلت عن سبب إعادة إنشائه وعدم حذفه. بعد إجراء بعض عمليات البحث على الويب، تبيّن لي أنّ حذف وحدات pod لا يشبه حذف عملية النشر. قد يبدو هذا الأمر بسيطًا للعين المدربة، ولكنّ الشرح الواضح الذي يزيل هذه الأنواع من الغموض هو ما يميز المستند الجيد عن المستند الرائع.
إعادة ترتيب الأمر kubectl بترتيب معيّن لضمان استمرارية التدفق المنطقي إذا كنت شخصًا مثلي يؤمن بشدة بسرد القصص، فربما تتساءل، كيف يمكنك إدخال عناصر سرد القصص في ورقة مستند تحتوي على قائمة بالأوامر الطرفية، أقول، يمكن القيام بذلك. إنّ أيّ شيء نتعلمه يكون له دائمًا تسلسل منطقي، أي نقطة بداية ونقطة نهاية. من الواضح أنّ أداة سطر الأوامر Kubectl لها منحنى تعلُّم، وفي الواقع، يتطابق منحنى التعلّم الخاص بها مع منحنى التعلّم الخاص بـ Kubernetes نفسها. بما أنّ الجميع تقريبًا يبدأ رحلته مع Kubernetes من خلال kubectl (باستثناء المستخدمين الذين يستخدمون واجهة مستخدم الويب) وبما أنّ منحنى التعلّم مرتبط ارتباطًا وثيقًا بمنحنى التعلّم في Kubernetes، يمكن تحسين المستندات بشكل كبير من خلال تغيير ترتيب هذه الأوامر وتقديم عناصر سرد القصص إليها. على سبيل المثال، يمكن شرح ميزات مثل القياس التلقائي للوحات أفقية بعد شرح الموارد باستخدام أمثلة وصور توضيحية من الواقع.
الهدف الثالث: تحسينات على سهولة استخدام "مستندات Google":
إنّ عملية النقل الأخيرة لموقع Kubernetes الإلكتروني إلى Docsy Hugo تشكّل تغييرًا كبيرًا في منظور المستندات. على الرغم من نجاح عملية نقل البيانات، لا يزال هناك مجال لإجراء الكثير من التحسينات في مساحة المستندات.
فيما يلي بعض التغييرات التي أقترحها،
• الانتقال التلقائي في اللوحة اليمنى إلى القسم النشِط حاليًا في المستندات الرئيسية: يمكن أن يكون ذلك مفيدًا في تتبُّع الأقسام الحالية والقادمة والسابقة. • النسخ إلى الحافظة: يمكن أن تكون بعض الأوامر طويلة، ويمكن أن تكون وظيفة النسخ مفيدة عند التعامل مع هذا النوع من الأوامر. • تنسيق محتوى ملفات المستندات - بعد النقل، لا يتم تنسيق المحتوى في بعض الصفحات بشكل صحيح. على سبيل المثال: قسم "نوع المورد" في نظرة عامة على kubectl. يؤدي هذا إلى خفض تجربة المستخدم.
في ما يلي التغييرات التي يمكن أن تحسِّن تجربة المستخدم على موقع kubernetes الإلكتروني، ويمكنها أيضًا تحسين إنتاجية المستخدم.