Skip to content

docs: clarify notifiers and alerts#3736

Merged
EtienneM merged 1 commit intomasterfrom
feat/notifiers-events-discoverability
May 5, 2026
Merged

docs: clarify notifiers and alerts#3736
EtienneM merged 1 commit intomasterfrom
feat/notifiers-events-discoverability

Conversation

@benjaminach
Copy link
Copy Markdown
Contributor

@benjaminach benjaminach commented May 4, 2026

Summary

  • rename the app notifications page to App Notifiers and redirect the old URL
  • clarify the vocabulary around events, event types, notifiers, notifications, and alerts
  • improve cross-linking between app notifiers, alerts, metrics, and related event monitoring pages

Ideally, this PR should be updated after https://github.com/Scalingo/api/pull/3293 is merged.

@benjaminach benjaminach changed the title docs(app): clarify notifiers and alerts docs: clarify notifiers and alerts May 4, 2026
@benjaminach benjaminach requested review from EtienneM and Frzk May 4, 2026 15:50
Copy link
Copy Markdown
Member

@EtienneM EtienneM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a suggestion, otherwise LGTM

Comment thread src/_posts/platform/app/2000-01-01-alerts.md Outdated
@benjaminach benjaminach marked this pull request as ready for review May 5, 2026 08:28
Comment thread src/_posts/platform/app/2000-01-01-alerts.md Outdated
Comment thread src/_posts/platform/app/2000-01-01-alerts.md Outdated
Comment thread src/_posts/platform/app/2000-01-01-alerts.md Outdated
| --------------------- | --------------- | ---------------------------- |
| `alert_added` | Alert Added | An alert has been configured |
| `alert_deleted` | Alert Deleted | An alert has been deleted |
| `app_alert_triggered` | Alert triggered | An alert was triggered |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An alert was triggerd

question: Shouldn't we also use "An alert has been triggered"?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I saw that too, and that's the current wording in the admin, so I have chosen to leave it that way since we should rework the notifier description as a whole.

@EtienneM EtienneM force-pushed the feat/notifiers-events-discoverability branch from c78f01b to 16ea8f0 Compare May 5, 2026 12:26
@EtienneM EtienneM merged commit 65fdedb into master May 5, 2026
4 checks passed
@EtienneM EtienneM deleted the feat/notifiers-events-discoverability branch May 5, 2026 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants