Skip to content

Commit 5ee9074

Browse files
committed
Move notifications to monitoring
* Relocate the notifications page under the monitoring section. * Update relevant links and image paths. Changes: - Rename notifications.md to monitoring/notifications.md. - Adjust CLI reference links and image paths. - Update documentation manifest to reflect the new path.
1 parent 413ec60 commit 5ee9074

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ flags.
7474

7575
Notifications can currently be delivered by either SMTP or webhook. Each message
7676
can only be delivered to one method, and this method is configured globally with
77-
[`CODER_NOTIFICATIONS_METHOD`](https://coder.com/docs/reference/cli/server#--notifications-method)
77+
[`CODER_NOTIFICATIONS_METHOD`](../../reference/server#--notifications-method)
7878
(default: `smtp`).
7979

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

232-
![User Notification Preferences](../images/user-notification-preferences.png)
232+
![User Notification Preferences](../../images/user-notification-preferences.png)
233233

234234
## Delivery Preferences (enterprise)
235235

236236
Administrators can configure which delivery methods are used for each different
237237
[event type](#event-types).
238238

239-
![preferences](../images/admin/notification-admin-prefs.png)
239+
![preferences](../../images/admin/notification-admin-prefs.png)
240240

241241
You can find this page under
242242
`https://$CODER_ACCESS_URL/deployment/notifications?tab=events`.
@@ -247,10 +247,10 @@ Administrators may wish to stop _all_ notifications across the deployment. We
247247
support a killswitch in the CLI for these cases.
248248

249249
To pause sending notifications, execute
250-
[`coder notifications pause`](https://coder.com/docs/reference/cli/notifications_pause).
250+
[`coder notifications pause`](../../reference/cli/notifications_pause).
251251

252252
To resume sending notifications, execute
253-
[`coder notifications resume`](https://coder.com/docs/reference/cli/notifications_resume).
253+
[`coder notifications resume`](../../reference/cli/notifications_resume).
254254

255255
## Troubleshooting
256256

@@ -277,7 +277,7 @@ Messages older than 7 days are deleted.
277277

278278
### Message States
279279

280-
![states](../images/admin/notification-states.png)
280+
![states](../../images/admin/notification-states.png)
281281

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

docs/manifest.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -440,6 +440,12 @@
440440
"title": "Health Check",
441441
"description": "Learn about Coder's automated health checks",
442442
"path": "./admin/monitoring/health-check.md"
443+
},
444+
{
445+
"title": "Notifications",
446+
"description": "Configure notifications for your deployment",
447+
"path": "./admin/monitoring/notifications.md",
448+
"icon_path": "./images/icons/info.svg"
443449
}
444450
]
445451
},
@@ -466,12 +472,6 @@
466472
"description": "DIfferent ways to automate Coder actions and workflows",
467473
"path": "./admin/automation.md",
468474
"icon_path": "./images/icons/plug.svg"
469-
},
470-
{
471-
"title": "Notifications",
472-
"description": "Configure notifications for your deployment",
473-
"path": "./admin/notifications.md",
474-
"icon_path": "./images/icons/info.svg"
475475
}
476476
]
477477
},

0 commit comments

Comments
 (0)