Skip to content

docs(flags): update python onboarding docs to include second step #11970

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 3 commits into from

Conversation

michellewzhang
Copy link
Member

@michellewzhang michellewzhang commented Nov 27, 2024

add info to the python-specific launchdarkly & openfeature onboarding docs to let users know that there's a second step needed to set up feature flags completely!

figjam ref mapping out the docs

SCR-20241126-ujiu

updated note:
image

Copy link

vercel bot commented Nov 27, 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 Nov 27, 2024 6:19pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Nov 27, 2024 6:19pm
develop-docs ⬜️ Ignored (Inspect) Visit Preview Nov 27, 2024 6:19pm

Copy link

codecov bot commented Nov 27, 2024

Bundle Report

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

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

@@ -44,3 +44,11 @@ sentry_sdk.capture_exception(Exception("Something went wrong!"))
```

Visit the Sentry website and confirm that your error event has recorded the feature flag "hello" and its value "false".

Please read the note below to ensure that you also complete one additional step.
Copy link
Member

Choose a reason for hiding this comment

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

This sentence might be extraneous

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree, I think the note will draw the reader's attention, you probably don't need this callout.


In order to take full advantage of the feature flag capabilities Sentry offers, there is an additional setup step needed, which is setting up your integration-specific webhook. This is needed to enable **feature flag change tracking**, so that your integration may communicate feature flag changes to Sentry. Learn how to set this up by [reading the docs](/product/explore/feature-flags/#set-up-your-integration-specific-webhook).

</Alert>
Copy link
Member

Choose a reason for hiding this comment

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

maybe we should direct users both to other SDK languages they might need languages AND to the webhook stuff:

Next Steps:

  • track feature flag evaluations in other parts of your codebase
  • setup feature flag change tracking webhook

idk

It could also be something similar to the other PR... this paragraph (from #11969) but with links; maybe condensed somehow:

In order to take advantage of the full feature flag experience available, there are two steps necessary to set up feature flag evaluation tracking and feature flag change tracking. The first step — setting up the language-specific SDK — is necessary for evaluation tracking, and the second step — setting up your integration-specific webhook — is necessary for change tracking.

Copy link
Member

Choose a reason for hiding this comment

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

it'll be valuable to put this <Alert> into it's own file and import it into these two files. Over time there will be more languages and thus more files that'll reference it again and again

Copy link
Member Author

Choose a reason for hiding this comment

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

SCR-20241127-jgls updated to this

Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

Looks good! 🕺

@@ -0,0 +1,8 @@
Please read the note below to ensure that you also complete one additional step.

<Alert level="warning" title="Next Steps">
Copy link
Member

Choose a reason for hiding this comment

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

Hmm why don't we have the set up for feature flag changes and evaluations instructions embedded on this integrations page? 🤔

I think there's some consolidating we could do

@github-actions github-actions bot locked and limited conversation to collaborators Dec 18, 2024
@michellewzhang michellewzhang deleted the mz/ld-of-doc branch March 17, 2025 17:32
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.

4 participants