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

Work with Francesco to update docs for JS major version release: hubs -> scopes #8627

Closed
3 tasks done
shanamatthews opened this issue Dec 4, 2023 · 2 comments
Closed
3 tasks done
Assignees

Comments

@shanamatthews
Copy link
Contributor

shanamatthews commented Dec 4, 2023

  • Read RFC
  • Meet with Francesco to discuss (in Vienna)
  • Identify docs that reference hubs

hub_github_dockerhub.txt

Questions:

  • when will new JS major ship? End of Jan
  • do we need to preserve old docs w/version info?
  • changes to develop docs?
  • can we repurpose existing Hubs and Scopes page (slug is scopes)?

Docs notes

  • start with JS docs changes when new major comes out

Global scopes:

Global scopes will be documented in a new section under "Enriching Events > Global Data", which will explain how to use getGlobalScope() and when/how data added there will be applied.

Isolation scopes:

Isolation scopes will be documented in a new section under "Enriching Events > Per request data" (or similar, based on SDK language & needs), which will explain how to use getIsolationScope() and when/how data added there will be applied.

Global methods to set data, like Sentry.setTag() or Sentry.setUser(), will set on the isolation scope. Only if you want to set on a different scope, you need to manually get it (e.g. getGlobalScope().setTag()).

Directly interacting with the isolation scope should only be necessary for users manually instrumenting an unsupported framework or similar. This (esp. setting up a new isolation scope) can be documented in a dedicated new docs page.

We should link to these from the manual instrumentation page.

https://gist.github.com/mitsuhiko/1bc78d04ea7d08e5b50d27e42676db80

Maybe some version of this would be helpful in the docs

  • Overall "Scopes" page (repurpose existing Scopes & Hubs page)
    • Current scope page (name?)
    • Isolation scope page ("Set Data for a Request")
    • Global scope page ("Set Global Data")
@getsantry
Copy link
Contributor

getsantry bot commented Dec 4, 2023

Assigning to @getsentry/support for routing ⏲️

@getsantry
Copy link
Contributor

getsantry bot commented Dec 4, 2023

Routing to @getsentry/product-owners-docs for triage ⏲️

@mydea mydea closed this as completed May 27, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Jun 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants