docs(flags): add product index page for feature flags #11969
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
Bundle ReportChanges will increase total bundle size by 162 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
|
6 tasks
michellewzhang
force-pushed
the
mz/ff-index
branch
from
a2f1d71 to
0bb8b8e
Compare
ryan953
reviewed
Nov 27, 2024
|
|
||
| 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. | ||
|
|
||
| ## Set Up Your Language-Specific SDK |
There was a problem hiding this comment.
nit: should this (and the next title) be sub-titles under ## Setup? idk
Suggested change
| ## Set Up Your Language-Specific SDK | |
| ### Set Up Your Language-Specific SDK |
This was referenced Nov 27, 2024
coolguyzone
reviewed
Nov 27, 2024
|
|
||
| ## Setup | ||
|
|
||
| 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. |
There was a problem hiding this comment.
Suggested change
| 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. | |
| In order to take advantage of the full feature flag experience, 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. |
coolguyzone
reviewed
Nov 27, 2024
|
|
||
| Learn more about the languages we currently support and how to set up the SDK: | ||
| * [JavaScript](/platforms/javascript/feature-flags/) | ||
| * [Python](/platforms/python/feature-flags/) |
There was a problem hiding this comment.
These links both 404, I'm guessing those pages are in development as well; let's make sure we don't merge this until those urls are live.
coolguyzone
approved these changes
Nov 27, 2024
jas-kas
approved these changes
Nov 29, 2024
| --- | ||
| title: "Feature Flags" | ||
| sidebar_order: 100 | ||
| description: "Learn how to set up and interact with Sentry's feature flag evaluation tracking and feature flag change tracking." |
There was a problem hiding this comment.
Suggested change
| description: "Learn how to set up and interact with Sentry's feature flag evaluation tracking and feature flag change tracking." | |
| description: "Learn how to set up and interact with Sentry's feature flag evaluation and feature flag change tracking." |
|
|
||
| ## Touchpoints | ||
|
|
||
| Feature flag insights can be found by navigating to the Issue Details page for any error event. There are two places where you can interact with flag data: |
There was a problem hiding this comment.
Suggested change
| Feature flag insights can be found by navigating to the Issue Details page for any error event. There are two places where you can interact with flag data: | |
| Feature flag insights can be found by navigating to the [Issue Details](product/issues/issue-details/) page for any error event. There are two places where you can interact with flag data: |
|
|
||
| Feature flag insights can be found by navigating to the Issue Details page for any error event. There are two places where you can interact with flag data: | ||
| * Flag updates (changes, deletions, and additions) will appear as a series on the event and user volume chart. | ||
| * Flag evaluations will appear in the Feature Flag section in Issue Details as a table, with "suspect" flag predictions highlighted in yellow. |
There was a problem hiding this comment.
Should we write a line or two describing how we determine what's suspect? (broadly speaking)
| * Flag updates (changes, deletions, and additions) will appear as a series on the event and user volume chart. | ||
| * Flag evaluations will appear in the Feature Flag section in Issue Details as a table, with "suspect" flag predictions highlighted in yellow. | ||
|
|
||
| Learn more about how to interact with feature flag insights within the Sentry UI by reading the [Issue Details docs](/product/issues/issue-details/#feature-flags/). |
There was a problem hiding this comment.
Hmm, this seems like something we should be saying right here on the product index!
|
|
||
| Learn more about how to interact with feature flag insights within the Sentry UI by reading the [Issue Details docs](/product/issues/issue-details/#feature-flags/). | ||
|
|
||
| ## Setup |
There was a problem hiding this comment.
Suggested change
| ## Setup | |
| ## Set Up |
There was a problem hiding this comment.
I notice that's how we write set up on our docs site, so updating for consistency 👁️
|
|
||
| ## Set Up Your Integration-Specific Webhook | ||
|
|
||
| In order to gain access to **feature flag change tracking**, you need to set up a webhook with your specific integration, so that it may communicate feature flag changes with Sentry. |
There was a problem hiding this comment.
Suggested change
| In order to gain access to **feature flag change tracking**, you need to set up a webhook with your specific integration, so that it may communicate feature flag changes with Sentry. | |
| In order to gain access to **feature flag change tracking**, you need to set up a webhook with your specific integration, so that it can communicate feature flag changes with Sentry. |
|
Looks like this got pulled into the big docs PR here: https://github.com/getsentry/sentry-docs/pull/12005/files#diff-9f7ef91deded62672a82ddc124ead4aa705d3ad9ef0a76f5ed6f9c4017d9715c closing this so we can focus there. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
add a product landing page for feature flags!
url will be https://docs.sentry.io/product/explore/feature-flags/
figjam ref mapping out the docs