mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 06:59:23 +00:00
a237ebabba
* feat: adopt directory-based docs versioning with Edge channel Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
106 lines
4.2 KiB
Plaintext
106 lines
4.2 KiB
Plaintext
---
|
|
title: "مشغل Zapier"
|
|
description: "تشغيل أطقم CrewAI من سير عمل Zapier لأتمتة سير العمل عبر التطبيقات"
|
|
icon: "bolt"
|
|
mode: "wide"
|
|
---
|
|
|
|
سيرشدك هذا الدليل خلال عملية إعداد مشغلات Zapier لـ CrewAI AMP، مما يتيح لك أتمتة سير العمل بين CrewAI AMP والتطبيقات الأخرى.
|
|
|
|
## المتطلبات الأساسية
|
|
|
|
- حساب CrewAI AMP
|
|
- حساب Zapier
|
|
- حساب Slack (لهذا المثال المحدد)
|
|
|
|
## الإعداد خطوة بخطوة
|
|
|
|
<Steps>
|
|
<Step title="إعداد مشغل Slack">
|
|
- في Zapier، أنشئ Zap جديدًا.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-1.png" alt="Zapier 1" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
<Step title="اختر Slack كتطبيق المشغل">
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-2.png" alt="Zapier 2" />
|
|
</Frame>
|
|
- اختر `New Pushed Message` كحدث المشغل.
|
|
- اربط حساب Slack الخاص بك إذا لم تفعل ذلك بالفعل.
|
|
</Step>
|
|
|
|
<Step title="تكوين إجراء CrewAI AMP">
|
|
- أضف خطوة إجراء جديدة إلى Zap الخاص بك.
|
|
- اختر CrewAI+ كتطبيق الإجراء وKickoff كحدث الإجراء
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-3.png" alt="Zapier 5" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
<Step title="ربط حساب CrewAI AMP">
|
|
- اربط حساب CrewAI AMP الخاص بك.
|
|
- اختر الطاقم المناسب لسير عملك.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-4.png" alt="Zapier 6" />
|
|
</Frame>
|
|
- كوّن مدخلات الطاقم باستخدام البيانات من رسالة Slack.
|
|
</Step>
|
|
|
|
<Step title="تنسيق مخرجات CrewAI AMP">
|
|
- أضف خطوة إجراء أخرى لتنسيق مخرجات النص من CrewAI AMP.
|
|
- استخدم أدوات التنسيق في Zapier لتحويل مخرجات Markdown إلى HTML.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-5.png" alt="Zapier 8" />
|
|
</Frame>
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-6.png" alt="Zapier 9" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
<Step title="إرسال المخرجات عبر البريد الإلكتروني">
|
|
- أضف خطوة إجراء نهائية لإرسال المخرجات المنسقة عبر البريد الإلكتروني.
|
|
- اختر خدمة البريد الإلكتروني المفضلة لديك (مثال: Gmail، Outlook).
|
|
- كوّن تفاصيل البريد الإلكتروني، بما في ذلك المستلم والموضوع والنص.
|
|
- أدرج مخرجات CrewAI AMP المنسقة في نص البريد الإلكتروني.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-7.png" alt="Zapier 7" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
<Step title="بدء تشغيل الطاقم من Slack">
|
|
- أدخل النص في قناة Slack الخاصة بك
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-7b.png" alt="Zapier 10" />
|
|
</Frame>
|
|
|
|
- اختر زر النقاط الثلاث ثم اختر Push to Zapier
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-8.png" alt="Zapier 11" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
<Step title="اختر الطاقم ثم اضغط Push للبدء">
|
|
<Frame>
|
|
<img src="/images/enterprise/zapier-9.png" alt="Zapier 12" />
|
|
</Frame>
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
## نصائح للنجاح
|
|
|
|
- تأكد من أن مدخلات CrewAI AMP مربوطة بشكل صحيح من رسالة Slack.
|
|
- اختبر Zap الخاص بك جيدًا قبل تفعيله لاكتشاف أي مشاكل محتملة.
|
|
- فكر في إضافة خطوات معالجة الأخطاء لإدارة حالات الفشل المحتملة في سير العمل.
|
|
|
|
باتباع هذه الخطوات، ستكون قد أعددت بنجاح مشغلات Zapier لـ CrewAI AMP، مما يتيح سير عمل آلي يتم تشغيله بواسطة رسائل Slack وينتج عنه إشعارات بالبريد الإلكتروني مع مخرجات CrewAI AMP.
|