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

docs: Add setup step 3 to the toolbar #12181

Merged
merged 2 commits into from
Dec 18, 2024
Merged

docs: Add setup step 3 to the toolbar #12181

merged 2 commits into from
Dec 18, 2024

Conversation

ryan953
Copy link
Member

@ryan953 ryan953 commented Dec 18, 2024

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.

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.):
  • Other deadline:
  • 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

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

Here's a snippet of what the changed pages look like now:

Page Before After
index SCR-20241218-jgkh SCR-20241218-jfiu
setup SCR-20241218-jgrt SCR-20241218-jfjw

Copy link

vercel bot commented Dec 18, 2024

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 18, 2024 6:30pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Dec 18, 2024 6:30pm
develop-docs ⬜️ Ignored (Inspect) Visit Preview Dec 18, 2024 6:30pm

@@ -36,6 +36,10 @@ You need to complete two steps to get the toolbar rendered on the page:
</html>
```

3. Edit Project Settings in Sentry so the Toolbar is allowed to connect from your dev, staging, and production domains.
Copy link
Member

Choose a reason for hiding this comment

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

is it possible to link to the settings page from here?

Copy link
Member Author

Choose a reason for hiding this comment

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

I can get to https://sentry.sentry.io/settings/projects/ but without knowing the project name i can't get closer

Copy link
Member

Choose a reason for hiding this comment

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

ahh its project settings, not org settings. gotcha. could make it org settings?

Copy link
Member Author

Choose a reason for hiding this comment

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

it's a per-project config

Copy link
Member

Choose a reason for hiding this comment

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

why not make it an org config? cause what if you have multiple projects on the same domain?

Copy link
Member Author

Choose a reason for hiding this comment

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

orgs can have like, their main website, but also all the backend tools with very different domains. kinda a security thing

if different projects are on the same domain that's ok. the request is for a project+domain pair. So everything could have localhost added to each of their lists no problem.

Copy link
Member Author

@ryan953 ryan953 Dec 18, 2024

Choose a reason for hiding this comment

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

the security position is that:
we're doing a login using sentry.io, so cookies and things never leave our own control. but org data is leaving sentry.io so I wanted to validate that we're exfiltrating those api responses to a domain known to the customer. This way org data only gets sent to domains the customer controls... then the sdk can use the data to render the toolbar.
This is against phishing cases: if a random site got someone to log into sentry we wouldn't be revealing api responses to that site because of cors in the usual cases, and because of this domain check if they try to abuse the iframe proxy that the toolbar uses.

Copy link

codecov bot commented Dec 18, 2024

Bundle Report

Changes will increase total bundle size by 9 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.35MB 15 bytes (0.0%) ⬆️
sentry-docs-client-array-push 9.28MB 6 bytes (-0.0%) ⬇️

@@ -36,6 +36,10 @@ You need to complete two steps to get the toolbar rendered on the page:
</html>
```

3. Edit [Project Settings](https://sentry.io/orgredirect/organizations/:orgslug/settings/projects/) in Sentry so the Toolbar is allowed to connect from your dev, staging, and production domains.
Copy link
Member

Choose a reason for hiding this comment

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

This just redirects me to a random org (I thought it used to ask you to select an org?)

Copy link
Member Author

Choose a reason for hiding this comment

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

it should take you to the last org you used, something like that

@ryan953 ryan953 merged commit c71af08 into master Dec 18, 2024
11 checks passed
@ryan953 ryan953 deleted the ryan953/toolbar-step3 branch December 18, 2024 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants