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.

Sign up for GitHub

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
Closed

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2261158
docs(flags): update python onboarding docs to include second step
michellewzhang Nov 27, 2024
ab443b4
add beta label
michellewzhang Nov 27, 2024
71cedde
make component reusable
michellewzhang Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/platforms/python/integrations/launchdarkly/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.


<Alert level="warning" title="Note">

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

8 changes: 8 additions & 0 deletions docs/platforms/python/integrations/openfeature/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Alert level="warning" title="Note">

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>
Loading