Skip to content

docs: add documentation for notifications feature #14478

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.

Sign up for GitHub

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

Merged
merged 9 commits into from
Aug 30, 2024
Merged

docs: add documentation for notifications feature #14478

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ff2f78f
WIP
dannykopping Aug 29, 2024
a59e970
minor link additions, started user preferences
stirby Aug 29, 2024
3051cc0
make fmt
stirby Aug 29, 2024
0fb1fc0
added release verison to experimental warning
stirby Aug 29, 2024
b708488
Minor tweaks
dannykopping Aug 30, 2024
ebbba0e
make gen
dannykopping Aug 30, 2024
b2b6cd0
Excluding password field from config test
dannykopping Aug 30, 2024
8929c89
Merge branch 'main' of github.com:coder/coder into dk/notification-docs
dannykopping Aug 30, 2024
6a6b903
Remove release link
dannykopping Aug 30, 2024
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
Minor tweaks 
Signed-off-by: Danny Kopping <danny@coder.com>
  • Loading branch information
@dannykopping
dannykopping committed Aug 30, 2024
commit b708488ae1d81da8930c765e447e653408bea73f
1 change: 0 additions & 1 deletion codersdk/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2422,7 +2422,6 @@ Write out the current server config as YAML to stdout.`,
Annotations: serpent.Annotations{}.Mark(annotationSecretKey, "true"),
Value: &c.Notifications.SMTP.Auth.Password,
Group: &deploymentGroupNotificationsEmailAuth,
YAML: "password",
},
{
Name: "Notifications: Email Auth: Password File",
Expand Down
6 changes: 3 additions & 3 deletions docs/admin/notifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ $ CODER_EXPERIMENTS=notifications coder server
```

More information on experiments can be found
[here](/docs/contributing/feature-stages#experimental-features).
[here](https://coder.com/docs/contributing/feature-stages#experimental-features).

## Event Types

Expand Down Expand Up @@ -82,7 +82,7 @@ Enterprise customers can configured which method to use for each of the
supported [Events](#events); see the [Preferences](#preferences) section below
for more details.

## SMTP
## SMTP (Email)

Use the `smtp` method to deliver notifications by email to your users. Coder
does not ship with an SMTP server, so you will need to configure Coder to use an
Expand Down Expand Up @@ -230,7 +230,7 @@ All users have the option to opt-out of any notifications. Go to **Account** ->
**Notifications** to turn notifications on or off. The delivery method for each
notification is indicated on the right hand side of this table.

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

## Delivery Preferences (enterprise)

Expand Down
0 .../images/user-notification-preferences.PNG → .../images/user-notification-preferences.png
View file
Open in desktop
File renamed without changes
Loading