mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-04 14:39: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>
62 lines
2.6 KiB
Plaintext
62 lines
2.6 KiB
Plaintext
---
|
|
title: "Slack Trigger"
|
|
description: "Trigger CrewAI crews directly from Slack using slash commands"
|
|
icon: "slack"
|
|
mode: "wide"
|
|
---
|
|
|
|
This guide explains how to start a crew directly from Slack using CrewAI triggers.
|
|
|
|
## Prerequisites
|
|
|
|
- CrewAI Slack trigger installed and connected to your Slack workspace
|
|
- At least one crew configured in CrewAI
|
|
|
|
## Setup Steps
|
|
|
|
<Steps>
|
|
<Step title="Ensure the CrewAI Slack trigger is set up">
|
|
In the CrewAI dashboard, navigate to the **Triggers** section.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/slack-integration.png" alt="CrewAI Slack Integration" />
|
|
</Frame>
|
|
|
|
Verify that Slack is listed and is connected.
|
|
</Step>
|
|
<Step title="Open your Slack channel">
|
|
- Navigate to the channel where you want to kickoff the crew.
|
|
- Type the slash command "**/kickoff**" to initiate the crew kickoff process.
|
|
- You should see a "**Kickoff crew**" appear as you type:
|
|
<Frame>
|
|
<img src="/images/enterprise/kickoff-slack-crew.png" alt="Kickoff crew" />
|
|
</Frame>
|
|
- Press Enter or select the "**Kickoff crew**" option. A dialog box titled "**Kickoff an AI Crew**" will appear.
|
|
</Step>
|
|
<Step title="Select the crew you want to start">
|
|
- In the dropdown menu labeled "**Select of the crews online:**", choose the crew you want to start.
|
|
- In the example below, "**prep-for-meeting**" is selected:
|
|
<Frame>
|
|
<img src="/images/enterprise/kickoff-slack-crew-dropdown.png" alt="Kickoff crew dropdown" />
|
|
</Frame>
|
|
- If your crew requires any inputs, click the "**Add Inputs**" button to provide them.
|
|
<Note>
|
|
The "**Add Inputs**" button is shown in the example above but is not yet clicked.
|
|
</Note>
|
|
</Step>
|
|
<Step title="Click Kickoff and wait for the crew to complete">
|
|
- Once you've selected the crew and added any necessary inputs, click "**Kickoff**" to start the crew.
|
|
<Frame>
|
|
<img src="/images/enterprise/kickoff-slack-crew-kickoff.png" alt="Kickoff crew" />
|
|
</Frame>
|
|
- The crew will start executing and you will see the results in the Slack channel.
|
|
<Frame>
|
|
<img src="/images/enterprise/kickoff-slack-crew-results.png" alt="Kickoff crew results" />
|
|
</Frame>
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Tips
|
|
|
|
- Make sure you have the necessary permissions to use the `/kickoff` command in your Slack workspace.
|
|
- If you don't see your desired crew in the dropdown, ensure it's properly configured and online in CrewAI. |