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