Docs: Updated Sentry docs#705
Open
lwandz13 wants to merge 13 commits into
Open
Conversation
Made-with: Cursor
62 tasks
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
2 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.
Overhaul of the Sentry data source documentation. The previous docs consisted of the README.md only. This update restructures into a flat multi-page layout under docs/sources/ with dedicated topic pages, following data source documentation conventions.
All content was verified against the current plugin codebase for accuracy, including UI labels, field names, default values, error messages, and supported features.
Changes
Restructured README.md to a development/contributor focus: Removed user-facing documentation, added link to published docs site, retained build, test, and contribution instructions
_index.md (new): Requirements (Grafana >=10.4.0, Sentry account, auth token), supported features table, supported query types overview, get started links, additional features, plugin updates, related resources
configure.md (new): Prerequisites, Sentry auth token creation steps, add data source steps, Sentry settings table (URL, Org, Auth Token marked as required), additional settings (Skip TLS Verify, Secure Socks Proxy), connection verification with exact success message, provisioning examples (YAML and Terraform)
query-editor.md (new): All seven query types (Issues, Events, Spans, Events Stats, Spans Stats, Metrics, Stats) with field tables, query examples and use cases for each type
template-variables.md (new): Supported variable types table (Projects, Environments, Teams) with display/actual values, create variable steps, three practical examples (project filter, cascading project/environment, team-scoped projects)
annotations.md (new): Supported query types table with recommendations, annotation query setup steps, five examples (unresolved issues, high-priority, release-specific, error events, template variable-driven)
alerting.md (new): Supported query types table with data type notes, alert rule creation steps, six examples (error volume, unresolved issue count, slow transactions, crash rate, crash-free rate, quota usage), limitations
troubleshooting.md (new): Authentication errors (401, 0 projects), connection errors, query errors (no data, timeout, unknown query type, invalid org slug, 404 spans, 400 detail), annotation errors, alerting errors, template variable errors, performance/rate limit issues, debug logging instructions