Skip to content

Commit f87e6fe

Browse files
MichaelSun48malwilley
authored andcommitted
docs(issue-views): Overhaul Issue Views docs for new UI (#13762)
## DESCRIBE YOUR PR This PR updates the Issue Views docs to reflex the new Issue Views UI. The old UI has been completely removed from the product ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [x] Other deadline: Ideally within the next week, as we are planning to GA soon - [ ] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) --------- Co-authored-by: Malachi Willey <[email protected]>
1 parent 66e2069 commit f87e6fe

File tree

7 files changed

+44
-20
lines changed

7 files changed

+44
-20
lines changed
167 KB
Loading
74.7 KB
Loading
88.5 KB
Loading
76.2 KB
Loading
89.4 KB
Loading
Binary file not shown.
Lines changed: 44 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,77 @@
11
---
22
title: Issue Views
33
sidebar_order: 9
4-
description: "Learn how to customize your issue stream in Sentry and quickly see the issues that are most important to you."
4+
description: "Learn how to create, customize, and share your Issues experience in Sentry."
55
---
66

7-
Issue views let you customize what shows up in your issue stream so you can quickly see what's most important to you. You have full control over which search query your issue stream renders by default, and which other queries are within a click's reach.
7+
Issue views let you customize and share your issue stream, so you and your teammates can quickly see the issues that are most relevant to you.
88

99
<Alert>
1010
This feature is only available if your organization has enabled [early adopter features](/organization/early-adopter-features/). Early adopter features are still in-progress and may have bugs. We recognize the irony. If you’re interested in participating, enable early adopter features in [organization settings](https://sentry.io/orgredirect/organizations/:orgslug/settings/organization).
1111
</Alert>
1212

13+
14+
1315
## Creating Your First View
1416

15-
To create your first custom issue view, navigate to the [**Issues**](https://sentry.io/orgredirect/organizations/:orgslug/issues/) page and click the **Add View** button. You'll see the following page:
17+
To create your first custom issue view, navigate to the [**All Views**](https://sentry.io/orgredirect/organizations/:orgslug/issues/views/) page and click the **`+ Create View`** button on the top right.
1618

17-
![Add View Page](./img/issue_views_add_view.png)
19+
![All Views Page](./img/issue_views_all_views_create_view.png)
1820

19-
Here, you'll be able to select a view from one of the recommended options or create your own by following the instructions below:
21+
This will create a new starred view, which you can than update with the filters of your choosing. Some common use cases for views include:
2022

23+
**Prioritized:** A view containing only issues with high or medium priority
2124

22-
1. **Name your view**: Give your view a name that describes the types of issues it will show.
23-
2. **Set your view's search query**: Choose the search query that will be applied by default when you select this view. Don't forget to hit enter to apply the query!
24-
3. **Set your view's sort**: Select how you want the issues to be sorted in this view (for example, by date, events, and so on).
25-
4. **Set your view's project, environment, and time range filters**: Using the filters next to the search bar, select the projects, environments, and time range you want this view to filter by.
26-
4. **Save your view**: Click on the ellipsis menu within the tab and select **Save Changes**.
25+
**Assigned to Me:** A view for issues assigned to yourself and your teams
26+
27+
**For Review:** A view for issues that have been assigned to you or your teams to review
28+
29+
**Request Errors:** A view for issues with requests that returned a 500 status code
30+
31+
**High Volume Errors:** A view for issues that have occurred a large number of times
32+
33+
**Recent Errors:** A view containing issues that have appeared in the last day
34+
35+
**Function regressions:** A view containing performance issues for functions that have regressed in latency
2736

28-
<Alert>
29-
If you had a default custom saved search, it'll be converted to an issue view and will appear as your default view automatically, just like before. Any other saved searches you created will be available in the **Add View** menu until the end of the year. Please save them as views if you'd like to keep them.
30-
</Alert>
3137

3238
## Customizing Your Views
3339

3440

35-
### Updating View Parameters
41+
### Updating Views
3642

37-
Views are defined by their serach query, sort, and project/environment/time range filters. Changing any of these parameters won't automatically persist those changes to your view. If you do want to update your view with new changes, click on the ellipsis menu after applying those changes and select **Save Changes**. You can also hit cmd+s (or ctrl+s on Windows) to save your changes. To discard them, click **Discard Changes** within the ellipsis menu, or close your Sentry tab without saving.
43+
Views are defined by their search query, sort, and project/environment/time range filters. Changing any of these parameters won't automatically persist those changes to your view, however. If your current filters have diverged from the view's original filters, a purple dot will appear next to your view in the navigation, and hovering over it will show which filters have been changed:
3844

39-
![Unsaved Changes Indicator](./img/issue_views_unsaved_changes_indicator.png)
45+
![Unsaved Changes Indicator](./img/issue_views_unsaved_changes.png)
4046

41-
### Reordering Views and Setting a Default View
47+
To persist these changes to your view, simply click on the purple `Save` button to the right of the search and sort inputs in the Issues page. You may also create a new view with these changes by clicking `Save as new view`, or you can reset the view back to its original filters by clicking `Reset`.
4248

43-
Your can reorder your view tabs by dragging and dropping them to whichever position you want them to be in. The first tab will always be your default view and will be what you see when you first open the **Issues** page.
49+
![Save Button](./img/issue_views_save_button.png)
50+
51+
52+
### Reordering Views
53+
54+
You can reorder the starred views in the navigation by hovering over them and clicking and dragging the handle to the desirable position.
4455

4556

4657
### Renaming Views
4758

48-
To rename a view, select it from the tab list. Then, either double click on the view's name or click the ellipsis menu and select **Rename**, type in a new name, and hit enter.
59+
To rename a view, navigate to that view's page and hover over the page header, which will reveal a pencil icon. Click the pencil icon to edit the view's name.
4960

61+
![Renaming](./img/issue_views_renaming.png)
62+
63+
You can also do this by navigating to the `All Views` page and clicking on the view's ellipsis menu and selecting `Rename`.
5064

5165
## Sharing Views
5266

53-
We built Issue Views in a way that makes them easy to share with people in your organization. To share, just copy the link to your issue view and send it to a fellow org member. The link will take them to a **temporary tab** that contains the same query and sort as your view. They'll then be able to save the view as their own by clicking **Save View**, or discard it by clicking **Discard**. Note, that temporary tabs will not be persisted across page navigations or reloads.
67+
### Browsing and Starring Your Organization's Views
68+
69+
All Issue Views are visible to all members of your organization, and you can browse your organization's views by navigating to the [**All Views**](https://sentry.io/orgredirect/organizations/:orgslug/issues/views/) page. Keep in mind that some views may filter on projects that you may not have access to. You will not be able to see the issues in these views if open membership is not enabled.
70+
71+
![All Views](./img/issue_views_all_views.png)
72+
73+
Here, you can search for specific views and star any that you want to see in the sidebar.
74+
75+
### Sharing a View
76+
77+
You can share a view to anyone simply by sending them a link to the view. Any organization members will be able to see the view and save a duplicate of it as their own, but only the creator, and organization admins/managers have the permissions to delete or edit it.

0 commit comments

Comments
 (0)