diff --git a/docs.json b/docs.json index 7e738d5e6..57068d043 100644 --- a/docs.json +++ b/docs.json @@ -22,6 +22,7 @@ "index", "quickstart", "installation", + "slack-integration", { "group": "Web editor", "icon": "mouse-pointer-2", diff --git a/slack-integration.mdx b/slack-integration.mdx new file mode 100644 index 000000000..035d18f3a --- /dev/null +++ b/slack-integration.mdx @@ -0,0 +1,163 @@ +--- +title: "Slack integration" +description: "Install and use Mintlify's Slack integration to get documentation updates and notifications" +icon: "slack" +--- + +Mintlify's Slack integration keeps your team informed about documentation updates, build statuses, and deployment notifications directly in your Slack workspace. + + +**Prerequisites**: You need admin access to your Slack workspace and a Mintlify account with an active documentation project. + + +## Installing the Slack app + +Follow these steps to install the Mintlify Slack app in your workspace: + + + + 1. Navigate to your [Mintlify dashboard](https://dashboard.mintlify.com) + 2. Go to **Settings** in the left sidebar + 3. Select **Integrations** from the settings menu + 4. Find the **Slack** integration card + + + + 1. Click **Install Slack App** + 2. You'll be redirected to Slack's authorization page + 3. Select the workspace where you want to install the app + 4. Review the permissions and click **Allow** + + + + After installation, you'll be redirected back to your Mintlify dashboard where you can: + 1. Select which channels should receive notifications + 2. Choose the types of notifications you want to receive + 3. Test the integration with a sample notification + + + +## Configuring notifications + +The Slack integration supports several types of notifications: + +### Build notifications +Get notified when your documentation builds start, succeed, or fail: + +- **Build started**: Notification when a new build begins +- **Build succeeded**: Confirmation when builds complete successfully +- **Build failed**: Alerts when builds encounter errors with details + +### Deployment notifications +Stay informed about your documentation deployments: + +- **Deployment started**: When your docs begin deploying +- **Deployment completed**: Confirmation of successful deployments +- **Deployment failed**: Alerts for failed deployments with error details + +### Content updates +Track changes to your documentation content: + +- **New pages added**: Notifications when team members add new documentation pages +- **Pages updated**: Alerts when existing pages are modified +- **Pages deleted**: Notifications when pages are removed + +## Using Slack commands + +Once installed, you can use these Slack commands to interact with your documentation: + +### `/mintlify status` +Check the current status of your documentation builds and deployments. + +``` +/mintlify status +``` + +### `/mintlify deploy` +Trigger a manual deployment of your documentation (requires appropriate permissions). + +``` +/mintlify deploy +``` + +### `/mintlify help` +Get a list of available commands and their usage. + +``` +/mintlify help +``` + +## Managing permissions + +Control who can use Mintlify commands in your Slack workspace: + + + + 1. In Slack, go to **Settings & administration** > **Manage apps** + 2. Find **Mintlify** in your installed apps + 3. Click on the app to access its settings + + + + 1. Go to the **Permissions** tab + 2. Set which users or user groups can: + - Trigger deployments + - View build status + - Receive notifications + 3. Save your changes + + + +## Customizing notification channels + +You can send different types of notifications to different channels: + +1. **Development channel**: Build status and deployment notifications +2. **General team channel**: New page notifications and major updates +3. **Admin channel**: Error alerts and system notifications + +To configure channel-specific notifications: + +1. Go to your Mintlify dashboard **Settings** > **Integrations** > **Slack** +2. Click **Manage Channels** +3. For each notification type, select the appropriate channel +4. Save your configuration + +## Troubleshooting + + + + **Solution**: Ensure you have admin permissions in your Slack workspace. If you're not an admin, ask a workspace admin to install the app or grant you the necessary permissions. + + + + **Solution**: + 1. Check that the Mintlify app has permission to post in your selected channels + 2. Verify your notification settings in the Mintlify dashboard + 3. Ensure the channels you selected still exist and the app is a member + + + + **Solution**: + 1. Make sure you're using the correct command syntax + 2. Verify you have the necessary permissions to use the command + 3. Try reinstalling the app if commands consistently fail + + + + **Solution**: Check if you have multiple notification rules set up for the same events. Remove duplicate configurations in your dashboard settings. + + + +## Uninstalling the integration + +If you need to remove the Slack integration: + +1. In your Mintlify dashboard, go to **Settings** > **Integrations** > **Slack** +2. Click **Disconnect Slack** +3. Confirm the disconnection +4. Optionally, remove the app from your Slack workspace by going to **Settings & administration** > **Manage apps** > **Mintlify** > **Remove** + + +Uninstalling the integration will stop all notifications and disable Slack commands. This action cannot be undone, but you can reinstall the integration at any time. + \ No newline at end of file