Skip to content

doc(unleash): Fix wrong config field key #12764

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

Closed
wants to merge 2 commits into from

Conversation

Curs3W4ll
Copy link

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.
While testing the unleash integration, I noticed that the field described in the doc (unleashClientClass) wasn't present in the integration options type, instead it was named featureFlagClientClass. For me it was with Nuxt.JS.

I don't know if it's the same for the other frameworks, if yes, tell me and I will update the other files too!

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

Copy link

vercel bot commented Feb 18, 2025

@Curs3W4ll is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

@coolguyzone coolguyzone requested a review from s1gr1d February 20, 2025 22:47
@@ -6,7 +6,7 @@ import { UnleashClient } from 'unleash-proxy-client';

Sentry.init({
dsn: '___PUBLIC_DSN___',
integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})],
integrations: [Sentry.unleashIntegration({featureFlagClientClass: UnleashClient})],
Copy link
Member

Choose a reason for hiding this comment

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

Thanks for checking this!
This is actually something that could be added to all files in the unleash folder: https://github.com/getsentry/sentry-docs/tree/master/platform-includes/configuration/unleash

Copy link
Author

Choose a reason for hiding this comment

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

@s1gr1d I've applied it to all the files in the unleash folder

Copy link
Member

Choose a reason for hiding this comment

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

Thank you!

@s1gr1d s1gr1d requested a review from aliu39 February 26, 2025 09:15
@s1gr1d s1gr1d changed the title doc(unleash nuxt): Fix wrong config field key doc(unleasg): Fix wrong config field key Feb 26, 2025
@s1gr1d s1gr1d changed the title doc(unleasg): Fix wrong config field key doc(unleash): Fix wrong config field key Feb 26, 2025
@aliu39
Copy link
Member

aliu39 commented Feb 26, 2025

Thanks sm for reporting and making the PR @Curs3W4ll ! We will address this asap in #12795

@aliu39 aliu39 closed this Feb 26, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Mar 14, 2025
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.

3 participants