Skip to content

Commit

Permalink
docs: Updates instructions for slack config variables
Browse files Browse the repository at this point in the history
  • Loading branch information
widal001 committed Nov 4, 2024
1 parent a7eac71 commit 67192c3
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions documentation/analytics/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ After choosing your approach, following the corresponding setup instructions:
- Add `export GH_TOKEN=...` to your `zshrc` or similar
3. Set the slackbot token and the channel ID for Slack after following the instructions in [configuring secrets](#configuring-secrets). **Note:** replace the `...` with the value of these secrets:
```
export SLACK_BOT_TOKEN=...
export REPORTING_CHANNEL_ID=...
export ANALYTICS_SLACK_BOT_TOKEN=...
export ANALYTICS_REPORTING_CHANNEL_ID=...
```
4. Run `make test-audit` to confirm the application is running correctly.

Expand All @@ -86,8 +86,8 @@ After choosing your approach, following the corresponding setup instructions:
- Add `export GH_TOKEN=...` to your `zshrc` or similar
3. Set the slackbot token and the channel ID for Slack after following the instructions in [configuring secrets](#configuring-secrets). **Note:** replace the `...` with the value of these secrets:
```
export SLACK_BOT_TOKEN=...
export REPORTING_CHANNEL_ID=...
export ANALYTICS_SLACK_BOT_TOKEN=...
export ANALYTICS_REPORTING_CHANNEL_ID=...
```
4. Run `make test-audit` to confirm the application is running correctly.

Expand Down
4 changes: 2 additions & 2 deletions documentation/analytics/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,8 @@ A couple of important notes about this command:
You can also post the results of this metric to a Slack channel:

> [!NOTE] You must have the following environment variables set to post to Slack:
> - `SLACK_BOT_TOKEN` the OAuth token for a slackbot installed in your workspace
> - `REPORTING_CHANNEL_ID` the id of the channel you want to post to in Slack.
> - `ANALYTICS_SLACK_BOT_TOKEN` the OAuth token for a slackbot installed in your workspace
> - `ANALYTICS_REPORTING_CHANNEL_ID` the id of the channel you want to post to in Slack.
>
> For more information about setting up these variables see the [installation guide](development.md#configuring-secrets)
Expand Down

0 comments on commit 67192c3

Please sign in to comment.