Skip to content
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

Update index.mdx #8626

Merged
merged 4 commits into from
Dec 8, 2023
Merged

Update index.mdx #8626

merged 4 commits into from
Dec 8, 2023

Conversation

dalnoki
Copy link
Contributor

@dalnoki dalnoki commented Dec 4, 2023

add a note to help users who don't know which integration to install

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

Description of changes

Describe your changes here. If your PR relates to or resolves an issue, add a link to that too.

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

Extra resources

add a note to help users who don't know which integration to install
Copy link

vercel bot commented Dec 4, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 6, 2023 9:00pm
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
sentry-docs-next ⬜️ Ignored (Inspect) Visit Preview Dec 6, 2023 9:00pm


<Note>

If you're not sure which GitHub integration you need to configure, please take a look at the URL. The https://github.com/org-name is usually for GitHub-hosted accounts. The self-hosted GitHub Enterprise accounts typically have URLs that look more like this: https://github.org-name.com (or some other customization of the domain). If that's the case, you should configure the non-Enterprise GitHub integration.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you're not sure which GitHub integration you need to configure, please take a look at the URL. The https://github.com/org-name is usually for GitHub-hosted accounts. The self-hosted GitHub Enterprise accounts typically have URLs that look more like this: https://github.org-name.com (or some other customization of the domain). If that's the case, you should configure the non-Enterprise GitHub integration.
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.
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).

The last sentence made it confusing to what you were referring to for the non-enterprise integration, but I think it was the github.com/org-name url? I reworded this and made it two paragraphs for clarity. Feel free to revise if I got it mixed up.

I would also move this note down to after the first sentence of the page (line 20) so it comes up when users need to make a decision.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hi @vivianyentran this is perfect, thank you! yes, it would also make sense to move this down

@vivianyentran
Copy link
Contributor

I'll go ahead and merge this since it's been a few days :)

@vivianyentran vivianyentran merged commit 9eca48c into master Dec 8, 2023
9 checks passed
@vivianyentran vivianyentran deleted the dalnoki-github-intergration-note branch December 8, 2023 18:53
@github-actions github-actions bot locked and limited conversation to collaborators Dec 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants