Skip to content

QUA-1518: Add PagerDuty feature#1068

Merged
shindiogawa merged 14 commits intomainfrom
qua-1518-add-pagerduty-feature
Mar 30, 2026
Merged

QUA-1518: Add PagerDuty feature#1068
shindiogawa merged 14 commits intomainfrom
qua-1518-add-pagerduty-feature

Conversation

@RafaelOsiro
Copy link
Copy Markdown
Contributor

@RafaelOsiro RafaelOsiro commented Mar 13, 2026

Overview

This PR adds PagerDuty integration documentation and restructures the Flows Notification section from a monolithic page into per-channel sub-pages, improving navigation and maintainability.

Key Changes

  • PagerDuty Integration (Settings > Integrations > Alerting): Add complete documentation including overview, deep dive, API reference, FAQ, and step-by-step managing guides (add, edit, remove integration) with screenshots
  • Notifications Restructure (Flows > Actions > Notifications): Split notification.md into dedicated sub-pages per channel (In App, Email, Slack, Microsoft Teams, PagerDuty), each with Overview, API, and FAQ
  • Message Variables: Migrate notification-tokens.md to message-variables.md with a new channel-specific variables section
  • Alerting Integrations Overview: Rewrite following the Field Status documentation pattern with centered logos, standardized layout, and integration summary table
  • Asset Reorganization: Rename alerting logos to TECHNOLOGY-logo.png pattern, organize notification screenshots per channel, and remove deprecated assets
  • Redirects: Add URL redirects for all moved pages to preserve external links
  • Navigation: Update mkdocs.yml sidebar with new Notifications and PagerDuty structure

Screenshots

… 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
- 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
- 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
@RafaelOsiro RafaelOsiro self-assigned this Mar 13, 2026
@RafaelOsiro RafaelOsiro added the documentation Improvements or additions to documentation label Mar 13, 2026
@RafaelOsiro RafaelOsiro marked this pull request as ready for review March 13, 2026 02:14
@RafaelOsiro RafaelOsiro marked this pull request as draft March 21, 2026 02:53
…avigation

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)
…tructure

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.
@RafaelOsiro RafaelOsiro marked this pull request as ready for review March 23, 2026 15:38
RafaelOsiro and others added 5 commits March 24, 2026 11:07
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).
Copy link
Copy Markdown
Contributor

@shindiogawa shindiogawa left a comment

Choose a reason for hiding this comment

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

GTG

@shindiogawa shindiogawa merged commit a27718f into main Mar 30, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants