docs(flags): add product index page for feature flags #11969
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,40 @@ | ||||||
| --- | ||||||
| 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." | ||||||
| --- | ||||||
|
|
||||||
| <Alert level="info" title="Currently in Beta"> | ||||||
|
|
||||||
| The support for **feature flag change tracking** and **feature flag evaluation tracking** is currently in beta. | ||||||
cmanallen marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| </Alert> | ||||||
|
|
||||||
| Link your external feature flag integrations with Sentry to provide feature flag insights right inside the Sentry UI. Linking one or more integrations will allow you to view recent flag evaluations in one place and identify potential suspect flags related to errors. In addition, Sentry will provide insights on feature flag updates relative to error event timelines. | ||||||
cmanallen marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ## 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: | ||||||
|
||||||
| 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: |
Outdated
There was a problem hiding this comment.
Should we write a line or two describing how we determine what's suspect? (broadly speaking)
Outdated
There was a problem hiding this comment.
Hmm, this seems like something we should be saying right here on the product index!
Outdated
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 👁️
Outdated
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. |
Outdated
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 |
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.
Outdated
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. |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.