Skip to content
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.

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

chore: update docs for new alerts and reporting feature #13104

Merged
merged 18 commits into from
Feb 26, 2021
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
docs: fix lists indent
  • Loading branch information
Valentin NOURDIN committed Feb 19, 2021
commit e859bbef9b5ed42337ed393f635951540e0768fc
11 changes: 6 additions & 5 deletions docs/src/pages/docs/installation/alerts_reports.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

---
name: Alerts and Reports
menu: Installation and Configuration
Expand All @@ -24,21 +25,21 @@ Alerts and reports are disabled by default. To turn them on, you need to do some
- `"ALERT_REPORTS"` feature flag must be turned to True.
- `CELERYBEAT_SCHEDULE` in CeleryConfig must contain schedule for `reports.scheduler`.
- At least one of those must be configured, depending on what you want to use:
- emails: `SMTP_*` settings
- Slack messages: `SLACK_API_TOKEN`
- emails: `SMTP_*` settings
- Slack messages: `SLACK_API_TOKEN`

##### In your `Dockerfile`
- You must install a headless browser, for taking screenshots of the charts and dashboards. Only Firefox and Chrome are currently supported.
>If you choose Chrome, you must also change the value of `WEBDRIVER_TYPE` to `"chrome"` in your `superset_config.py`.
> If you choose Chrome, you must also change the value of `WEBDRIVER_TYPE` to `"chrome"` in your `superset_config.py`.

#### Slack integration
To send alerts and reports to Slack channels, you need to create a new Slack Application on your workspace.

1. Connect to your Slack workspace, then head to https://api.slack.com/apps.
2. Create a new app.
3. Go to "OAuth & Permissions" section, and give the following scopes to your app:
1. `incoming-webhook`
2. `files:write`
- `incoming-webhook`
- `files:write`
4. At the top of the "OAuth and Permissions" section, click "install to workspace".
5. Select a default channel for your app and continue.
(You can post to any channel by inviting your Superset app into that channel).
Expand Down