Telliot: قم بتحويل المستندات إلى تنسيق gitbook وإنشاء مهمة يومية لإجراءات GH لنسخ جميع المستندات من مستودع المنجم إلى مستودع مستندات الصراف الرئيسي.

تم إنشاؤها على ١٢ نوفمبر ٢٠٢٠  ·  13تعليقات  ·  مصدر: tellor-io/telliot

في الوقت الحالي ، يحتوي مستودع المنجم على بعض المستندات ضمن المجلد docs والبعض الآخر يتم الاحتفاظ به في مستودع المستندات الرئيسي على https://github.com/tellor-io/TellorDocs. أعتقد أن مستودع المستندات الرئيسي يجب أن يحتفظ بالمستندات المتعلقة بالمشروع نفسه ويجب الاحتفاظ بنظرة عامة على جميع المكونات والمستندات الخاصة بعمال المناجم (كيفية الإنشاء وكيفية التشغيل وما إلى ذلك) هنا في الريبو الخاص بعمال المناجم. عندئذٍ سيكون للمستندات الرئيسية رابطًا إلى مستندات كتاب عمال المناجم جيثب.
هذا له فائدتان رئيسيتان

  • عندما نجري تغييرات على الكود في نفس العلاقات العامة ، يمكن أيضًا تحديث المستندات.
  • أسهل للحفاظ على المزامنة حيث لن تكون هناك حاجة لفتح 2 PRs.
  • يمكن إنشاء بعض أجزاء المستندات تلقائيًا من الشفرة نفسها: https://github.com/tellor-io/TellorMiner/issues/194

اتبع القضية
يعتبر إجادة اللغة الإنجليزية أمرًا مهمًا لهذه المشكلة

good first issue help wanted .high clean up

ال 13 كومينتر

في فكرة ثانية ، ستكون تجربة المستخدم الأكثر روعة هي الاحتفاظ بجميع المستندات في كتاب جيثب واحد بدلاً من جعل الأشخاص يقفزون بين الكتب ، لذلك لتحقيق ذلك ، يجب علينا:

  • لا يزال يحتفظ بجميع المستندات المتعلقة بعمال المناجم هنا في مستودع المنجم (أسهل للحفاظ على مزامنة المستندات مع تغييرات التعليمات البرمجية)
  • قم بإنشاء مهمة cron لإجراءات GH اليومية لنسخ مستندات عامل التعدين من هنا إلى مستودع مستندات الصراف الرئيسي.

أنا أعيد تسمية العنوان لهذه الفكرة الجديدة.

أحد التحذيرات المهمة للغاية هو وضع ملاحظة واضحة جدًا في مستودع مستندات الصراف الرئيسي أنه بالنسبة إلى تغييرات مستندات عامل التعدين ، يجب فتح العلاقات العامة في إعادة الشراء الخاصة بعمال المناجم وليس في مستودع المستندات وإلا سيتم استبدال التغييرات من مهمة المزامنة اليومية.

يبدو أن إجراء GH هذا هو الإجراء الذي يجب استخدامه
https://github.com/repo-sync/repo-sync

لذا فإن الفكرة هي:

  1. PR واحد لنقل جميع المستندات من https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation إلى هذا الريبو في المجلد /docs/miner-documentation .
  2. PR آخر لدمج المستندات من /docs/miner-documentation مع المستندات الموجودة في /docs وتحويلها إلى تنسيق كتاب git.
  3. انقل جذر README.md و CHANGELOG.md إلى مجلد المستندات واترك رابطًا يشير إلى كتاب gitbook.
  4. PR آخر لإعداد repo-sync/repo-sync لمزامنة المجلد docs من هذا الريبو إلى https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation
  5. علاقات عامة أخرى لإضافة ملاحظات بعض التحذيرات المرئية تمامًا لعدم تعديل https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation مطلقًا وتعديل المستندات في هذا الريبو بدلاً من ذلك والتي ستتم مزامنتها تلقائيًا مع مستودع المستندات الرئيسي.

باستخدام سير العمل هذا ، سيكون من السهل جدًا تحديث المستندات ، مع توفير موقع ويب واحد للمستخدم لقراءة المستند بالكامل.

