Conversation
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
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.
This pull request introduces comprehensive documentation and configuration updates to support two new types of dashboard monitors: quality and coverage monitors. The changes clarify how these new monitor types are integrated into the app, how their data is shaped and displayed, and what steps are required to add them. The documentation now thoroughly explains the distinct data flows, registry fields, and UI behaviors for incident, quality, and coverage monitors, and provides clear guidance for contributors extending the dashboard.
Key documentation and configuration updates:
1. Documentation: Monitor Types and Data Flows
CLAUDE.mdanddocs/adding-a-dashboard.mdto explain the three monitor types (INCIDENTS,QUALITY,COVERAGE), their data sources, shaping modules, page renderers, and the implications for registry fields and UI components. This includes new sections "The backing reads" and detailed comparison tables for monitor behaviors and required sample payloads. [1] [2] [3] [4] [5]2. Contributor Guidance: Adding New Monitors
rows_id) are required for coverage monitors. [1] [2]3. API Endpoint and Repository Read Documentation
4. Test Coverage and Validation
test_registry.py) are parametrized to validate all monitor types, skipping checks that don't apply based on the monitor's declared source, ensuring robust coverage for future extensions. [1] [2]5. Configuration and Workflow Updates
.streamlit/secrets.toml.example. Updated deployment workflow (cd.yml) to use the correct Azure endpoint for health checks and reporting. [1] [2] [3]These changes provide a solid foundation for supporting multiple monitor types, making it easier for contributors to extend the dashboard and for users to understand the data and UI differences between incident, quality, and coverage monitors.