chore: improve info message and add to docs

DanielleMaywood · DanielleMaywood · commit 77d1803ba9e4 · 2024-11-19T10:25:51.000Z
diff --git a/cli/server.go b/cli/server.go
@@ -928,7 +928,7 @@ func (r *RootCmd) Server(newAPI func(context.Context, *coderd.Options) (*coderd.
 				notificationReportGenerator := reports.NewReportGenerator(ctx, logger.Named("notifications.report_generator"), options.Database, options.NotificationsEnqueuer, quartz.NewReal())
 				defer notificationReportGenerator.Close()
 			} else {
-				logger.Info(ctx, "notifications disabled as there are no notification methods configured")
+				cliui.Info(inv.Stdout, "Notifications are currently disabled as there are no configured delivery methods. See https://coder.com/docs/admin/monitoring/notifications#delivery-methods for more details.")
 			}
 
 			// Since errCh only has one buffered slot, all routines
diff --git a/docs/admin/monitoring/notifications/index.md b/docs/admin/monitoring/notifications/index.md
@@ -74,7 +74,8 @@ flags.
 Notifications can currently be delivered by either SMTP or webhook. Each message
 can only be delivered to one method, and this method is configured globally with
 [`CODER_NOTIFICATIONS_METHOD`](../../../reference/cli/server.md#--notifications-method)
-(default: `smtp`).
+(default: `smtp`). When there are no delivery methods configured, notifications
+will be disabled.
 
 Premium customers can configure which method to use for each of the supported
 [Events](#workspace-events); see the
@@ -89,11 +90,11 @@ existing one.
 
 **Server Settings:**
 
-| Required | CLI                 | Env                     | Type        | Description                               | Default       |
-| :------: | ------------------- | ----------------------- | ----------- | ----------------------------------------- | ------------- |
-|    ✔️    | `--email-from`      | `CODER_EMAIL_FROM`      | `string`    | The sender's address to use.              |               |
-|    ✔️    | `--email-smarthost` | `CODER_EMAIL_SMARTHOST` | `host:port` | The SMTP relay to send messages through.  | localhost:587 |
-|    ✔️    | `--email-hello`     | `CODER_EMAIL_HELLO`     | `string`    | The hostname identifying the SMTP server. | localhost     |
+| Required | CLI                 | Env                     | Type     | Description                               | Default   |
+| :------: | ------------------- | ----------------------- | -------- | ----------------------------------------- | --------- |
+|    ✔️    | `--email-from`      | `CODER_EMAIL_FROM`      | `string` | The sender's address to use.              |           |
+|    ✔️    | `--email-smarthost` | `CODER_EMAIL_SMARTHOST` | `string` | The SMTP relay to send messages           |
+|    ✔️    | `--email-hello`     | `CODER_EMAIL_HELLO`     | `string` | The hostname identifying the SMTP server. | localhost |
 
 **Authentication Settings:**
 

Original file line number	Diff line number	Diff line change
`@@ -928,7 +928,7 @@ func (r RootCmd) Server(newAPI func(context.Context, coderd.Options) (*coderd.`
`928`	`928`	`notificationReportGenerator := reports.NewReportGenerator(ctx, logger.Named("notifications.report_generator"), options.Database, options.NotificationsEnqueuer, quartz.NewReal())`
`929`	`929`	`defer notificationReportGenerator.Close()`
`930`	`930`	`} else {`
`931`		`- logger.Info(ctx, "notifications disabled as there are no notification methods configured")`
	`931`	`+ cliui.Info(inv.Stdout, "Notifications are currently disabled as there are no configured delivery methods. See https://coder.com/docs/admin/monitoring/notifications#delivery-methods for more details.")`
`932`	`932`	`}`
`933`	`933`
`934`	`934`	`// Since errCh only has one buffered slot, all routines`