يجب القيام بذلك بعد أو مع https://github.com/tellor-io/TellorMiner/issues/282

حالة المشكلة: 1. فتح 2. بدأ 3. تم الإرسال 4. تم


__هذا الإصدار يحتوي الآن على تمويل قدره 14.0 ليرة تركية (435.58 دولارًا أمريكيًا @ 31.11 دولارًا أمريكيًا / TRB) مرفق به .__

حالة المشكلة: 1. فتح 2. بدأ 3. تم الإرسال 4. تم


__بدأ العمل__.

ادعى كل من هؤلاء المستخدمين أنه يمكنهم إكمال العمل بحلول 265 عامًا ، 12 شهرًا من الآن.
يرجى مراجعة خطط العمل الخاصة بهم أدناه:

1) تقدم sebastiantf لبدء العمل _ (الممولين فقط: الموافقة على العامل | رفض العامل ) _.

تبدو مهمة مباشرة مع Github Actions. سأحاول فعل هذا
2) قام developerfred بتقديم طلب لبدء العمل _ (الممولين فقط: الموافقة على العامل | رفض العامل ) _.

أحب أن أفعل هذا النقل ، فلدي بالفعل خبرة في gitbook وعملت مؤخرًا على قضية Tellor golang
3) تقدم echolon166 لبدء العمل _ (الممولين فقط: الموافقة على العامل | رفض العامل ) _.

أود مساعدتك في هذه المهمة. سأتبع الشرح الذي قدمه krasi-georgiev في المشكلة ، وسوف أقوم بتحويل المستندات إلى تنسيق gitbook وإنشاء مهمة إجراءات github كما تريد.
4) تقدم العديد من الموافقة على العامل | رفض العامل ) _.

تبدو ممتعة للغاية وأود أن أجربها
5) تمت الموافقة على hhio618 لبدء العمل.

حسنًا ، يبدو واضحًا. يمكننا بسهولة إنشاء بعض المستندات تلقائيًا من الشفرة مثل ما فعله ثانوس.

تعرف على المزيد

1. one PR to move all docs from `https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation` to this repo in the `/docs/miner-documentation` folder.

2. Another PR to merge the docs from `/docs/miner-documentation` with the existing docs in `/docs` and convert them into the git book format.

يا @ krasi-georgiev. العلاقات العامة أعلاه (# 298) ستفعل ذلك.
أيضًا ، تحققت من repo-sync/repo-sync . أخشى أن يكون هذا لمزامنة مستودعين مع تاريخ الالتزام المشترك. سأرسل PR آخر لمعالجة مزامنة المجلد التي نحتاجها هنا!

شكرًا ، ما الذي يدور في ذهنك للمزامنة التلقائية؟

أنا أختبر نموذج إجراء GitHub هذا الآن:
كل ساعة:
1. استنساخ https://github.com/tellor-io/telliot
2. قارن المجلد TellorDocs/miner-documentation بالمجلد telliot/docs باستخدام تجزئات md5.
3. في حالة وجود أي اختلافات -> تحديث TellorDocs/miner-documentation
4. ادفع التغييرات إلى TellorDocs repo

  1. ادفع التغييرات إلى TellorDocs repo

بدلاً من الدفع المباشر ، نريد فقط أن تفتح الأداة PR حتى نتمكن من رؤية التغييرات وسنوافق عليها ودمجها يدويًا.

بالمناسبة ، تذكرت للتو أن إحدى الكليات قامت بهذا السيناريو لشيء مشابه ، لذا ربما يمكنك تبني بعض المنطق من هناك.
https://github.com/prometheus/prometheus/blob/master/scripts/sync_repo_files.sh

شكرا على النصائح. لقد قدمت للتو علاقات عامة أخرى.

حالة المشكلة: 1. فتح 2. بدأ 3. تم الإرسال 4. تم


__العمل مقابل 14.0 TRB (361.72 USD @ $ 25.84 / TRB) تم تقديمه بواسطة _:


تم ذلك الآن

هل كانت هذه الصفحة مفيدة؟
0 / 5 - 0 التقييمات