mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-22 07:15:10 +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>
107 lines
4.1 KiB
Plaintext
107 lines
4.1 KiB
Plaintext
---
|
|
title: "Gestão de Equipes"
|
|
description: "Aprenda como convidar e gerenciar membros da equipe em sua organização CrewAI AMP"
|
|
icon: "users"
|
|
mode: "wide"
|
|
---
|
|
|
|
Como administrador de uma conta CrewAI AMP, você pode facilmente convidar novos membros para sua organização. Este guia irá orientá-lo passo a passo pelo processo.
|
|
|
|
## Convidando Membros da Equipe
|
|
|
|
<Steps>
|
|
<Step title="Acesse a Página de Configurações">
|
|
- Faça login na sua conta CrewAI AMP - Procure o ícone de engrenagem (⚙️) no
|
|
canto superior direito do painel - Clique no ícone de engrenagem para
|
|
acessar a página de **Configurações**:
|
|
<Frame>
|
|
<img
|
|
src="/images/enterprise/settings-page.png"
|
|
alt="Página de Configurações"
|
|
/>
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Navegue até a Seção de Membros">
|
|
- Na página de Configurações, você verá a aba `Members` - Clique na aba
|
|
`Members` para acessar a página de **Membros**:
|
|
<Frame>
|
|
<img src="/images/enterprise/members-tab.png" alt="Aba Membros" />
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Convidar Novos Membros">
|
|
- Na seção de Membros, você verá uma lista dos membros atuais (incluindo
|
|
você) - Localize o campo de entrada `Email` - Digite o endereço de e-mail da
|
|
pessoa que você deseja convidar - Clique no botão `Invite` para enviar o
|
|
convite
|
|
</Step>
|
|
<Step title="Repita Conforme Necessário">
|
|
- Você pode repetir esse processo para convidar vários membros da equipe -
|
|
Cada membro convidado receberá um convite por e-mail para ingressar na sua
|
|
organização
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Adicionando Funções
|
|
|
|
Você pode adicionar funções aos membros da equipe para controlar o acesso a diferentes partes da plataforma.
|
|
|
|
<Steps>
|
|
<Step title="Acesse a Página de Configurações">
|
|
- Faça login na sua conta CrewAI AMP - Procure o ícone de engrenagem (⚙️) no
|
|
canto superior direito do painel - Clique no ícone de engrenagem para
|
|
acessar a página de **Configurações**:
|
|
<Frame>
|
|
<img
|
|
src="/images/enterprise/settings-page.png"
|
|
alt="Página de Configurações"
|
|
/>
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Navegue até a Seção de Funções">
|
|
- Na página de Configurações, você verá a aba `Roles` - Clique na aba
|
|
`Roles` para acessar a página de **Funções**.
|
|
<Frame>
|
|
<img src="/images/enterprise/roles-tab.png" alt="Aba Funções" />
|
|
</Frame>
|
|
- Clique no botão `Add Role` para adicionar uma nova função. -
|
|
Insira os detalhes e as permissões da função e clique no botão `Create Role`
|
|
para criar a função.
|
|
<Frame>
|
|
<img
|
|
src="/images/enterprise/add-role-modal.png"
|
|
alt="Modal Adicionar Função"
|
|
/>
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Adicionar Funções aos Membros">
|
|
- Na seção de Membros, você verá uma lista dos membros atuais (incluindo
|
|
você)
|
|
<Frame>
|
|
<img
|
|
src="/images/enterprise/member-accepted-invitation.png"
|
|
alt="Membro Aceitou Convite"
|
|
/>
|
|
</Frame>
|
|
- Após o membro aceitar o convite, você poderá adicionar uma função
|
|
a ele. - Volte para a aba `Roles` - Vá até o membro ao qual deseja adicionar
|
|
uma função e, na coluna `Role`, clique no menu suspenso - Selecione a função
|
|
que deseja atribuir ao membro - Clique no botão `Update` para salvar a
|
|
função
|
|
<Frame>
|
|
<img
|
|
src="/images/enterprise/assign-role.png"
|
|
alt="Adicionar Função ao Membro"
|
|
/>
|
|
</Frame>
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Notas Importantes
|
|
|
|
- **Privilégios de Administrador**: Apenas usuários com privilégios administrativos podem convidar novos membros
|
|
- **Precisão do E-mail**: Certifique-se de que você tem os endereços de e-mail corretos dos membros da equipe
|
|
- **Aceite do Convite**: Os membros convidados precisarão aceitar o convite para ingressar na sua organização
|
|
- **Notificações por E-mail**: Oriente seus membros a verificarem o e-mail (incluindo a pasta de spam) para localizar o convite
|
|
|
|
Seguindo estes passos, você conseguirá expandir sua equipe e colaborar de forma mais eficaz dentro da sua organização CrewAI AMP.
|