WIP - Add Event Notifications (Beta) documentation - Do Not Merge#3799
Open
AmberAlston wants to merge 9 commits intomainfrom
Open
WIP - Add Event Notifications (Beta) documentation - Do Not Merge#3799AmberAlston wants to merge 9 commits intomainfrom
AmberAlston wants to merge 9 commits intomainfrom
Conversation
Migrate Event Notifications documentation from Alpha Google Doc to repo in preparation for Beta launch. This completes the "Before Beta Launch" and "Beta Launch Week" documentation tasks. New documentation pages: - event-notifications.mdx: Main landing page with overview, comparison table, event types, use cases, and prerequisites - event-notifications-create.mdx: Step-by-step guide for creating notification subscriptions with filter configuration and troubleshooting - event-notifications-manage.mdx: Instructions for viewing, editing, deleting, and managing notification subscriptions - event-notifications-webhooks.mdx: Technical webhook documentation with HMAC verification, code examples, Slack integration, and debugging Updates to existing documentation: - instance-notifications-config.mdx: Updated title to include "(Legacy)" label, added deprecation warning banner, and cross-links to new docs - sidebars.js: Added new Event Notifications pages to navigation under "Insights and Telemetry" section Content exclusions (as requested): - Omitted "Available events and filters" maintenance section (too hard to maintain; kept high-level event types on main page) - Removed "Types of feedback" section (Alpha-specific) - Removed Alpha-specific language and feature flag references Screenshots deferred: - Added TODO comments for future screenshots when UI stabilizes - Screenshot capture planned for post-UI-stabilization phase This migration enables sunsetting the Google Doc as the source of truth for Event Notifications documentation. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
replicated-ci
added
type::docs
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
- Remove m-dash usage for more natural prose - Reorder Available Event Types: Instance, Customer, Support, Release, Channel - Add anchor links to Custom RBAC policy documentation - Simplify Create Event Notification section structure - Remove Bulk Management future feature mention - Remove detailed code examples from webhooks page (kept conceptual steps) - Remove Security Best Practices and Webhook Payload Examples sections - Reduce redundancy between Create and Manage pages - Replace "Legacy" terminology with "Classic" throughout - Update team-management-slack-config.mdx to mark as Classic system Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Remove outdated Beta note from classic Instance Notifications pages. The classic system is stable and no longer in Beta. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Update sidebar: reorder Insights and Telemetry navigation - Simplify leading sentence on overview page - Update comparison chart delivery values - Remove Status row from comparison chart - Make email non-clickable in Product Manager example - Change "key customer" to "paid customer" in Dev Leader example - Add missing links in limitations section - Remove Instance Notifications (Classic) from Related Topics - Remove Notification List Filtering and Sorting section - Remove Related Topics section from webhooks page Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Changed title from "Event Notification Webhooks (Beta)" to "Configure Event Notification Webhooks (Beta)" for clarity. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
paigecalvert
reviewed
Feb 2, 2026
Contributor
paigecalvert
left a comment
paigecalvert
left a comment
There was a problem hiding this comment.
added some high level comments for your consideration @AmberAlston ! thanks for your work on this it's looking good
Structural changes: - Reorganize sidebar with Event Notifications (Beta) subsection - Move permissions content from manage page to overview page - Remove "Next Steps" and "Related Topics" sections (sidebar handles navigation) Terminology and style: - Update main page title to "About Event Notifications (Beta)" - Simplify terminology: use "notifications" instead of "notification subscriptions" - Use "Disabled" instead of "Paused" for clarity - Update headings to infinitive verb form - Remove bold from procedural text (reserved for UI elements only) Content improvements: - Combine "Key Differences" section with comparison table - Absorb "Getting Started" into Overview section - Expand Prerequisites with detailed RBAC permissions - Add link from filter configuration to Filter Logic section RBAC documentation: - Add event notification permissions to team-management-rbac-resource-names.md Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Member
Author
|
Thanks for the thorough review, @paigecalvert. I've addressed all 17 comments. Here's a summary of the changes: Structural Changes
Terminology & Style
Content Improvements
RBAC Documentation
Deferred
|
Removes individual notification permission entries (subscriptions/read, create, update, delete, types/list, events/read) that were already published via PR #3827. Retains the team/notifications/** wildcard entry which was not covered by that PR. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Updates the team/notifications/slack-webhook/read and team/notifications/slack-webhook/update descriptions to indicate they apply to the classic instance notifications system, with cross-references to the classic notifications page. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Reflects recent feature work: custom subscription naming (PR #8951), enhanced card metadata display (PR #8942), preserved history after deletion (PR #8937), and auto-opening filter modal (PR #8952). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Status of work: The google content from the alpha docs is here. The project is under active development so I anticipate more additions/changes as more features are added in the next 1-2 weeks. Screenshots still need to be added but were deferred until UI updates occur.
Migrate Event Notifications documentation from Alpha Google Doc to primary product documentation repo in preparation for Beta launch. This migration enables sunsetting the Google Doc as the source of truth for Event Notifications documentation.
Existing pages updated to reflect new features
New pages introduced
Other changes
Screenshots deferred as to-do in the code right now
Screenshots Needed for Event Notifications Documentation
Create Event Notification Subscriptions (4 screenshots)
Line 34: Event type selection dropdown
Location: Step 3 of "Create an Event Notification" section
Context: Shows the dropdown menu for selecting event types
Line 38: Filter configuration interface
Location: Step 4 of "Create an Event Notification" section
Context: Shows how to configure filters for the selected event type
Line 51: Delivery method selection
Location: Step 5 of "Create an Event Notification" section
Context: Shows the UI for choosing between email and webhook delivery
Line 132: Multi-select filter UI
Location: End of "Understanding Filter Logic" section
Context: Shows how to select multiple values in a filter (OR logic example)
Manage Event Notification Subscriptions (4 screenshots)
Line 27: My Notifications view
Location: "My Notifications" subsection under "Viewing Notification Subscriptions"
Context: Shows the list of notifications created by the current user
Line 43: Team Notifications view
Location: "Team Notifications" subsection under "Viewing Notification Subscriptions"
Context: Shows all team members' notification subscriptions
Line 58: History view
Location: "History" subsection under "Viewing Notification Subscriptions"
Context: Shows the notification event history with filters
Line 101: Edit notification form
Location: "Editing an Existing Notification" section
Context: Shows the form for modifying an existing notification subscription