هذا المستودع هو المصدر الرئيسي لوثائق المطورين لـ Flatpak. يمكن قراءتها على docs.flatpak.org.
بعض الوثائق متاحة أيضًا على موقع Flatpak wiki وكجزء من صفحات الدليل الخاصة بـ flatpak و flatpak-builder .
تتم كتابة المستندات في reStructuredText والمساهمات هي موضع ترحيب!
إنشاء بيئة بايثون الافتراضية:
python3 -m venv .venv && source .venv/bin/activate
ثم قم بتثبيت التبعيات باستخدام النقطة :
تثبيت النقطة -r متطلبات.txt
بعد الإعداد، يمكنك بناء الوثائق:
جعل -C مستندات HTML
تشغيل الاختبارات:
جعل -C مستندات linkcheck
يمكنك تشغيل خادم HTTP واتباع الرابط المطبوع (المضيف المحلي: 8000) لعرض الوثائق في متصفحك:
python3 -m http.server -d docs/_build/html
بشكل افتراضي، تكون الوثيقة التي يتم إنشاؤها باللغة الإنجليزية. إذا كنت تريد إنشاء مستندات بلغات أخرى، مثل الصينية، فيمكنك استخدام الأمر التالي:
جعل -C مستندات html SPHINXOPTS='-D language=zh_CN'
يمكنك فتح طلب سحب بإضافة لغة جديدة.
يمكن للمشرفين إنشاء ملفات القالب ( .pot ) وتحديث ملفات الترجمة ( .po ) وإزالة ملفات الترجمة القديمة (أي ملف .pot المطابق لم يعد موجودًا) عن طريق تشغيل:
make -C docs update-po
يعد مطورو تطبيقات سطح المكتب الجمهور الأساسي لمستندات Flatpak، وخاصة مؤلفي التطبيقات الموجودة، بما في ذلك تلك الموجودة على الأنظمة الأساسية غير Linux.
يجب أن تعكس المستندات الممارسة الشائعة بين هذا الجمهور حيثما أمكن ذلك، ولا تفترض أن التطبيقات تأتي من مساحة سطح مكتب Linux. ومن الناحية العملية، هذا يعني أنه ينبغي لنا أن نتوقع:
Git للتحكم في الإصدار
جيثب للاستضافة
أوقات تشغيل سطح المكتب المجانية
لا توجد معرفة مسبقة باتفاقيات Linux لسطح المكتب، مثل ملفات .desktop وAppStream وD-Bus
وبعيدًا عن هذه الإعدادات الافتراضية الأساسية، يجب إيلاء اهتمام خاص منفصل للتقنيات الشائعة عبر الأنظمة الأساسية مثل Electron وQt.
إرشادات لأولئك الذين يرغبون في المساهمة في المستندات:
شرح مفاهيم Flatpak الأساسية
التركيز على سير عمل مطور التطبيقات القياسي
استخدم المستندات لشرح فوائد Flatpak ولماذا قد يستخدمها المطور
قم بتغطية ما هو ضروري لمطوري التطبيقات فقط - ولا تقم بتضمين تفاصيل الأجزاء الداخلية لـ Flatpak ما لم يكن ذلك ضروريًا للغاية
توفير تجربة مطور تتسم بالسلاسة وعدم الاحتكاك قدر الإمكان
ساعد في منع الصعوبات من خلال توقع المشكلات المحتملة التي قد يواجهها المطورون وتوجيههم بعيدًا عنها
