-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs(issue-views): Overhaul Issue Views docs for new UI #13762
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
Merged
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
68c881f
first draft for new issue views docs
MichaelSun48 ced2a55
fix some typos and copy
MichaelSun48 dd10a2b
Fix typo
MichaelSun48 2e7056e
Update docs/product/issues/issue-views/index.mdx
MichaelSun48 ee4f3ac
Update docs/product/issues/issue-views/index.mdx
MichaelSun48 8f85943
remove listing
MichaelSun48 c62cad3
add spaces between suggestions
MichaelSun48 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+74.7 KB
docs/product/issues/issue-views/img/issue_views_all_views_create_view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed
BIN
-34.1 KB
docs/product/issues/issue-views/img/issue_views_unsaved_changes_indicator.png
Binary file not shown.
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 |
---|---|---|
@@ -1,53 +1,71 @@ | ||
--- | ||
title: Issue Views | ||
sidebar_order: 9 | ||
description: "Learn how to customize your issue stream in Sentry and quickly see the issues that are most important to you." | ||
description: "Learn how to create, customize, and share your Issues experience in Sentry." | ||
--- | ||
|
||
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. | ||
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. | ||
|
||
<Alert> | ||
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). | ||
</Alert> | ||
|
||
## Creating Your First View | ||
|
||
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: | ||
|
||
 | ||
## Creating Your First View | ||
|
||
Here, you'll be able to select a view from one of the recommended options or create your own by following the instructions below: | ||
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. | ||
|
||
 | ||
|
||
1. **Name your view**: Give your view a name that describes the types of issues it will show. | ||
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! | ||
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). | ||
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. | ||
4. **Save your view**: Click on the ellipsis menu within the tab and select **Save Changes**. | ||
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: | ||
|
||
* **Prioritized:** A view containing only issues with high or medium priority | ||
* **Assigned to Me:** A view for issues assigned to yourself and your teams | ||
* **For Review:** A view for issues that have been assigned to you or your teams to review | ||
* **Request Errors:** A view for issues with requests that returned a 500 status code | ||
* **High Volume Errors:** A view for issues that have occurred a large number of times | ||
* **Recent Errors:** A view containing issues that have appeared in the last day | ||
* **Function regressions:** A view containing performance issues for functions that have regressed in latency | ||
|
||
<Alert> | ||
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. | ||
</Alert> | ||
|
||
## Customizing Your Views | ||
|
||
|
||
### Updating View Parameters | ||
### Updating Views | ||
|
||
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: | ||
|
||
 | ||
|
||
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. | ||
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`. | ||
|
||
 | ||
 | ||
|
||
### Reordering Views and Setting a Default View | ||
|
||
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. | ||
### Reordering Views | ||
|
||
You can reorder the starred views in the navigation by hovering over them and clicking and dragging the handle to the desirable position. | ||
|
||
|
||
### Renaming Views | ||
|
||
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. | ||
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. | ||
|
||
 | ||
|
||
You can also do this by navigating to the `All Views` page and clicking on the view's ellipsis menu and selecting `Rename`. | ||
|
||
## Sharing Views | ||
|
||
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. | ||
### Browsing and Starring Your Organization's Views | ||
|
||
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. Those views will be inaccessible if open membership is not enabled. | ||
MichaelSun48 marked this conversation as resolved.
Show resolved
Hide resolved
MichaelSun48 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
 | ||
|
||
Here, you can search and sort for specific views and star any views that you want to see in your sidebar. | ||
MichaelSun48 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Sharing a View | ||
|
||
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. |
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.