مكان وجود الوثائق
- المستودع:
ClickHouse/ClickHouse(docs/في هذه الشجرة) - التنسيق: MDX، ومبني باستخدام Mintlify
- الموقع:
docs/integrations/<category>/<your-integration>/، حيث يعكس<category>وظيفة منتجك (data-visualizationوdata-ingestionوlanguage-clientsوما إلى ذلك) - العملية: افتح طلب سحب على
master. يراجع فريق التكاملات في ClickHouse الطلب. ويوقّع المساهمون لأول مرة على اتفاقية ترخيص المساهم عندما يطلب البوت ذلك في طلب السحب. راجع دليل المساهمة في الوثائق للمعاينة المحلية (mint devمنdocs/)
اختيار فئة
الأقسام المطلوبة
- الغرض. ما المشكلة التي يحلّها هذا التكامل، في جملتين أو ثلاث. تجنّب الصياغة التسويقية. فالقراء يكونون عادةً مهندسين يقيّمون الإعداد
- المتطلبات المسبقة ومصفوفة الإصدارات المدعومة. ما الذي يحتاج المستخدم إلى تثبيته، وما الإصدارات التي تدعمونها لكلٍ من ClickHouse Cloud وذاتي الاستضافة (مفتوح المصدر). ويُفضَّل هنا استخدام جدول صغير
- دليل الإعداد. تعليمات خطوة بخطوة للوصول إلى connection يعمل، مع عرضٍ متوازٍ لكل من Cloud وذاتي الاستضافة حيث توجد اختلافات (المضيف، المنفذ، TLS)
- المصادقة. ما أوضاع authentication التي تدعمونها (اسم المستخدم وكلمة المرور عبر TLS كحدٍّ أدنى، بالإضافة إلى mTLS، وشهادة عميل SSL، وملاحظات قائمة السماح لعناوين IP عند الاقتضاء)
- مثال شامل من البداية إلى النهاية. قدّم مثالًا واقعيًا واحدًا على الأقل يبدأ من connection وينتهي بنتيجة مفيدة. استخدم example dataset في ClickHouse حتى يتمكن القراء من إعادة تطبيقه
- القيود المعروفة وخصائص الأداء. فجوات نظام الأنواع، وحدود result-set، وملاحظات throughput، والميزات غير المدعومة. الصراحة هنا توفّر دورات دعم
- Troubleshooting. الأخطاء الشائعة وطرق حلّها. تكفي حالتان أو ثلاث من أكثر الحالات شيوعًا في الإصدار الأول
ملاحظات الأسلوب
- اعرض كلاً من Cloud وذاتي الاستضافة. يستخدم Cloud عادةً HTTPS على المنفذ
8443وnative TCP على9440. وتكون المنافذ الافتراضية في ذاتي الاستضافة هي8123و9000 - استخدم تنبيهات Mintlify (
<Note>,<Warning>,<Tip>) للملاحظات الجانبية بدلاً من الفقرات الغامقة - أضف روابط لمزيد من التفصيل. اربط بالوثائق الحالية لأنواع البيانات والتنسيقات وJDBC وClickPipes والموضوعات المشابهة بدلاً من إعادة شرحها
- من دون تسويق. صفحات التكامل هنا هي مرجع تقني. يجب أن يكون المحتوى الترويجي على موقعك؛ ويمكننا وضع رابط إليه من دليل الشركاء
قالب جاهز للنسخ واللصق
docs/integrations/<category>/<your-integration>/index.mdx، ثم افتح PR.