Skip to content

Commit 7d75721

Browse files
authored
fix(integrations): Correct and clarify instructions surround GHE (#13393)
* ✏️ Correct the GHE docs * ✏️ formatting
1 parent 33dfce5 commit 7d75721

File tree

1 file changed

+12
-14
lines changed
  • docs/organization/integrations/source-code-mgmt/github

1 file changed

+12
-14
lines changed

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

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,16 @@ sidebar_order: 1
44
description: "Learn more about Sentry's GitHub integration and how it can track and resolve bugs faster by using data from your GitHub commits, and streamline your triaging process by creating a GitHub issue directly from Sentry."
55
---
66

7-
If you're not sure which GitHub integration you need to configure, please take a look at the URL. URLs like `https://github.com/org-name` are usually for GitHub-hosted accounts and should use the regular GitHub (not GitHub Enterprise) integration. See [Install](#install) for more details.
7+
There are two types of GitHub integrations, so make sure you're choosing the correct one:
8+
- [GitHub](#installing-github) - For regular GitHub accounts, these will have URLs like `https://github.com/org-name`. Follow the '[Installing GitHub](#installing-github)' instructions, **do not use the GitHub Enterprise integration**.
9+
- [GitHub Enterprise](#installing-github-enterprise) - For GitHub Enterprise Cloud or GitHub Enterprise Server instances. Some example URLs:
10+
- `https://github.org-name.com`
11+
- `https://github.com/enterprises/org-name`
12+
- `https://org-name.ghe.com/`
813

9-
Self-hosted GitHub Enterprise accounts typically have URLs that look more like `https://github.org-name.com` (or some other customization of the domain). In this case, you should configure the [GitHub Enterprise integration](#github-enterprise).
14+
These [can also be modified](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-your-enterprise-account/changing-the-url-for-your-enterprise) so make sure you have have the correct URL during installation. For these accounts, follow the '[Installing GitHub Enterprise](#installing-github-enterprise)' instructions, **do not use the regular GitHub integration**.
1015

11-
## Install
16+
## Installing GitHub
1217

1318
<Alert>
1419

@@ -34,23 +39,16 @@ Sentry owner, manager, or admin permissions, and GitHub owner permissions are re
3439

3540
The GitHub integration is available for all projects under your Sentry organization. You can connect multiple GitHub organizations to one Sentry organization, but you **cannot** connect a single GitHub organization to multiple Sentry organizations.
3641

37-
## GitHub Enterprise
42+
## Installing GitHub Enterprise
3843

39-
<Alert>
40-
41-
If your GitHub Enterprise instance is self-hosted/on-prem, follow the instructions below.
42-
If you're using GitHub Enterprise Cloud, follow the [instructions for GitHub](/organization/integrations/source-code-mgmt/github/#install).
43-
44-
</Alert>
45-
46-
#### Add new GitHub App
44+
### Add new GitHub App
4745

4846
1. Confirm [Sentry's IP ranges](/security-legal-pii/security/ip-ranges/) are allowed for your GitHub Enterprise instance.
4947
2. In your GitHub Enterprise organization, navigate to Settings > Developer Settings > **GitHub Apps** and click to add a new **New GitHub App**.
5048

5149
![Create GitHub Enterprise app](./img/github-e-new-app.png)
5250

53-
#### Register new GitHub App
51+
### Register new GitHub App
5452

5553
1. First, you'll need to generate a webhook secret. For example, in terminal:
5654

@@ -148,7 +146,7 @@ If you're using GitHub Enterprise Cloud, follow the [instructions for GitHub](/o
148146
</tbody>
149147
</table>
150148

151-
#### Install your GitHub App
149+
### Install your GitHub App
152150

153151
1. In Sentry, navigate to Organization Settings > **Integrations**.
154152
2. Next to GitHub Enterprise, click "Install".

0 commit comments

Comments
 (0)