-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
docs(issues): add Inbox and issue progress states page #19103
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+98
−1
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
0c867b2
docs(issues): add Inbox and issue progress states page
souredoutlook 4058baf
docs(issues): tighten Inbox page structure and formatting
souredoutlook ef9fdc3
docs(issues): refine Inbox progress descriptions and copy
souredoutlook b63cd80
Merge branch 'master' into nmeisenheimer/docs/issue-inbox
souredoutlook 0d76c07
Updated text for clarity and tone.
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| --- | ||
| title: Issues Inbox | ||
| sidebar_order: 8 | ||
| description: >- | ||
| Learn how to use Sentry's Inbox to work through issues that are closest to being fixed, and are assigned to you or your teams. | ||
| beta: true | ||
| --- | ||
|
|
||
| <Alert> | ||
|
|
||
| Inbox is in beta, and currently available to organizations with [Seer](/product/ai-in-sentry/seer/) enabled. Beta features are still a work in progress and may change. | ||
|
|
||
| </Alert> | ||
|
|
||
| The **Inbox** view is where you manage issues you're responsible for, where [Seer](/product/ai-in-sentry/seer/) can help you work on them. The Inbox sorts your open issues based on their progress toward a fix, and shows you actionable next steps for driving the issues toward resolution. | ||
|
|
||
| Find the Inbox by navigating to [Issues > Inbox](https://sentry.io/orgredirect/organizations/:orgslug/issues/inbox/). Before clicking into the Inbox page, you'll see a number next to **Inbox** in the navigation menu that shows you the count of unresolved issues that are `Assigned`, `Diagnosed`, or `Fix Proposed` where you are the assignee or suggested assignee. | ||
|
|
||
| ## What the Inbox Shows | ||
|
|
||
| The Inbox page is a two-pane layout. The left side shows a list of issues relevant to you, or your teams. The right side has a preview of the selected issue, with relevant details about Seer Autofix status and linked PRs, plus Issue activity and comments. | ||
|
|
||
| The list only includes `unresolved` issues in the categories Seer can work on: error, mobile, frontend, database query, HTTP client, and configuration. Resolved and archived issues never appear, and neither do categories outside that list, such as uptime outages and cron failures. | ||
|
|
||
| ### Issue Progress | ||
|
|
||
| An issues's progress is determined by the activity on the issue. Issues are grouped into sections based on their progress - `Fix Proposed`, `Diagnosed`, `Assigned`, and `Fix Applied`. | ||
|
|
||
| An issue will be grouped into only one section at a time. The sections are in order from closest to being fixed, to simply assigned. If an issue has no assignee, root cause, or pull request, it will not show up in the Inbox. | ||
|
|
||
| | Section | Condition | | ||
| | ---------------- | -------------------------------------------------------------------------------------- | | ||
| | `Fix Proposed` | At least one open pull request references the issue (for example, `Fixes SENTRY-123`). | | ||
| | `Diagnosed` | Seer identified a root cause. | | ||
| | `Assigned` | The issue is assigned to, or suggested for, you or your teams. | | ||
| | `Fix Applied` | A resolving pull request has been merged, but the issue isn't resolved yet. | | ||
|
|
||
|
sentry[bot] marked this conversation as resolved.
|
||
| Each section header shows a count of matching issues. Click a section's header to expand or collapse it. Each section loads 10 issues at a time; use **Show 10 more** at the bottom of a section to load additional issues. | ||
|
|
||
| An issue automatically moves between these sections as work happens to progress the issue toward a fix. See [How Progress Changes](#how-progress-changes) for the full set of events that advance or roll back an issue's progress. | ||
|
|
||
| ### Filters | ||
|
|
||
| The toggle at the top of the list controls which issues are shown in the list: | ||
|
|
||
| - **Me**: Issues assigned to you, or suggested for you. | ||
| - **My Teams**: Issues assigned to, or suggested for, any team you're on. | ||
| - **All**: Every assigned issue in the organization. | ||
|
|
||
| Learn more about automated assignment by checking out [ownership rules](/product/issues/ownership-rules/) and [suspect commits](/product/issues/suspect-commits/). | ||
|
|
||
| ### The Preview Pane | ||
|
|
||
| The preview pane shows only the details of an issue that help you decide what to do next without leaving the page. Opening an issue in the preview marks it as seen. Click **Open Issue** to go to the full [Issue Details](/product/issues/issue-details/) page. | ||
|
|
||
| The preview pane includes: | ||
|
|
||
| - **Actions**: Seer actions such as *Find Root Cause*, *Make a Plan*, *Write a Code Fix*, *Create PR*, and *Continue in Seer*, which reflect where Autofix has gotten to on this issue. | ||
| - **Priority and assignee**: Change the issue's [priority](/product/issues/issue-priority/) or reassign it in place. | ||
| - **Linked pull requests**: Any pull requests that reference the issue. | ||
| - **Autofix summary**: Seer's root cause, plan, and proposed code changes, when they exist. | ||
| - **Activity**: The issue's activity feed, where you can leave a comment and tag teammates with `@` or teams with `#`. | ||
|
|
||
| ## How Progress Changes | ||
|
|
||
| Progress is recalculated as things happen to the issue: | ||
|
|
||
| | What happens | Effect on progress | | ||
| | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------- | | ||
| | The issue is assigned | Advances to at least `Assigned`. | | ||
| | The issue is unassigned | Not in the Inbox, unless a root cause or pull request puts it in another section. | | ||
| | Seer identifies a root cause | Advances to at least `Diagnosed`. | | ||
| | A resolving pull request is opened or reopened | Advances to `Fix Proposed`. | | ||
| | The last open pull request is closed or unlinked | Falls back to `Diagnosed`, `Assigned`, or leaves Inbox if unassigned and no other section applies. | | ||
| | A resolving pull request is merged | Advances to `Fix Applied`. | | ||
| | Anything else, while the issue is open and already `Fix Applied` | Stays `Fix Applied`. | | ||
| | The issue is resolved or archived | The issue closes and no longer appears in the Inbox. | | ||
| | A closed issue is unresolved, regresses, or escalates | The issue reopens and its progress is recalculated. | | ||
|
|
||
| A few behaviors are worth calling out: | ||
|
|
||
| - Assignment survives closing and reopening an issue. | ||
| - Manually reopening an issue preserves the root cause Seer identified. | ||
| - A regression clears the root cause before recalculating progress. | ||
| - An open resolving pull request persists through closing the issue, and can show in `Fix Proposed` when the issue reopens. | ||
|
|
||
| For example, an unassigned issue that gets a resolving pull request, the PR merges, and then the issue is resolved in a commit moves through `Fix Proposed`, then `Fix Applied`, then closes. If it later regresses, it reopens, but will not appear in the Inbox because the regression cleared the root cause and no other section conditions still apply. | ||
|
|
||
| ### Autofix and Progress | ||
|
|
||
| Autofix steps move the issue along, but only up to a point. Recording a root cause moves an issue to `Diagnosed`; writing a plan and generating code changes don't advance it further on their own. It's the resolving pull request that moves the issue to `Fix Proposed`. | ||
|
|
||
| If that pull request is closed without merging, progress falls back, usually to `Diagnosed`, since Autofix recorded a root cause on the way there, or to `Assigned` or leaving the Inbox if it didn't. A merged pull request behaves differently: it moves the issue to `Fix Applied`, which sticks for as long as the issue stays open. | ||
|
|
||
| When an issue has more than one resolving pull request, progress reflects whether _any_ of them is still open. Closing one while another remains open leaves the issue at `Fix Proposed`. Or if one PR is merged, and another is still open, the issue will move to `Fix Applied`. Only when the last open pull request closes without merging does progress fall back. | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -54,13 +54,15 @@ Sentry creates issues for more than just errors. The **Issues** page sidebar gro | |
| From the **Issues** page, you can begin to triage. The page is organized into tabs, each corresponding to a filtered list of issues, and these different lists help you with triaging: | ||
|
|
||
| - All Unresolved (`is:unresolved`): All unresolved issues, including issues that need review. | ||
| - For Review (`is:unresolved is:for_review`). Also called **Review List**, for-review issues are a subset of all unresolved issues and can include new issues or regressions that haven't been reviewed yet. | ||
| - For Review (`is:unresolved is:for_review`). Also called **Review List**, for-review issues are a subset of all unresolved issues and can include new issues or regressions that haven't been reviewed yet. | ||
| - Regressed (`is:regressed`): All regressed issues; resolved issues that have come up again. | ||
| - Archived (`is:archived`): All archived issues. | ||
| - Escalating (`is:escalating`): All escalating issues; previously archived issues that have exceeded their forecasted event volume. | ||
|
|
||
| Learn more about triaging issues and their different states in [Issue States and Triage](/product/issues/states-triage/). | ||
|
|
||
| If your organization has Seer, the [**Inbox**](/product/issues/inbox/) offers a different way to triage: it groups the issues assigned to you by how close they are to being fixed, so you can start with the ones that need the least work to finish. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm bristling at this a little, and I think it's because it feels like this sentence is leaving out whether or not that issue is also valuable to fix. is that something that goes into consideration at all? |
||
|
|
||
| ## How to Sort Issues | ||
|
|
||
| Change how issues are sorted in the issues stream by selecting from the sort dropdown: | ||
|
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.