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
3.7 KiB
Plaintext
92 lines
3.7 KiB
Plaintext
---
|
|
title: "Team Management"
|
|
description: "Learn how to invite and manage team members in your CrewAI AMP organization"
|
|
icon: "users"
|
|
mode: "wide"
|
|
---
|
|
|
|
As an administrator of a CrewAI AMP account, you can easily invite new team members to join your organization. This guide will walk you through the process step-by-step.
|
|
|
|
## Inviting Team Members
|
|
|
|
<Steps>
|
|
<Step title="Access the Settings Page">
|
|
- Log in to your CrewAI AMP account - Look for the gear icon (⚙️) in the top
|
|
right corner of the dashboard - Click on the gear icon to access the
|
|
**Settings** page:
|
|
<Frame caption="Settings page">
|
|
<img src="/images/enterprise/settings-page.png" alt="Settings Page" />
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Navigate to the Members Section">
|
|
- On the Settings page, you'll see a `Members` tab - Click on the `Members`
|
|
tab to access the **Members** page:
|
|
<Frame caption="Members tab">
|
|
<img src="/images/enterprise/members-tab.png" alt="Members Tab" />
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Invite New Members">
|
|
- In the Members section, you'll see a list of current members (including
|
|
yourself) - Locate the `Email` input field - Enter the email address of the
|
|
person you want to invite - Click the `Invite` button to send the invitation
|
|
</Step>
|
|
<Step title="Repeat as Needed">
|
|
- You can repeat this process to invite multiple team members - Each invited
|
|
member will receive an email invitation to join your organization
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Adding Roles
|
|
|
|
You can add roles to your team members to control their access to different parts of the platform.
|
|
|
|
<Steps>
|
|
<Step title="Access the Settings Page">
|
|
- Log in to your CrewAI AMP account - Look for the gear icon (⚙️) in the top
|
|
right corner of the dashboard - Click on the gear icon to access the
|
|
**Settings** page:
|
|
<Frame>
|
|
<img src="/images/enterprise/settings-page.png" alt="Settings Page" />
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Navigate to the Members Section">
|
|
- On the Settings page, you'll see a `Roles` tab - Click on the `Roles` tab
|
|
to access the **Roles** page.
|
|
<Frame>
|
|
<img src="/images/enterprise/roles-tab.png" alt="Roles Tab" />
|
|
</Frame>
|
|
- Click on the `Add Role` button to add a new role. - Enter the
|
|
details and permissions of the role and click the `Create Role` button to
|
|
create the role.
|
|
<Frame>
|
|
<img src="/images/enterprise/add-role-modal.png" alt="Add Role Modal" />
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Add Roles to Members">
|
|
- In the Members section, you'll see a list of current members (including
|
|
yourself)
|
|
<Frame>
|
|
<img
|
|
src="/images/enterprise/member-accepted-invitation.png"
|
|
alt="Member Accepted Invitation"
|
|
/>
|
|
</Frame>
|
|
- Once the member has accepted the invitation, you can add a role to
|
|
them. - Navigate back to `Roles` tab - Go to the member you want to add a
|
|
role to and under the `Role` column, click on the dropdown - Select the role
|
|
you want to add to the member - Click the `Update` button to save the role
|
|
<Frame>
|
|
<img src="/images/enterprise/assign-role.png" alt="Add Role to Member" />
|
|
</Frame>
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Important Notes
|
|
|
|
- **Admin Privileges**: Only users with administrative privileges can invite new members
|
|
- **Email Accuracy**: Ensure you have the correct email addresses for your team members
|
|
- **Invitation Acceptance**: Invited members will need to accept the invitation to join your organization
|
|
- **Email Notifications**: You may want to inform your team members to check their email (including spam folders) for the invitation
|
|
|
|
By following these steps, you can easily expand your team and collaborate more effectively within your CrewAI AMP organization.
|