Skip to content

Commit 5aa4dc8

Browse files
sfanahataShannon Anahata
andauthored
Feat: Updated prevent docs with latest steps (#15456)
## DESCRIBE YOUR PR Updated prevent docs to: - Remove Seer GH app instructions - Remove FAQ about supporting EU. Yes we do now! Preview: https://sentry-docs-git-prevent-doc-updates.sentry.dev/product/ai-in-sentry/ai-code-review/ ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [x] Urgent deadline (GA date, etc.): Soon as this ships - [ ] Other deadline: <!-- ENTER DATE HERE --> - [ ] 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: Shannon Anahata <shannonanahata@gmail.com>
1 parent 8019baa commit 5aa4dc8

File tree

3 files changed

+28
-33
lines changed

3 files changed

+28
-33
lines changed

docs/organization/integrations/source-code-mgmt/github/index.mdx

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ There are three types of GitHub integrations, so make sure you're choosing the c
1717

1818
For these accounts, follow the '[Installing GitHub Enterprise](#installing-github-enterprise)' instructions.
1919

20-
- [Seer GitHub App](#installing-the-seer-github-app) - For [Seer](/product/ai-in-sentry/seer) to make Pull Requests for Issue Fixes and for [AI Code Review](/product/ai-in-sentry/ai-code-review) to analyze your Pull Requests.
20+
- [Seer GitHub App](#installing-the-seer-github-app) - For [Seer](/product/ai-in-sentry/seer) to make Pull Requests for Issue Fixes.
2121

2222
### Check Your Domain
2323

@@ -38,7 +38,7 @@ Sentry owner, manager, or admin permissions, and GitHub owner permissions are re
3838

3939
1. In Sentry, navigate to **Settings > Integrations > [GitHub](https://sentry.io/orgredirect/organizations/:orgslug/settings/integrations/github)**.
4040

41-
![Install GitHub integration](./img/github-install-page.png)
41+
![Install GitHub integration =800x](./img/github-install-page.png)
4242

4343
2. If you have the legacy GitHub integration installed, use the button next to GitHub to **Upgrade**. If you don't have the legacy GitHub integration installed, use the button to **Install**.
4444

@@ -50,7 +50,7 @@ Sentry owner, manager, or admin permissions, and GitHub owner permissions are re
5050
7. On your new GitHub instance in Sentry, click "Configure".
5151
8. All of your repositories will be added by default, you just have to refresh your screen. To only add select repositories, choose them from the dropdown list. _Make sure you have given Sentry access to these repositories in GitHub in the previous steps._
5252

53-
![Add repository](./img/github-global-add-repo.png)
53+
![Add repository =500x](./img/github-global-add-repo.png)
5454

5555
9. You can now [configure](#configure) the integration.
5656

@@ -192,15 +192,15 @@ Occasionally, Sentry will request additional permissions to your GitHub account
192192

193193
3. Click "Add Installation".
194194

195-
![Add Installation](./img/github-e-add-installation.png)
195+
![Add Installation =700x](./img/github-e-add-installation.png)
196196

197197
4. Fill out the following form with information from your GitHub apps configuration page. The installation URL must be resolvable over the Internet.
198198

199199
![GitHub Enterprise configuration form](./img/github-e-form.png)
200200

201201
You'll need to generate a private key on your GitHub apps configuration page, and paste the entire contents into the **GitHub App Private Key** field.
202202

203-
![Generate private key](./img/github-e-generate-private-key.png)
203+
![Generate private key =550x](./img/github-e-generate-private-key.png)
204204

205205
For example, in terminal:
206206

@@ -210,30 +210,30 @@ Occasionally, Sentry will request additional permissions to your GitHub account
210210

211211
5. Click "Configure" and then a GitHub install window will pop up. Select which repositories Sentry should have access to (or select all repositories) and click "Install".
212212

213-
![Install GitHub Enterprise confirmation modal](./img/github-e-repo-access.png)
213+
![Install GitHub Enterprise confirmation modal =700x](./img/github-e-repo-access.png)
214214

215215
6. You will then be redirected back to Sentry. On your new GitHub Enterprise instance, click "Configure".
216216

217-
![Configure GitHub enterprise](./img/github-e-configure.png)
217+
![Configure GitHub enterprise =800x](./img/github-e-configure.png)
218218

219219
7. Add any repositories that you want to collect commit data from. _Make sure you have given Sentry access to these repositories in GitHub in the previous steps._
220-
![Add GitHub Enterprise repository](./img/github-e-add-repo.png)
220+
![Add GitHub Enterprise repository =600x](./img/github-e-add-repo.png)
221221

222222
GitHub Enterprise should now be enabled for all projects under your Sentry organization.
223223

224224
## Installing the Seer GitHub App
225225

226-
The [Seer GitHub App](https://github.com/apps/seer-by-sentry) is used by [Seer](/product/ai-in-sentry/seer) to make Pull Requests for Issue Fixes and for [AI Code Review](/product/ai-in-sentry/ai-code-review) to analyze your Pull Requests.
226+
The [Seer GitHub App](https://github.com/apps/seer-by-sentry) is used by [Seer](/product/ai-in-sentry/seer) to make Pull Requests for Issue Fixes.
227227

228228
To install the Seer GitHub App, simply follow the installation steps to install the GitHub App for the specified organization/repositories you need. You can find the Seer GitHub App [here](https://github.com/apps/seer-by-sentry).
229229

230-
- For [Issue Fix](/product/ai-in-sentry/seer#issue-fix), you will now be able to create pull requests in the installed locations.
230+
For [Issue Fix](/product/ai-in-sentry/seer#issue-fix), you will now be able to create pull requests in the installed locations.
231231

232-
- For [AI Code Review](/product/ai-in-sentry/ai-code-review), continue following the instructions in the [Sentry Prevent AI](/product/ai-in-sentry/sentry-prevent-ai#getting-started) documentation.
232+
## Configure GitHub Integration
233233

234-
## Configure
234+
Use GitHub to [track commits](#commit-tracking), identify [suspect commits](#suspect-commits-and-suggested-assignees), [resolve via commit or PR](#resolve-via-commit-or-pull-request), [manage issues](#issue-management), and use AI for code review.
235235

236-
Use GitHub to [track commits](#commit-tracking), identify [suspect commits](#suspect-commits-and-suggested-assignees), [resolve via commit or PR](#resolve-via-commit-or-pull-request) and [manage issues](#issue-management).
236+
To enable [AI Code Review](/product/ai-in-sentry/ai-code-review), turn on the `Show Generative AI Features` and `Enable AI Code Review` settings in your [organization settings](https://sentry.io/orgredirect/settings/:orgslug/).
237237

238238
### Commit Tracking
239239

@@ -245,7 +245,7 @@ Once you set up commit tracking, you'll be able to see the most recent changes t
245245

246246
For issues where the files in the stack trace match files included in commits sent to Sentry, you'll see the suspect commit, with a link to the commit itself.
247247

248-
![Suspect commits](./img/github-global-suspect-commits.png)
248+
![Suspect commits =700x](./img/github-global-suspect-commits.png)
249249

250250
You'll also see that the author of the suspect commit will be listed as a suggested assignee for this issue. To assign the issue to the suggested assignee, click on their icon.
251251

@@ -270,19 +270,19 @@ Issue management can be configured in two ways - automatically or manually.
270270

271271
To configure issue management automatically, create an [**Issue Alert**](/product/alerts-notifications/issue-alerts/). When selecting the [**action**](/product/alerts/create-alerts/issue-alert-config/#then-conditions-actions), choose **Create a new GitHub issue**.
272272

273-
![Create GitHub Issue alert rule action](./img/github-ticket-rule.png)
273+
![Create GitHub Issue alert rule action =700x](./img/github-ticket-rule.png)
274274

275275
A GitHub issue will be created automatically when the alert has been triggered.
276276

277277
#### Manually
278278

279279
To configure issue management manually, once you've navigated to a specific Sentry issue, you'll find the **Linked Issues** section on the right hand panel.
280280

281-
![Link GitHub issue from Sentry issue](./img/github-global-link-issue.png)
281+
![Link GitHub issue from Sentry issue =800x](./img/github-global-link-issue.png)
282282

283283
Here, you'll be able to create or link GitHub issues.
284284

285-
![Create GitHub issue form](./img/github-create-issue.png)
285+
![Create GitHub issue form =800x](./img/github-create-issue.png)
286286

287287
### Issue Sync
288288

@@ -339,15 +339,15 @@ Sentry can comment on merged and open pull requests. These features are automati
339339

340340
If a recently merged pull request is suspected of causing an issue, Sentry will comment on it to surface the issue, as shown in the example below.
341341

342-
![Sentry comment on suspect pull request in GitHub](./img/sentry-github-pr-comment.png)
342+
![Sentry comment on suspect pull request in GitHub =700x](./img/sentry-github-pr-comment.png)
343343

344344
Sentry will only comment on pull requests less than two weeks old that are associated with suspect commits. The comment will continuously be updated with up to five issues the pull request is suspected to have caused.
345345

346346
#### Open Pull Request Comments
347347

348348
When a pull request is opened, Sentry will parse the filenames and function names modified in the pull request from the PR diff to find recent unhandled, unresolved issues associated with your pull request.
349349

350-
![Sentry comment on open pull request in GitHub](./img/sentry-github-open-pr-comment.png)
350+
![Sentry comment on open pull request in GitHub =700x](./img/sentry-github-open-pr-comment.png)
351351

352352
Sentry will comment on the pull request with up to five issues per file that were first seen within the past 90 days and were last seen within the past 14 days.
353353

@@ -357,17 +357,17 @@ This feature requires [code mappings](/product/issues/suspect-commits/#2-set-up-
357357

358358
If there are users committing to GitHub repositories linked to Sentry and they're not members of your organization, Sentry detects them as missing members. Once a month, Sentry sends organization owners and managers an email reminding them to invite those users to join their org. Sentry also shows a banner to invite missing members in the **Settings > Members** page.
359359

360-
![GitHub missing members invite banner](./img/github-missing-members-banner.png)
360+
![GitHub missing members invite banner =700x](./img/github-missing-members-banner.png)
361361

362362
The banner shows the 5 most active contributors that are not yet in the organization. To see all missing members (up to 50), click "View All" in the banner. To snooze the banner, click the ellipsis, then select "Hide Missing Members".
363363

364364
Clicking "View All" on the invite banner will display the invite modal. From here, you can select multiple users and assign roles and teams before inviting them.
365365

366-
![GitHub missing members invite modal](./img/github-missing-members-modal.png)
366+
![GitHub missing members invite modal =750x](./img/github-missing-members-modal.png)
367367

368368
By default, this feature is automatically enabled once your GitHub integration has been set up. To disable it, go to **Settings > Integrations > GitHub** and toggle it off.
369369

370-
![How to disable missing member detection](./img/github-org-settings.png)
370+
![How to disable missing member detection =750x](./img/github-org-settings.png)
371371

372372
### Stack Trace Linking
373373

docs/product/ai-in-sentry/ai-code-review/index.mdx

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,17 @@ AI Code Review helps you reviews your code changes, predicting errors and offeri
1818

1919
## Getting Started
2020

21-
To enable AI Code Review in your GitHub organization or on specific repositories, you need to install the [Seer by Sentry GitHub app](/organization/integrations/source-code-mgmt/github/#installing-the-seer-github-app). This allows the assistant to analyze pull requests, provide insights, and write tests. **You must also have the [Sentry Github integration](/organization/integrations/source-code-mgmt/github/) enabled.**
21+
To enable AI Code Review in your GitHub organization or on specific repositories:
22+
23+
1. Have the [Sentry Github integration](/organization/integrations/source-code-mgmt/github/) enabled.
2224

23-
1. Install the [Seer by Sentry GitHub app](/organization/integrations/source-code-mgmt/github/#installing-the-seer-github-app) in your GitHub organization or specific repositories.
2425
2. Enable these required settings in your Sentry [organization settings](https://sentry.io/orgredirect/settings/:orgslug/):
2526
- `Show Generative AI Features`
2627
- `Enable AI Code Review`
2728

28-
If you're not an admin, share the Seer by Sentry GitHub App Integration link with your organization's admin or owner to install it.
29-
3029
## AI Code Review Commands
3130

32-
After installing the app, AI Code Review can help you in three ways:
31+
Ways AI Code Review can help you:
3332

3433
1. **Error Prediction** - When you create a pull request and set it to `Ready for Review`, AI Code Review will check for errors in your code. If no error is found, you will see a 🎉 emoji as a reaction to your PR description. Otherwise, AI Code Review will add comments to your PR. **Note:** We skip review if you set your PR to `draft` on creation.
3534

@@ -53,11 +52,7 @@ Once you have added a comment, the assistant will reply, acknowledging the reque
5352

5453
- **Why aren't `@sentry` commands working?**
5554

56-
AI Code Review will respond with a message to enable the `Show Generative AI Features` and `Enable PR Review and Test Generation` settings in your [organization settings](https://sentry.io/orgredirect/settings/:orgslug/), if you have not already enabled them. Once enabled, try `@sentry review` again to run AI Code Review.
57-
58-
- **Is AI Code Review available in the EU region?**
59-
60-
Not currently, although we're working on it.
55+
AI Code Review will respond with a message to enable the `Show Generative AI Features` and `Enable AI Code Review` settings in your [organization settings](https://sentry.io/orgredirect/settings/:orgslug/), if you have not already enabled them. Once enabled, try `@sentry review` again to run AI Code Review.
6156

6257
- **When does Error Prediction run?**
6358

docs/product/ai-in-sentry/seer/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ To start using Seer's capabilities in your Sentry-enabled projects, follow these
6969
> **Note**: You can monitor your Seer usage in the [Stats & Usage tab](https://sentry.io/settings/stats/) and can learn more about managing your Seer budget [here](/pricing/quotas/manage-seer-budget/).
7070
4. **Start Using**: Look for Seer options in your issue details pages
7171

72-
To start using Seer to for AI code reviews, [configure the Seer GitHub App](/organization/integrations/source-code-mgmt/github/#installing-the-seer-github-app).
72+
You can also use Seer for [AI code reviews](/product/ai-in-sentry/ai-code-review) by enabling the [GitHub integration](/organization/integrations/source-code-mgmt/github/) and turning on the `Enable AI Code Review` setting in your [organization settings](https://sentry.io/orgredirect/settings/:orgslug/).
7373

7474
## Privacy and security
7575

0 commit comments

Comments
 (0)