mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 06:59:23 +00:00
* 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>
92 lines
4.9 KiB
Plaintext
92 lines
4.9 KiB
Plaintext
---
|
|
title: "إدارة الفريق"
|
|
description: "تعلم كيفية دعوة وإدارة أعضاء الفريق في مؤسسة CrewAI AMP"
|
|
icon: "users"
|
|
mode: "wide"
|
|
---
|
|
|
|
بصفتك مسؤولاً عن حساب CrewAI AMP، يمكنك بسهولة دعوة أعضاء جدد للانضمام إلى مؤسستك. يرشدك هذا الدليل خلال العملية خطوة بخطوة.
|
|
|
|
## دعوة أعضاء الفريق
|
|
|
|
<Steps>
|
|
<Step title="الوصول إلى صفحة الإعدادات">
|
|
- سجّل الدخول إلى حساب CrewAI AMP - ابحث عن أيقونة الترس في
|
|
الزاوية العلوية اليمنى من لوحة التحكم - انقر على أيقونة الترس للوصول إلى
|
|
صفحة **Settings**:
|
|
<Frame caption="صفحة الإعدادات">
|
|
<img src="/images/enterprise/settings-page.png" alt="صفحة الإعدادات" />
|
|
</Frame>
|
|
</Step>
|
|
<Step title="الانتقال إلى قسم الأعضاء">
|
|
- في صفحة الإعدادات، سترى علامة تبويب `Members` - انقر على علامة تبويب `Members`
|
|
للوصول إلى صفحة **Members**:
|
|
<Frame caption="علامة تبويب الأعضاء">
|
|
<img src="/images/enterprise/members-tab.png" alt="علامة تبويب الأعضاء" />
|
|
</Frame>
|
|
</Step>
|
|
<Step title="دعوة أعضاء جدد">
|
|
- في قسم الأعضاء، سترى قائمة بالأعضاء الحاليين (بما فيهم
|
|
أنت) - حدد موقع حقل إدخال `Email` - أدخل عنوان البريد الإلكتروني للشخص
|
|
الذي تريد دعوته - انقر على زر `Invite` لإرسال الدعوة
|
|
</Step>
|
|
<Step title="التكرار حسب الحاجة">
|
|
- يمكنك تكرار هذه العملية لدعوة أعضاء فريق متعددين - سيتلقى كل عضو
|
|
مدعو دعوة عبر البريد الإلكتروني للانضمام إلى مؤسستك
|
|
</Step>
|
|
</Steps>
|
|
|
|
## إضافة الأدوار
|
|
|
|
يمكنك إضافة أدوار لأعضاء فريقك للتحكم في وصولهم إلى أجزاء مختلفة من المنصة.
|
|
|
|
<Steps>
|
|
<Step title="الوصول إلى صفحة الإعدادات">
|
|
- سجّل الدخول إلى حساب CrewAI AMP - ابحث عن أيقونة الترس في
|
|
الزاوية العلوية اليمنى من لوحة التحكم - انقر على أيقونة الترس للوصول إلى
|
|
صفحة **Settings**:
|
|
<Frame>
|
|
<img src="/images/enterprise/settings-page.png" alt="صفحة الإعدادات" />
|
|
</Frame>
|
|
</Step>
|
|
<Step title="الانتقال إلى قسم الأعضاء">
|
|
- في صفحة الإعدادات، سترى علامة تبويب `Roles` - انقر على علامة تبويب `Roles`
|
|
للوصول إلى صفحة **Roles**.
|
|
<Frame>
|
|
<img src="/images/enterprise/roles-tab.png" alt="علامة تبويب الأدوار" />
|
|
</Frame>
|
|
- انقر على زر `Add Role` لإضافة دور جديد. - أدخل
|
|
تفاصيل وصلاحيات الدور وانقر على زر `Create Role` لإنشاء
|
|
الدور.
|
|
<Frame>
|
|
<img src="/images/enterprise/add-role-modal.png" alt="نافذة إضافة الدور" />
|
|
</Frame>
|
|
</Step>
|
|
<Step title="إضافة أدوار للأعضاء">
|
|
- في قسم الأعضاء، سترى قائمة بالأعضاء الحاليين (بما فيهم
|
|
أنت)
|
|
<Frame>
|
|
<img
|
|
src="/images/enterprise/member-accepted-invitation.png"
|
|
alt="العضو قبل الدعوة"
|
|
/>
|
|
</Frame>
|
|
- بمجرد قبول العضو للدعوة، يمكنك إضافة دور
|
|
له. - عد إلى علامة تبويب `Roles` - انتقل إلى العضو الذي تريد إضافة
|
|
دور له وتحت عمود `Role`، انقر على القائمة المنسدلة - اختر الدور
|
|
الذي تريد إضافته للعضو - انقر على زر `Update` لحفظ الدور
|
|
<Frame>
|
|
<img src="/images/enterprise/assign-role.png" alt="إضافة دور للعضو" />
|
|
</Frame>
|
|
</Step>
|
|
</Steps>
|
|
|
|
## ملاحظات مهمة
|
|
|
|
- **صلاحيات المسؤول**: فقط المستخدمون ذوو الصلاحيات الإدارية يمكنهم دعوة أعضاء جدد
|
|
- **دقة البريد الإلكتروني**: تأكد من صحة عناوين البريد الإلكتروني لأعضاء فريقك
|
|
- **قبول الدعوة**: سيحتاج الأعضاء المدعوون لقبول الدعوة للانضمام إلى مؤسستك
|
|
- **إشعارات البريد الإلكتروني**: قد ترغب في إعلام أعضاء فريقك بالتحقق من بريدهم الإلكتروني (بما في ذلك مجلدات البريد غير المرغوب) للدعوة
|
|
|
|
باتباع هذه الخطوات، يمكنك بسهولة توسيع فريقك والتعاون بشكل أكثر فعالية داخل مؤسسة CrewAI AMP.
|