Skip to content

docs: document Slack notifications for workflows #5877

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −0
Open

docs: document Slack notifications for workflows #5877

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions workflows/enable.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,25 @@

#### Run a translation immediately

After saving the workflow, click **Translate now** to run it on demand using the currently saved target languages. The workflow must be enabled to trigger a manual run. Manual runs do not affect the workflow's regular trigger.

Check warning on line 75 in workflows/enable.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/enable.mdx#L75 

In general, use active voice instead of passive voice ('be enabled').

## Slack notifications

Connect Slack to get updates about your workflows in the channels of your choice. After Slack is connected, the selected channels receive a message when:

Check warning on line 79 in workflows/enable.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/enable.mdx#L79 

In general, use active voice instead of passive voice ('is connected').

- A workflow opens a pull request for review.
- A workflow's pull request merges.
- A workflow's pull request has been waiting for review for 3 days.

The 3-day reminder helps surface stale reviews so that documentation changes don't sit unmerged.

Check warning on line 85 in workflows/enable.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/enable.mdx#L85 

Did you really mean 'unmerged'?

### Configure Slack notification channels

1. Open the [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) page in your dashboard.
2. Open the global Slack notification settings.
3. If Slack is not already connected, click **Connect Slack** and follow the prompts to install the Mintlify Slack app.
4. Under **Notification channels**, search for and select one or more channels to receive workflow notifications.

Selected channels apply to every workflow in the project. Invite the Mintlify Slack app to any private channels you select so it can post messages.

<GitlabWorkflowSetup />
Loading