مقدمة إلى مواقع wiki الخاصة بمشروع Azure DevOps

مكتمل

تتضمن مشاريع Azure DevOps خيارًا لإنشاء موقع wiki الخاص بالمشروع.

Project wiki.

مشروع wiki لمشاركة المعلومات مع فريقك لفهم مشروعك والمساهمة فيه.

يتم تخزين Wikis في مستودع. لا يتم توفير wiki تلقائيًا.

المتطلبات الأساسية

يجب أن يكون لديك إذن لإنشاء مستودع لنشر التعليمات البرمجية كموقع wiki. بينما تمتلك مجموعة مسؤولي النظام هذا الإذن بشكل افتراضي، إلا أنه يمكن تعيينه للآخرين.

لإضافة صفحات wiki أو تحريرها، يجب أن تكون عضوًا في مجموعة المساهمين.

يمكن لجميع أعضاء مشروع الفريق (بما في ذلك أصحاب المصلحة) عرض wiki.

الإنشاء

تتضمن المقالة التالية تفاصيل عن إنشاء موقع wiki: أنشئ Wiki لمشروعك.

تحرير wiki

تتضمن المقالة التالية تفاصيل عن نشر مستودع Git إلى موقع wiki: نشر مستودع Git إلى موقع wiki.

Markdown

تتم كتابة Azure DevOps Wikis في Markdown ويمكن أن تتضمن أيضًا مرفقات ملفات ومقاطع فيديو.

Markdown هي لغة تمييز. يتضمن النص العادي بناء جملة التنسيق. لقد أصبح المعيار الفعلي لكيفية كتابة وثائق المشروع والبرامج الآن.

أحد الأسباب الرئيسية لذلك هو أنه لأنه يتكون من نص عادي، فإنه من الأسهل بكثير الدمج بنفس الطريقة التي يتم بها دمج كود البرنامج.

يسمح بإدارة المستندات باستخدام نفس الأدوات المستخدمة لإنشاء تعليمات برمجية أخرى في المشروع.

Markdown بصفة GitHub (GFM)

GFM هي مواصفات رسمية صادرة عن GitHub أضافت امتدادات إلى تنسيق أساسي يسمى CommonMark. يستخدم GFM على نطاق واسع داخل GitHub وخارجها. يتم تقديم GFM في Azure DevOps Wikis.

Mermaid

أصبح Mermaid امتدادًا أساسيًا لـ Markdown لأنه يتيح تضمين المخططات في الوثائق.

فهو يتغلب على الصعوبات السابقة في دمج الوثائق التي تتضمن الرسوم البيانية ممثلة كملفات ثنائية.

Mermaid Markup.

Mermaid Rendering.

يمكن العثور على تفاصيل بشأن بناء جملة Mermaid هنا: مقدمة إلى Mermaid