Commit a27718f
QUA-1518: Add PagerDuty feature (#1068)
* docs: restructure Notifications into per-channel sub-pages and update Alerting assets
- Remove monolithic flows/notification.md and notification-tokens.md
(content migrated to per-channel sub-pages)
- Add Notifications overview page and per-channel screenshots
(In App, Email, Slack, Microsoft Teams, PagerDuty)
- Rename alerting logos to TECHNOLOGY-logo.png pattern and
remove deprecated settings-light.png
- Rewrite Alerting Integrations Overview with centered logos
and standardized layout
- Update internal links in Slack and Teams integration pages
- Update mkdocs.yml navigation and add redirects for old paths
* docs: add PagerDuty integration documentation
- Add PagerDuty overview, deep dive, API, and FAQ pages
under Settings > Integrations > Alerting
- Add managing guides: add, edit, and remove integration
- Add PagerDuty screenshots for all managing workflows
- Add shared settings screenshot and PagerDuty logo
* docs: add Notification per-channel sub-pages
- Add Overview, API, and FAQ for each notification channel:
In App, Email, Slack, Microsoft Teams, and PagerDuty
- Add Message Variables page with channel-specific tokens
- Add general Notifications FAQ
- Update action overview links to new notification paths
* fix(mkdocs): change the deployment url
* docs: remove custom mermaid styles, centralize diagrams, and update navigation
Mermaid Diagrams:
- Remove custom fill/color/stroke styles from all 5 Notification
lifecycle diagrams (In App, Email, Slack, Microsoft Teams, PagerDuty)
to use mermaid default theme, which auto-adapts to light/dark mode
- Remove custom styles from Field Status Lifecycle diagrams
(User-Driven and Automatic Transitions) for consistency
- Wrap all Notification lifecycle diagrams in centered div containers
using md_in_html for visual alignment
Navigation:
- Move general Notifications FAQ below PagerDuty in mkdocs.yml sidebar
- Resolve mkdocs.yml merge conflict: combine Notification redirects
with new main branch redirects (source-datastore reorganization,
container operations, add-datastores, AI integrations, checks rename)
Alerting Overview:
- Remove Documentation column from Available Integrations table
(redundant with per-section "For more details" links)
- Remove Integration column links (redundant with section links)
* docs(notifications): enrich overview page with detailed content and structure
Expand the Notifications Overview from a minimal intro + channel table into a
comprehensive landing page following the established pattern used by Field Status,
Datastore Grouping, and AI & Agents overviews.
New sections added:
- Why Notifications Matter: explains the value of real-time alerts
- How Notifications Work: mermaid lifecycle diagram + 5-step processing flow
- Supported Triggers: table of all 6 trigger types with available variables
- Testing Notifications: describes test button behavior per channel
- Reference: links to Message Variables and FAQ
Also improves channel descriptions with specific details (Block Kit, Adaptive
Cards, severity levels, routing key overrides) and adds contextual guidance
throughout the page.
* docs(notifications): rename generic image files to descriptive names
Replace numbered/generic image filenames (notification-44.png, save-8.png,
test-52.png, etc.) with descriptive names that reflect what each image shows.
Update all markdown references across notification channel pages accordingly.
Renamed images per channel:
- Root: notification-44 → notification-channels
- In App: notification-45/46/47 → select-in-app, in-app-settings-panel,
in-app-message-variables
- Email: notification-49/50/51 → select-email, email-settings-panel,
email-settings-fields
- Microsoft Teams: notification-59/60/61 → select-microsoft-teams,
teams-settings-panel, teams-settings-fields
- PagerDuty: notification-64/65/67/68 → select-pagerduty,
pagerduty-settings-panel, severity-dropdown, pagerduty-message-variables
- All channels: save-8 → save-button, test-52 → test-notification-success
Also fix broken image path in PagerDuty integration overview
(removed extra `docs/` prefix from relative path).
* Add some tweaks
* Add pre-commit hook to alert warnings
---------
Co-authored-by: shindiogawa <rodrigo@qualytics.co>1 parent b6b2e1f commit a27718f
90 files changed
Lines changed: 2175 additions & 304 deletions
File tree
- docs
- assets
- flows/notifications
- email
- in-app
- microsoft-teams
- pagerduty
- slack
- integrations
- alerting
- pagerduty
- managing-pagerduty
- add-integration
- edit-integration
- remove-integration
- pagerduty-overview
- slack
- explore
- fields/field-status/concepts
- flows
- notifications
- email
- in-app
- microsoft-teams
- pagerduty
- slack
- settings/integrations/alerting
- pagerduty
- managing-pagerduty
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
0 commit comments