Skip to content

Commit 64cf961

Browse files
stirbystirby
committed
fixed notifications structure and experiment references
1 parent c1cb6cf commit 64cf961

File tree

7 files changed

+46
-34
lines changed

7 files changed

+46
-34
lines changed

‎docs/admin/monitoring/notifications.md renamed to ‎docs/admin/monitoring/notifications/README.md

+22-6
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,22 @@
33
Notifications are sent by Coder in response to specific internal events, such as
44
a workspace being deleted or a user being created.
55

6+
## Enable experiment
7+
8+
In order to activate the notifications feature on Coder v2.15.X, you'll need to enable the
9+
`notifications` experiment. Notifications are enabled by default starting in v2.16.0.
10+
11+
```bash
12+
# Using the CLI flag
13+
$ coder server --experiments=notifications
14+
15+
# Alternatively, using the `CODER_EXPERIMENTS` environment variable
16+
$ CODER_EXPERIMENTS=notifications coder server
17+
```
18+
19+
More information on experiments can be found
20+
[here](https://coder.com/docs/contributing/feature-stages#experimental-features).
21+
622
## Event Types
723

824
Notifications are sent in response to internal events, to alert the affected
@@ -56,7 +72,7 @@ flags.
5672

5773
Notifications can currently be delivered by either SMTP or webhook. Each message
5874
can only be delivered to one method, and this method is configured globally with
59-
[`CODER_NOTIFICATIONS_METHOD`](../../reference/server#--notifications-method)
75+
[`CODER_NOTIFICATIONS_METHOD`](../../../reference/cli/server#--notifications-method)
6076
(default: `smtp`).
6177

6278
Enterprise customers can configure which method to use for each of the supported
@@ -211,14 +227,14 @@ All users have the option to opt-out of any notifications. Go to **Account** ->
211227
**Notifications** to turn notifications on or off. The delivery method for each
212228
notification is indicated on the right hand side of this table.
213229

214-
![User Notification Preferences](../../images/user-notification-preferences.png)
230+
![User Notification Preferences](../../../images/admin/monitoring/notifications/user-notification-preferences.png)
215231

216232
## Delivery Preferences (enterprise)
217233

218234
Administrators can configure which delivery methods are used for each different
219235
[event type](#event-types).
220236

221-
![preferences](../../images/admin/notification-admin-prefs.png)
237+
![preferences](../../../images/admin/monitoring/notifications/notification-admin-prefs.png)
222238

223239
You can find this page under
224240
`https://$CODER_ACCESS_URL/deployment/notifications?tab=events`.
@@ -229,10 +245,10 @@ Administrators may wish to stop _all_ notifications across the deployment. We
229245
support a killswitch in the CLI for these cases.
230246

231247
To pause sending notifications, execute
232-
[`coder notifications pause`](../../reference/cli/notifications_pause).
248+
[`coder notifications pause`](../../../reference/cli/notifications_pause).
233249

234250
To resume sending notifications, execute
235-
[`coder notifications resume`](../../reference/cli/notifications_resume).
251+
[`coder notifications resume`](../../../reference/cli/notifications_resume).
236252

237253
## Troubleshooting
238254

@@ -259,7 +275,7 @@ Messages older than 7 days are deleted.
259275

260276
### Message States
261277

262-
![states](../../images/admin/notification-states.png)
278+
![states](../../../images/admin/monitoring/notifications/notification-states.png)
263279

264280
_A notifier here refers to a Coder replica which is responsible for dispatching
265281
the notification. All running replicas act as notifiers to process pending

‎docs/admin/notifications/slack.md renamed to ‎docs/admin/monitoring/notifications/slack.md

+5-8
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ consistent between Slack and their Coder login.
1717
Before setting up Slack notifications, ensure that you have the following:
1818

1919
- Administrator access to the Slack platform to create apps
20-
- Coder platform with
21-
[notifications enabled](../notifications#enable-experiment)
20+
- Coder platform v2.15.0 or greater with
21+
[notifications enabled](./README.md#enable-experiment) for versions <v2.16.0
2222

2323
## Create Slack Application
2424

@@ -192,12 +192,9 @@ must respond appropriately.
192192

193193
## Enable Webhook Integration in Coder
194194

195-
To enable webhook integration in Coder, ensure the "notifications" experiment is
196-
activated by running the following command:
197-
198-
```bash
199-
export CODER_EXPERIMENTS=notifications
200-
```
195+
To enable webhook integration in Coder, ensure the "notifications"
196+
[experiment is activated](./README.md#enable-experiment) (only required in
197+
v2.15.X).
201198

202199
Then, define the POST webhook endpoint matching the deployed Slack bot:
203200

‎docs/admin/notifications/teams.md renamed to ‎docs/admin/monitoring/notifications/teams.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Before setting up Microsoft Teams notifications, ensure that you have the
1515
following:
1616

1717
- Administrator access to the Teams platform
18-
- Coder platform with notifications enabled
18+
- Coder platform with [notifications enabled](./README.md#enable-experiment)
1919

2020
## Build Teams Workflow
2121

@@ -133,12 +133,9 @@ The process of setting up a Teams workflow consists of three key steps:
133133

134134
## Enable Webhook Integration
135135

136-
To enable webhook integration in Coder, ensure the "notifications" experiment is
137-
activated by running the following command:
138-
139-
```bash
140-
export CODER_EXPERIMENTS=notifications
141-
```
136+
To enable webhook integration in Coder, ensure the "notifications"
137+
[experiment is activated](./README.md#enable-experiment) (only required in
138+
v2.15.X).
142139

143140
Then, define the POST webhook endpoint created by your Teams workflow:
144141

‎docs/images/admin/notification-admin-prefs.png renamed to ‎docs/images/admin/monitoring/notifications/notification-admin-prefs.png

File renamed without changes.

‎docs/images/admin/notification-states.png renamed to ‎docs/images/admin/monitoring/notifications/notification-states.png

File renamed without changes.

‎docs/images/user-notification-preferences.png renamed to ‎docs/images/admin/monitoring/notifications/user-notification-preferences.png

File renamed without changes.

‎docs/manifest.json

+15-13
Original file line numberDiff line numberDiff line change
@@ -480,19 +480,21 @@
480480
{
481481
"title": "Notifications",
482482
"description": "Configure notifications for your deployment",
483-
"path": "./admin/monitoring/notifications.md"
484-
},
485-
{
486-
"title": "Slack Notifications",
487-
"description": "Learn how to setup Slack notifications",
488-
"path": "./admin/notifications/slack.md",
489-
"state": "beta"
490-
},
491-
{
492-
"title": "Microsoft Teams Notifications",
493-
"description": "Learn how to setup Microsoft Teams notifications",
494-
"path": "./admin/notifications/teams.md",
495-
"state": "beta"
483+
"path": "./admin/monitoring/notifications/README.md",
484+
"children": [
485+
{
486+
"title": "Slack Notifications",
487+
"description": "Learn how to setup Slack notifications",
488+
"path": "./admin/monitoring/notifications/slack.md",
489+
"state": "beta"
490+
},
491+
{
492+
"title": "Microsoft Teams Notifications",
493+
"description": "Learn how to setup Microsoft Teams notifications",
494+
"path": "./admin/monitoring/notifications/teams.md",
495+
"state": "beta"
496+
}
497+
]
496498
}
497499
]
498500
},

0 commit comments

Comments
 (0)