mirror of
https://github.com/ynput/ayon-core.git
synced 2025-12-24 21:04:40 +01:00
client/#75 - Added Slack module documentation
This commit is contained in:
parent
841124e87c
commit
83d97df0db
4 changed files with 55 additions and 0 deletions
BIN
website/docs/assets/slack_project.png
Normal file
BIN
website/docs/assets/slack_project.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
BIN
website/docs/assets/slack_system.png
Normal file
BIN
website/docs/assets/slack_system.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
BIN
website/docs/assets/slack_token.png
Normal file
BIN
website/docs/assets/slack_token.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 125 KiB |
55
website/docs/module_slack.md
Normal file
55
website/docs/module_slack.md
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
---
|
||||
id: module_site_sync
|
||||
title: Slack Integration Administration
|
||||
sidebar_label: Slack
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
|
||||
This module allows configuring profiles(when to trigger, for which combination of task, host and family)
|
||||
and templates(could contain {} placeholder) to send notification to Slack channel(s)
|
||||
whenever configured asset type is published.
|
||||
|
||||
|
||||
## App installation
|
||||
|
||||
Slack application must be installed to company's Slack first.
|
||||
|
||||
Please locate `openpype/modules/slack/manifest.yml` file in deployed OpenPype installation and follow instruction at
|
||||
https://api.slack.com/reference/manifests#using
|
||||
|
||||
|
||||
## System Settings
|
||||
|
||||
To use notifications, *Slack Notifications* needs to be enabled globally in **OpenPype Settings/System/Modules/Slack Notifications**.
|
||||
|
||||

|
||||
|
||||
|
||||
## Project Settings
|
||||
|
||||
### Token
|
||||
Most important for module to work is to fill authentication token
|
||||
```Project settings > Slack > Publish plugins > Token```
|
||||
|
||||
This token should be available after installation of the app in the Slack dashboard.
|
||||
It is possible to create multiple tokens and configure different scopes for them.
|
||||
|
||||

|
||||
|
||||
### Profiles
|
||||
Profiles are used to select when to trigger notification. One or multiple profiles
|
||||
could be configured, `Families`, `Task names` (regex available), `Host names` and host combination is needed.
|
||||
|
||||
Eg. If I want to be notified when render is published from Maya, setting is:
|
||||
|
||||
- family: 'render'
|
||||
- host: 'Maya'
|
||||
|
||||
### Channel
|
||||
Message could be delivered to one or multiple channels, by default app allows Slack bot
|
||||
to send messages to 'public' channels (eg. bot doesn't need to join the channel first).
|
||||
|
||||

|
||||
Loading…
Add table
Add a link
Reference in a new issue