Skip to content

Commit 9c12252

Browse files
docs(flags): update generic docs (#12270)
* docs(flags): update generic docs * ♻️ remame to generic * ✏️ lint
1 parent 54a6fa3 commit 9c12252

File tree

8 files changed

+21
-20
lines changed

8 files changed

+21
-20
lines changed

docs/organization/integrations/feature-flag/self-serve/index.mdx renamed to docs/organization/integrations/feature-flag/generic/index.mdx

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Self-Serve
3-
sidebar_order: 1
4-
description: Learn about Sentry's self-serve feature-flag integrations.
2+
title: Generic
3+
sidebar_order: 3
4+
description: Learn about Sentry's generic feature-flag integrations.
55
---
66

77
## Evaluation Tracking
@@ -10,11 +10,11 @@ Sentry can track flag evaluations as they happen within your application. Flag
1010

1111
### Set Up Evaluation Tracking
1212

13-
To set up evaluation tracking visit the [explore page](/product/explore/feature-flags/) and select the language and SDK of your choice. Not using a supported SDK? That's okay. We support self-serve integrations with your existing system.
13+
To set up evaluation tracking, visit the [explore page](/product/explore/feature-flags/) and select the language and SDK of your choice. Not using a supported SDK? That's okay. We support generic integrations with your existing system.
1414

15-
To set up self-serve evaluation tracking visit one of our supported languages pages:
16-
* [JavaScript](/platforms/javascript/configuration/integrations/self-serve/)
17-
* [Python](/platforms/python/integrations/feature-flags/self-serve/)
15+
To set up self-serve evaluation tracking, visit one of our supported languages' pages:
16+
* [JavaScript](/platforms/javascript/configuration/integrations/generic/)
17+
* [Python](/platforms/python/integrations/feature-flags/generic/)
1818

1919
## Change Tracking
2020

@@ -24,7 +24,7 @@ Sentry offers a change tracking feature which functions as an audit-log of featu
2424

2525
### API Documentation
2626

27-
If you're using a self-serve integration it means you will likely need to write code to support this endpoint. This section documents our authentication procedures as well as the resource's fields and structure.
27+
If you're using a generic integration it means you will likely need to write code to support this endpoint. This section documents our authentication procedures as well as the resource's fields and structure.
2828

2929
#### Authentication
3030

@@ -47,11 +47,12 @@ Enabling Change Tracking is a three step process. To get started visit the [feat
4747

4848
1. **Click the "Add New Provider" button.**
4949
- One webhook secret can be registered per provider type.
50+
- Select Generic in the dropdown that says "Select a provider".
5051
2. **Register the webhook URL**.
5152
- Copy the provided Sentry webhook URL and configure your feature flagging system to emit web hooks to this URL.
5253
3. **Set the Signing Secret**.
53-
- In your feature flagging system's UI find the "Signing Secret".
54-
- Copy the signing secret and paste it into the input box labeled "Secret" in Sentry.
55-
- In Sentry, save the secret by clicking "Save Secret".
54+
- In your feature flagging system's UI, find the "Signing Secret".
55+
- Copy the signing secret and paste it into the input box next to "Secret" in Sentry settings.
56+
- Save the secret by clicking "Add Provider" in Sentry settings.
5657

5758
Once saved Sentry will now accept and authenticate all inbound hooks to your organization's feature flag webhook endpoint.

docs/organization/integrations/feature-flag/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ description: "Learn more about Sentry's feature flag integrations."
55
---
66

77
- [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/)
8-
- [Self-Serve](/organization/integrations/feature-flag/self-serve/)
8+
- [Generic](/organization/integrations/feature-flag/generic/)
99
- [Split](/organization/integrations/feature-flag/split/)
1010
- [Unleash](/organization/integrations/feature-flag/unleash/)

docs/organization/integrations/feature-flag/launchdarkly/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ description: Learn about Sentry's LaunchDarkly integrations.
66

77
## Evaluation Tracking
88

9-
Sentry can track flag evaluations as they happen within your application. Flag evaluations will appear in the "Feature Flag" section of Issue Details page 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 page documentation](/product/issues/issue-details/#feature-flags).
9+
Sentry can track flag evaluations as they happen within your application. Flag evaluations will appear in the "Feature Flag" section of the Issue Details page 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 page documentation](/product/issues/issue-details/#feature-flags).
1010

1111
### Set Up Evaluation Tracking
1212

13-
To set up evaluation tracking visit one of our supported languages pages:
13+
To set up evaluation tracking, visit one of our supported languages pages:
1414
* [JavaScript](/platforms/javascript/configuration/integrations/launchdarkly/)
1515
* [Python](/platforms/python/integrations/feature-flags/launchdarkly/)
1616

docs/platforms/javascript/common/configuration/integrations/self-serve.mdx renamed to docs/platforms/javascript/common/configuration/integrations/generic.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Self-Serve Feature Flags Integration
2+
title: Generic Feature Flags Integration
33
description: "Learn how to attach custom feature flag data to Sentry error events."
44
notSupported:
55
- javascript.aws-lambda

docs/platforms/javascript/common/feature-flags/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,6 @@ description: With Feature Flags, Sentry tracks feature flag evaluations in your
3333
Evaluation tracking requires enabling an SDK integration. Integrations are provider specific. Documentation for supported providers is listed below.
3434
- [OpenFeature](/platforms/javascript/configuration/integrations/openfeature/)
3535
- [LaunchDarkly](/platforms/javascript/configuration/integrations/launchdarkly/)
36-
- [Self-Serve](/platforms/javascript/configuration/integrations/self-serve/)
36+
- [Generic](/platforms/javascript/configuration/integrations/generic/)
3737

3838
<PlatformContent includePath="feature-flags/enable-change-tracking" />

docs/platforms/python/feature-flags/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ Evaluation tracking requires enabling an SDK integration. Integrations are provi
1616

1717
- [OpenFeature](/platforms/python/integrations/feature-flags/openfeature/)
1818
- [LaunchDarkly](/platforms/python/integrations/feature-flags/launchdarkly/)
19-
- [Self-Serve](/platforms/python/integrations/feature-flags/self-serve/)
19+
- [Generic](/platforms/python/integrations/feature-flags/generic/)
2020

2121
<PlatformContent includePath="feature-flags/enable-change-tracking" />

docs/platforms/python/integrations/feature-flags/self-serve.mdx renamed to docs/platforms/python/integrations/feature-flags/generic.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: Self-Serve
2+
title: Generic
33
description: "Learn how to attach custom feature flag data to Sentry error events."
44
---
55

66
<PlatformContent includePath="feature-flags/prerelease-alert" />
77

8-
The Feature Flags integration allows you to manually track feature flag evaluations through an API. These evaluations are held in memory, and in the event an error occurs, sent to Sentry for review and analysis. Specifically, the self-serve integration enables users to integrate with proprietary (or otherwise unsupported) feature flagging solutions. **At the moment, we only support boolean flag evaluations.**
8+
The Feature Flags integration allows you to manually track feature flag evaluations through an API. These evaluations are held in memory, and in the event an error occurs, sent to Sentry for review and analysis. Specifically, the generic integration enables users to integrate with proprietary (or otherwise unsupported) feature flagging solutions. **At the moment, we only support boolean flag evaluations.**
99

1010
## Install
1111

docs/product/explore/feature-flags/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ Change tracking enables Sentry to listen for additions, removals, and modificati
3030

3131
To set up change tracking, visit the webhook integration documentation for your provider:
3232
* [LaunchDarkly](/organization/integrations/feature-flag/launchdarkly/#change-tracking)
33-
* [Self-Serve](/organization/integrations/feature-flag/self-serve/#change-tracking)
33+
* [Generic](/organization/integrations/feature-flag/generic/#change-tracking)

0 commit comments

Comments
 (0)