Skip to content

chore(docs): reduce noise of outdated experiment callout in notifications guide #16139

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 6 commits into from
Jan 22, 2025
Merged

chore(docs): reduce noise of outdated experiment callout in notifications guide #16139

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
49ea0e5
reduced noise of outdated experiment callout in notifications doc
stirby Jan 14, 2025
9902373
make{lint,fmt}
EdwardAngert Jan 15, 2025
78adb90
remove experiment links
stirby Jan 15, 2025
48da576
Merge remote-tracking branch 'origin/main' into docs-remove-notif-exp…
EdwardAngert Jan 21, 2025
3c1e96b
re-lint and fmt
EdwardAngert Jan 21, 2025
bec9b36
copy edit, link fix
EdwardAngert Jan 22, 2025
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
make{lint,fmt}
  • Loading branch information
@EdwardAngert
EdwardAngert committed Jan 15, 2025
commit 9902373f98c1a58b9dcc7a973695534eae8bd7e8
62 changes: 31 additions & 31 deletions docs/admin/monitoring/notifications/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,33 +154,33 @@ Here is an example payload for Coder's webhook notification:

```json
{
"_version": "1.0",
"msg_id": "88750cad-77d4-4663-8bc0-f46855f5019b",
"payload": {
"_version": "1.0",
"notification_name": "Workspace Deleted",
"user_id": "4ac34fcb-8155-44d5-8301-e3cd46e88b35",
"user_email": "danny@coder.com",
"user_name": "danny",
"user_username": "danny",
"actions": [
{
"label": "View workspaces",
"url": "https://et23ntkhpueak.pit-1.try.coder.app/workspaces"
},
{
"label": "View templates",
"url": "https://et23ntkhpueak.pit-1.try.coder.app/templates"
}
],
"labels": {
"initiator": "danny",
"name": "my-workspace",
"reason": "initiated by user"
}
},
"title": "Workspace \"my-workspace\" deleted",
"body": "Hi danny\n\nYour workspace my-workspace was deleted.\nThe specified reason was \"initiated by user (danny)\"."
"_version": "1.0",
"msg_id": "88750cad-77d4-4663-8bc0-f46855f5019b",
"payload": {
"_version": "1.0",
"notification_name": "Workspace Deleted",
"user_id": "4ac34fcb-8155-44d5-8301-e3cd46e88b35",
"user_email": "danny@coder.com",
"user_name": "danny",
"user_username": "danny",
"actions": [
{
"label": "View workspaces",
"url": "https://et23ntkhpueak.pit-1.try.coder.app/workspaces"
},
{
"label": "View templates",
"url": "https://et23ntkhpueak.pit-1.try.coder.app/templates"
}
],
"labels": {
"initiator": "danny",
"name": "my-workspace",
"reason": "initiated by user"
}
},
"title": "Workspace \"my-workspace\" deleted",
"body": "Hi danny\n\nYour workspace my-workspace was deleted.\nThe specified reason was \"initiated by user (danny)\"."
}
```

Expand Down Expand Up @@ -250,13 +250,13 @@ To resume sending notifications, execute
If notifications are not being delivered, use the following methods to
troubleshoot:

1. Ensure notifications are being added to the `notification_messages` table
2. Review any error messages in the `status_reason` column, should an error
1. Ensure notifications are being added to the `notification_messages` table
2. Review any error messages in the `status_reason` column, should an error
have occurred
3. Review the logs (search for the term `notifications`) for diagnostic
3. Review the logs (search for the term `notifications`) for diagnostic
information<br> _If you do not see any relevant logs, set
`CODER_VERBOSE=true` or `--verbose` to output debug logs_
4. If you are on version 2.15.x, notifications must be enabled using the
4. If you are on version 2.15.x, notifications must be enabled using the
`notifications`
[experiment](https://coder.com/docs/contributing/feature-stages#experimental-features).
Notifications are enabled by default starting in v2.16.0.
Expand Down
Loading