Skip to content

Commit 890bfc6

Browse files
vivianyentrangetsantry[bot]shanamatthews
committed
Update project docs (#7396)
* update project docs * update project pages and add gifs * style(lint): Auto commit lint changes * style(lint): Auto commit lint changes * update headings * additional copyedits * Apply suggestions from code review Co-authored-by: Shana Matthews <[email protected]> * Apply suggestions from code review * Update src/docs/product/projects/project-details/index.mdx * Update index.mdx fix line break * style(lint): Auto commit lint changes * Update index.mdx * style(lint): Auto commit lint changes * Update index.mdx fix typo --------- Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com> Co-authored-by: Shana Matthews <[email protected]>
1 parent 4b3932f commit 890bfc6

File tree

3 files changed

+140
-27
lines changed

3 files changed

+140
-27
lines changed

src/docs/product/projects/index.mdx

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,37 @@ description: "View all the projects associated with teams that you're a member o
66

77
A _Project_ represents your service or application in Sentry. For example, you might have separate projects for your API server and frontend client.
88

9-
You can [create a project](/product/sentry-basics/integrate-frontend/create-new-project/) for a service and select the particular language or framework when you first start using Sentry. You can add more projects on an as-needed basis, for example, if you want to manage access permissions and/or control privacy and data settings. Setting up multiple projects to reflect your application landscape with finer granularity will go a long way in helping with visibility and triage. Learn more about best practices for setting up projects in our [account setup documentation](/product/accounts/getting-started/#4-create-projects).
9+
When you first [create a project](/product/sentry-basics/integrate-frontend/create-new-project/), you also assign a team to it. All members of the assigned team have access to the project. Additional teams can be added in **[Project] > Settings > Project Teams**.
1010

11-
When displaying the **Issue Stream** and **Discover** views, the top-level filter bar considers the projects you are a member of by default. This way, you are looking at information that is immediately relevant to your work.
11+
You can create more projects to reflect your application landscape with finer granularity (for example, a separate project for each repo, mapping components and micro-services to the teams that own them). For most pages in Sentry, including **Issues** and **Discover**, the top-level filter bar defaults to showing information for your projects, so that you only see what's relevant to you and your team(s). How you set up your projects can go a long way in reducing noise and improving productivity. Learn more about best practices for setting up projects in our [account setup documentation](/product/accounts/getting-started/#4-create-projects).
1212

1313
Projects differ from [environments](/product/sentry-basics/environments/), which are designed to help triage issues, especially in a multi-staged release process.
1414

15-
## Projects Homepage
15+
## Projects Page
1616

17-
The project homepage lists the projects by teams of which you're a member, providing a high-level overview:
17+
The **Projects** page lists all the projects assigned to teams you're a member of. Projects are displayed in alphabetical order and with a high-level overview of the following:
1818

19-
- A snapshot of both errors and transactions
20-
- The team and team members associated with each project (remember, projects can be associated to multiple teams, so a project may be listed more than once)
21-
- The percentage of crash free sessions (if you have configured [release health](/product/releases/health/)) (not available for watchOS; no Mach exception support on tvOS)
19+
- A snapshot of both errors and transactions in the last 24 hours
20+
- The percentage of crash free sessions, if you have configured [release health](/product/releases/health/) (not available for watchOS; no Mach exception support on tvOS)
2221
- Deploys, if you have configured your SDK to [provide a release identifier](/platform-redirect/?next=/configuration/releases/) and are tracking [deploys](/product/cli/releases/#creating-deploys)
2322

24-
The projects are displayed in alphabetical order, separated by team. **Note:** For faster access, star your favorites to ensure they display at the top of the page each time you view.
23+
**Tip:** For faster access, star your favorite projects to move them to the top of the page.
24+
25+
<div style="position: relative; padding-bottom: calc(56.8359375% + 41px); height: 0; width: 100%">
26+
<iframe
27+
src="https://demo.arcade.software/1M7NByRziNqbjuXpkrFB?embed"
28+
frameborder="0"
29+
loading="lazy"
30+
webkitallowfullscreen
31+
mozallowfullscreen
32+
allowfullscreen
33+
style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;color-scheme: light;"
34+
title="Projects -> Star Project"
35+
></iframe>
36+
</div>
2537

2638
## View Project Details
2739

28-
The [Project Details](/product/projects/project-details/) page provides an overview over errors, performance, and the health of your releases. You can use the page to quickly correlate spikes in error rates with the issues causing them, react to critical alerts, and analyze long-term trends.
40+
Click on a project from the **Projects** page to open the **Project Details** page.
2941

30-
Open Project Details by clicking the title of the project on the Projects page.
42+
The [**Project Details**](/product/projects/project-details/) page provides an overview of errors, performance, and the health of your releases. Use this page to quickly correlate spikes in error rates with the issues causing them, react to critical alerts, and analyze long-term trends.

src/docs/product/projects/project-details/index.mdx

Lines changed: 118 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,47 +4,148 @@ sidebar_order: 1
44
description: "View the combination of errors, performance, and health of your project in one central place."
55
---
66

7-
The **Project Details** page provides a consolidated view of what's going on in your project. This page is useful if you have oversight over many teams and many projects. You can also use this page to set up [Alerting](/product/alerts-notifications/) or delve into the Issue stream to [triage an issue](#triage).
7+
The **Project Details** page provides a consolidated view of various project metrics for the selected time range (14 days by default).
88

9-
![Project Detail](project-detail.png)
10-
11-
After selecting the time range (the default is the last 14 days), the top four cards display:
9+
The top four cards display the following:
1210

1311
- Crash free [sessions](/product/releases/health/#session)
1412
- Crash free users
1513
- Number of [releases](/product/releases/)
1614
- [Apdex](/product/performance/metrics/#apdex)
1715

18-
Select one of the predefined time ranges (excluding `Last 90 days`) to view the change in these numbers since the last period.
16+
The two graphs below the cards show the value of a specific metric over the specified time range. Click on the graph legend to show or hide an overlay of the previous time period and any releases (if set up).
17+
18+
<div style="position: relative; padding-bottom: calc(54.296875% + 41px); height: 0; width: 100%">
19+
<iframe
20+
src="https://demo.arcade.software/XU3D5nw7kEDBO9KwmwuR?embed"
21+
frameborder="0"
22+
loading="lazy"
23+
webkitallowfullscreen
24+
mozallowfullscreen
25+
allowfullscreen
26+
style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;color-scheme: light;"
27+
title="Project Details -> Graphs"
28+
></iframe>
29+
</div>
30+
31+
<br />
1932

20-
The two graphs below the cards provide insight into:
33+
By default, the graphs show crash free sessions and Apdex, but you can toggle the **Display** to set the view to any of the following:
2134

2235
- Crash free [sessions](/product/releases/health/#session)
36+
- Crash free users
2337
- [Apdex](/product/performance/metrics/#apdex)
2438
- [Failure rate](/product/performance/metrics/#failure-rate)
2539
- [Transactions per minute](/product/performance/metrics/#throughput-total-tpm-tps)
26-
- Daily errors
27-
- Daily transactions
40+
- Number of errors
41+
- Number of sessions
42+
- Number of transactions
43+
44+
You can also use this page to set up [alerts](/product/alerts-notifications/) or [triage an issue](#triage).
45+
46+
## Create an Alert
2847

29-
Toggle the **Display** to change the view. You can click on the graph legend to show or hide the overlay of releases and previous period.
48+
You can use the **Project Details** page to access Sentry's alerts feature.
3049

31-
## Alerting
50+
Click the **Create Alert** button at the top right to set up either an [Issue Alert](/product/alerts-notifications/issue-alerts/) or a [Metric Alert](/product/alerts-notifications/metric-alerts/).
3251

33-
You can use the Project Details page to access Sentry's alerting feature. Click the **Create Alert** button at the top right to set up either an [Issue Alert](/product/alerts-notifications/issue-alerts/) or a [Metric Alert](/product/alerts-notifications/metric-alerts/). In the **Latest Alerts** section of the sidebar you can see the three latest triggered alerts. Click on one of them to go to Alert Details page. The selected time range does not affect the displayed alerts.
52+
<div style="position: relative; padding-bottom: calc(61.72148355493352% + 41px); height: 0; width: 100%">
53+
<iframe
54+
src="https://demo.arcade.software/ZEOZDNURwYhmkqdQ76ge?embed"
55+
frameborder="0"
56+
loading="lazy"
57+
webkitallowfullscreen
58+
mozallowfullscreen
59+
allowfullscreen
60+
style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;color-scheme: light;"
61+
title="Project Details -> Create Alert"
62+
></iframe>
63+
</div>
3464

35-
## Releases
65+
## View Latest Alerts
3666

37-
You can use the Project Details page to assess how often you release new versions of your application:
67+
The **Latest Alerts** section in the right sidebar shows the 3 latest triggered alerts. Click on an alert to go to the **Alert Details** page. The selected time range does not affect the displayed alerts.
68+
69+
<div style="position: relative; padding-bottom: calc(61.72148355493352% + 41px); height: 0; width: 100%">
70+
<iframe
71+
src="https://demo.arcade.software/2pJrK9pQvEwpVRseSxbz?embed"
72+
frameborder="0"
73+
loading="lazy"
74+
webkitallowfullscreen
75+
mozallowfullscreen
76+
allowfullscreen
77+
style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;color-scheme: light;"
78+
title="Project Details -> Latest Alerts"
79+
></iframe>
80+
</div>
81+
82+
## View Latest Releases
83+
84+
You can use the **Project Details** page to assess how often you release new versions of your application:
3885

3986
- Number of releases compared to the previous period in the top card
4087
- Release lines overlaid on top of graphs
4188
- Most recent five releases in the **Latest Releases** section of the sidebar. You can click one of these to navigate to the [Release Details](/product/releases/health/release-details/) page. The selected time range does not affect the displayed releases.
4289

43-
## Triage
90+
## Triage Top Issues
4491

45-
Use Project Details to view issues associated with this project and to access them for triage. You can navigate to the **Issue Details** page by clicking either **View All Issues** or the **Open in Issues** button located at the top of the **Frequent Unhandled Issues** listed on the page. The issues in the table are sorted by the number of events in the selected time range.
92+
To help you triage issues, the **Project Details** page shows you the 5 most frequent unhandled issues, sorted by the number of events in the selected time range. Click on an issue to navigate to the **Issue Details** page.
4693

47-
## Modify Project Settings
94+
<div style="position: relative; padding-bottom: calc(54.296875% + 41px); height: 0; width: 100%">
95+
<iframe
96+
src="https://demo.arcade.software/zuLVkma4eOWIHuLlXbYm?embed"
97+
frameborder="0"
98+
loading="lazy"
99+
webkitallowfullscreen
100+
mozallowfullscreen
101+
allowfullscreen
102+
style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;color-scheme: light;"
103+
title="Project Details -> Triage Issue"
104+
></iframe>
105+
</div>
106+
107+
<br />
108+
109+
If you prefer another view, you can also click **Open in Issues** or **Open in Discover** to see issues sorted in the same way on those pages.
110+
111+
## Manage Project Teams
48112

49-
Use the Settings icon at the top of the page to access the Project's Settings; modify as appropriate to your team and organization.
50113
See what teams are involved in this project in the **Team Access** section of the sidebar.
114+
115+
Click the open icon to navigate to **Project Teams** page to see all the teams that have access to this project. If you are an owner or admin, you can add or remove teams from the project.
116+
117+
Click on a team to see that team's members and their roles. If you are a team admin, you can also add or remove members from the team or change their role. You can also see other projects that team owns.
118+
119+
<div style="position: relative; padding-bottom: calc(54.31309904153354% + 41px); height: 0; width: 100%">
120+
<iframe
121+
src="https://demo.arcade.software/mhgmIGjj55tZ3PVqdUnJ?embed"
122+
frameborder="0"
123+
loading="lazy"
124+
webkitallowfullscreen
125+
mozallowfullscreen
126+
allowfullscreen
127+
style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;color-scheme: light;"
128+
title="Project Details -> Project Teams"
129+
></iframe>
130+
</div>
131+
132+
## Modify Project Settings
133+
134+
Use the settings icon at the top of the page to access **Project Settings**. Modify settings as appropriate for your team and organization.
135+
136+
<div style="position: relative; padding-bottom: calc(54.31309904153354% + 41px); height: 0; width: 100%">
137+
<iframe
138+
src="https://demo.arcade.software/wySaVXYOhND0BEFbk2uE?embed"
139+
frameborder="0"
140+
loading="lazy"
141+
webkitallowfullscreen
142+
mozallowfullscreen
143+
allowfullscreen
144+
style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;color-scheme: light;"
145+
title="Project Details -> Project Settings"
146+
></iframe>
147+
</div>
148+
149+
<br />
150+
151+
Go to **Project Settings** to perform tasks such as deleting tags, editing ownership rules, and managing data forwarding. You can also access processing settings (including detector threshold settings for performance issues) and SDK setup configurations.
Binary file not shown.

0 commit comments

Comments
 (0)