Skip to content

Commit 4678394

Browse files
authored
fix(github): Correct instructions on GHE docs (#13875)
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR My change from #13393 were a bit overzealous. I think it used to be possible to be a GHE Cloud customer but self-hosted and managed via GitHub, in an on-premise type situation. Most GHE Cloud customers should _not_ be using the enterprise integration, as the hosted app will be much easier. Added verbiage to clarify the only thing we care about is the base URL and app credentials. ## 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 --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [X] 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)
1 parent d4f0375 commit 4678394

File tree

1 file changed

+5
-6
lines changed
  • docs/organization/integrations/source-code-mgmt/github

1 file changed

+5
-6
lines changed

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,12 @@ description: "Learn more about Sentry's GitHub integration and how it can track
55
---
66

77
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/`
8+
- [GitHub](#installing-github) - For most GitHub accounts, these will have URLs like `https://github.com/org-name`. **Most Github Enterprise Cloud customers should be able to use this integration. **Follow the '[Installing GitHub](#installing-github)' instructions, **do not use the GitHub Enterprise integration and please begin the installation from Sentry**.
9+
- [GitHub Enterprise](#installing-github-enterprise) - For GitHub Enterprise instances that **cannot be accessed from `https://github.com`**. For example, a custom domain:
10+
- `https://github.example.com`
11+
- `https://ghe.example.com/`
1312

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**.
13+
For these accounts, and if your organization cannot access the [Sentry's GitHub App](https://github.com/apps/sentry-io) for whatever reason, follow the '[Installing GitHub Enterprise](#installing-github-enterprise)' instructions; it'll guide you through making your own GitHub App and allowing Sentry to use it for access to your organization. **Do not use the regular GitHub integration**.
1514

1615
## Installing GitHub
1716

0 commit comments

Comments
 (0)