diff --git a/src/mailtemplates/productivity-report/productivity-report.plain.mustache b/src/mailtemplates/productivity-report/productivity-report.plain.mustache
index 4c23236ce4b3..00c584100ee4 100644
--- a/src/mailtemplates/productivity-report/productivity-report.plain.mustache
+++ b/src/mailtemplates/productivity-report/productivity-report.plain.mustache
@@ -14,4 +14,4 @@ Production updates last month: {{productionUpdates}}
Go to your Insights to learn more: {{unleashUrl}}/insights
This email was sent to {{userEmail}}. You’ve received this as you are a user of Unleash.
-If you wish to unsubscribe, go to you profile settings here.
+If you wish to unsubscribe, go to you profile settings on {{unleashUrl}}/profile
diff --git a/src/migrations/20241105123918-add-cascade-for-user-unsubscription.js b/src/migrations/20241105123918-add-cascade-for-user-unsubscription.js
new file mode 100644
index 000000000000..7d8b18e9aa9c
--- /dev/null
+++ b/src/migrations/20241105123918-add-cascade-for-user-unsubscription.js
@@ -0,0 +1,16 @@
+exports.up = function (db, cb) {
+ db.runSql(
+ `
+ ALTER TABLE user_unsubscription DROP CONSTRAINT user_unsubscription_user_id_fkey;
+ ALTER TABLE user_unsubscription
+ ADD CONSTRAINT user_unsubscription_user_id_fkey
+ FOREIGN KEY (user_id)
+ REFERENCES users(id) ON DELETE CASCADE;
+`,
+ cb,
+ );
+};
+
+exports.down = function (db, cb) {
+ db.runSql('', cb);
+};
diff --git a/src/server-dev.ts b/src/server-dev.ts
index 81a95d9f16c9..b3b21d479943 100644
--- a/src/server-dev.ts
+++ b/src/server-dev.ts
@@ -41,11 +41,9 @@ process.nextTick(async () => {
anonymiseEventLog: false,
responseTimeWithAppNameKillSwitch: false,
celebrateUnleash: true,
- featureSearchFeedbackPosting: true,
userAccessUIEnabled: true,
outdatedSdksBanner: true,
disableShowContextFieldSelectionValues: false,
- projectOverviewRefactorFeedback: true,
manyStrategiesPagination: true,
enableLegacyVariants: false,
extendedMetrics: true,
@@ -57,6 +55,7 @@ process.nextTick(async () => {
webhookDomainLogging: true,
releasePlans: false,
simplifyProjectOverview: true,
+ flagOverviewRedesign: true,
},
},
authentication: {
diff --git a/src/test/e2e/stores/api-token-store.e2e.test.ts b/src/test/e2e/stores/api-token-store.e2e.test.ts
index c7edd1ef7524..dbda4bb080d8 100644
--- a/src/test/e2e/stores/api-token-store.e2e.test.ts
+++ b/src/test/e2e/stores/api-token-store.e2e.test.ts
@@ -2,6 +2,7 @@ import dbInit, { type ITestDb } from '../helpers/database-init';
import getLogger from '../../fixtures/no-logger';
import type { IUnleashStores } from '../../../lib/types';
import { ApiTokenType } from '../../../lib/types/models/api-token';
+import { randomId } from '../../../lib/util';
let stores: IUnleashStores;
let db: ITestDb;
@@ -182,3 +183,46 @@ describe('count deprecated tokens', () => {
});
});
});
+
+describe('count project tokens', () => {
+ test('counts only tokens belonging to the specified project', async () => {
+ const project = await stores.projectStore.create({
+ id: randomId(),
+ name: 'project A',
+ });
+
+ const store = stores.apiTokenStore;
+ await store.insert({
+ secret: `default:default.${randomId()}`,
+ environment: 'default',
+ type: ApiTokenType.CLIENT,
+ projects: ['default'],
+ tokenName: 'token1',
+ });
+ await store.insert({
+ secret: `*:*.${randomId()}`,
+ environment: 'default',
+ type: ApiTokenType.CLIENT,
+ projects: ['*'],
+ tokenName: 'token2',
+ });
+
+ await store.insert({
+ secret: `${project.id}:default.${randomId()}`,
+ environment: 'default',
+ type: ApiTokenType.CLIENT,
+ projects: [project.id],
+ tokenName: 'token3',
+ });
+
+ await store.insert({
+ secret: `[]:default.${randomId()}`,
+ environment: 'default',
+ type: ApiTokenType.CLIENT,
+ projects: [project.id, 'default'],
+ tokenName: 'token4',
+ });
+
+ expect(await store.countProjectTokens(project.id)).toBe(2);
+ });
+});
diff --git a/src/test/e2e/stores/user-store.e2e.test.ts b/src/test/e2e/stores/user-store.e2e.test.ts
index 93f587fa9713..230699e41fa9 100644
--- a/src/test/e2e/stores/user-store.e2e.test.ts
+++ b/src/test/e2e/stores/user-store.e2e.test.ts
@@ -192,4 +192,7 @@ test('should delete user', async () => {
await expect(() => stores.userStore.get(user.id)).rejects.toThrow(
new NotFoundError('No user found'),
);
+
+ const deletedCount = await stores.userStore.countRecentlyDeleted();
+ expect(deletedCount).toBe(1);
});
diff --git a/src/test/fixtures/fake-api-token-store.ts b/src/test/fixtures/fake-api-token-store.ts
index 6b90064fceb6..d24f920e83e8 100644
--- a/src/test/fixtures/fake-api-token-store.ts
+++ b/src/test/fixtures/fake-api-token-store.ts
@@ -92,4 +92,8 @@ export default class FakeApiTokenStore
activeLegacyTokens: 0,
};
}
+
+ async countProjectTokens(): Promise {
+ return 0;
+ }
}
diff --git a/src/test/fixtures/fake-event-store.ts b/src/test/fixtures/fake-event-store.ts
index ea4b63438bf4..db17fa148666 100644
--- a/src/test/fixtures/fake-event-store.ts
+++ b/src/test/fixtures/fake-event-store.ts
@@ -18,7 +18,9 @@ class FakeEventStore implements IEventStore {
this.events = [];
}
- getProjectEventActivity(project: string): Promise {
+ getProjectRecentEventActivity(
+ project: string,
+ ): Promise {
throw new Error('Method not implemented.');
}
diff --git a/src/test/fixtures/fake-segment-store.ts b/src/test/fixtures/fake-segment-store.ts
index 96241181a31c..53f8a3937930 100644
--- a/src/test/fixtures/fake-segment-store.ts
+++ b/src/test/fixtures/fake-segment-store.ts
@@ -62,4 +62,8 @@ export default class FakeSegmentStore implements ISegmentStore {
}
destroy(): void {}
+
+ async getProjectSegmentCount(): Promise {
+ return 0;
+ }
}
diff --git a/src/test/fixtures/fake-user-store.ts b/src/test/fixtures/fake-user-store.ts
index a201d70c4029..f37b6c67d363 100644
--- a/src/test/fixtures/fake-user-store.ts
+++ b/src/test/fixtures/fake-user-store.ts
@@ -67,6 +67,10 @@ class UserStoreMock implements IUserStore {
return this.data.length;
}
+ async countRecentlyDeleted(): Promise {
+ return Promise.resolve(0);
+ }
+
async get(key: number): Promise {
return this.data.find((u) => u.id === key)!;
}
diff --git a/website/docs/availability.md b/website/docs/availability.md
new file mode 100644
index 000000000000..a394e86acaab
--- /dev/null
+++ b/website/docs/availability.md
@@ -0,0 +1,25 @@
+---
+title: Unleash Availability
+---
+
+Your Unleash [plan](#plans) and [version](#versioning) determine what features you have access to. Our documentation displays the availability for each feature using the following annotation:
+
+:::note Availability
+
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.7+`
+
+:::
+
+This is an example of a feature that is only available to Enterprise customers who are on version `5.7` or later.
+
+## Plans
+
+- [Open Source](https://www.getunleash.io/pricing) - Available on [GitHub](https://github.com/Unleash/unleash) under an Apache 2.0 license.
+- Pro - Currently not offered.
+- [Enterprise](https://www.getunleash.io/pricing) - Available as Pay-as-you-go or as an annual contract.
+
+## Versioning
+
+Unleash uses [semantic versioning](https://semver.org/) with release notes available on [GitHub](https://github.com/Unleash/unleash/releases). For detailed instructions on upgrading your version, see [Upgrading Unleash](../using-unleash/deploy/upgrading-unleash).
+
+[Unleash Edge](https://github.com/Unleash/unleash-edge) and our [SDKs](/reference/sdks) are versioned and released independently of Unleash. We recommend upgrading your SDKs and Unleash Edge to the latest versions to ensure compatibility, optimal performance, and access to the latest features and security updates.
diff --git a/website/docs/feature-flag-tutorials/flutter/a-b-testing.md b/website/docs/feature-flag-tutorials/flutter/a-b-testing.md
index 67fb051ee695..be633549b884 100644
--- a/website/docs/feature-flag-tutorials/flutter/a-b-testing.md
+++ b/website/docs/feature-flag-tutorials/flutter/a-b-testing.md
@@ -11,7 +11,7 @@ This article is a contribution by **[Ayush Bherwani](https://www.linkedin.com/in
After successfully integrating the first feature flag in the Unsplash sample app, let’s talk about how you can use Unleash to perform experimentation, also known as A/B testing, in Flutter to ship features more confidently.
-For this article, we’ll integrate feature flags for A/B testing to experiment with “like image” feature user experience. As an overview, the app is quite simple, with two screens displaying images and image details respectively. The behavior of the “image details” feature is controlled through an Unleash instance. You can check out the previous article, “[How to set up feature flags in Flutter](https://www.getunleash.io/blog/from-the-community-how-to-set-up-feature-flags-in-flutter)” for an overview of the code structure and implementation. For those who want to skip straight to the code, you can find it on [GitHub](https://github.com/AyushBherwani1998/unsplash_sample/).
+For this article, we’ll integrate feature flags for A/B testing to experiment with “like image” feature user experience. As an overview, the app is quite simple, with two screens displaying images and image details respectively. The behavior of the “image details” feature is controlled through an Unleash instance. For those who want to skip straight to the code, you can find it on [GitHub](https://github.com/AyushBherwani1998/unsplash_sample/).
Here’s a screenshot of the application:
@@ -22,7 +22,7 @@ In your Unleash instance, create a new feature flag called `likeOptionExperiment
-Now that you have created your feature flag, let’s create two new [variants](https://docs.getunleash.io/reference/feature-toggle-variants) “gridTile'' and “imageDetails” respectively. These variants will help you position your “like image” button.
+Now that you have created your feature flag, let’s create two new [variants](https://docs.getunleash.io/reference/feature-toggle-variants) `gridTile` and `imageDetails` respectively. These variants will help you position your **like image** button.
@@ -34,7 +34,7 @@ Below is a screenshot of experimentation in action based on the `likeOptionExper
For analytics and metrics, we’ll use [Mixpanel](https://mixpanel.com/) to track user behavior and usage patterns. We have chosen Mixpanel because it offers a user-friendly setup and in-depth user analytics and segmentation. Given that the project follows clean architecture and Test-Driven Development (TDD) principles, you’ll want to create an abstract layer to interact with the Mixpanel.
-Whenever a user opens the app, we track `like-variant` if `likeOptionExperiment` is enabled to tag them with their assigned variant (gridTile or imageDetails). The stored variant in Mixpanel can be used later to analyze how each variant impacts user behavior to like an image.
+Whenever a user opens the app, we track `like-variant` if `likeOptionExperiment` is enabled to tag them with their assigned variant (`gridTile` or `imageDetails`). The stored variant in Mixpanel can be used later to analyze how each variant impacts user behavior to like an image.
Whenever a user interacts with the `LikeButton`, we track `trackLikeEventForExperimentation`, along with their assigned variants. By correlating the `trackLikeEventForExperimentation` with the `like-variant`, you can effectively measure the impact of a variant on user behavior and make data-driven decisions. To learn how to correlate and generate reports, see the [Mixpanel docs](https://docs.mixpanel.com/docs/analysis/reports).
diff --git a/website/docs/feature-flag-tutorials/use-cases/a-b-testing.md b/website/docs/feature-flag-tutorials/use-cases/a-b-testing.md
index 791a2cc9aaf6..082fb956d023 100644
--- a/website/docs/feature-flag-tutorials/use-cases/a-b-testing.md
+++ b/website/docs/feature-flag-tutorials/use-cases/a-b-testing.md
@@ -1,112 +1,235 @@
---
-title: How to do A/B Testing
+title: How to do A/B Testing using Feature Flags
slug: /feature-flag-tutorials/use-cases/a-b-testing
---
-## What is A/B Testing?
+Feature flags are a great way to run A/B or multivariate tests with minimal code modifications, and Unleash offers built-in features that make it easy to get started. In this tutorial, we will walk through how to do an A/B test using Unleash with your application.
-**A/B testing** is a randomized controlled experiment where you test two or more versions of a feature to see which version performs better. If you have more than two versions, it's known as multivariate testing. Coupled with analytics, A/B and multivariate testing enable you to better understand your users and how to serve them better.
+## How to Perform A/B Testing with Feature Flags
-Feature flags are a great way to run A/B tests to decouple them from your code, and Unleash ships with features to make it easy to get started with. In this tutorial, we will walk through how to do an A/B test using Unleash with your application.
+To follow along with this tutorial, you need access to an Unleash instance to create and manage feature flags. Head over to our [Quick Start documentation](/quickstart) for options, including running locally or using an [Unleash SaaS instance](https://www.getunleash.io/pricing?).
-## How to Perform A/B Testing with Unleash
+With Unleash set up, you can use your application to talk to Unleash through one of our [SDKs](/reference/sdks).
-To follow along with this tutorial, you will need an Unleash instance. If you’d prefer to self-host Unleash, read our [Quickstart guide](/quickstart). Alternatively, if you’d like your project to be hosted by Unleash, go to [www.getunleash.io](https://www.getunleash.io/pricing?_gl=1*1ytmg93*_gcl_au*MTY3MTQxNjM4OS4xNzIxOTEwNTY5*_ga*OTkzMjI0MDMwLjE3MDYxNDc3ODM.*_ga_492KEZQRT8*MTcyNzQzNTQwOS4yMzcuMS4xNzI3NDM1NDExLjU4LjAuMA).
+In this tutorial, you will learn how to set up and run an A/B test using feature flags. You will learn:
-With Unleash set up, you can use your application to talk to Unleash through one of our SDKs.
+1. [How to use feature flags to define variants of your application for testing](#create-a-feature-flag)
+2. [Target specific users for each test variant](#target-users-for-ab-testing)
+3. [Manage cross-session visibility of test variants](#manage-user-session-behavior)
+4. [Connect feature flag impression data to conversion outcomes](#track-ab-testing-for-your-key-performance-metrics)
+5. [Roll out the winning variant to all users](#rollout-the-winning-variant-to-all-users)
-To conduct an A/B test, we will need to create the feature flag that will implement an activation strategy. In the next section, we will explore what strategies are and how they are configured in Unleash.
+You will also learn about how to [automate advanced A/B testing strategies](#multi-arm-bandit-tests-to-find-the-winning-variant) such as multi-arm bandit testing using feature flags.
-In the projects view, the Unleash platform shows a list of feature flags that you’ve generated. Click on the ‘New Feature Flag' button to create a new feature flag.
+### Create a Feature Flag
-
+To do A/B testing, we'll create a feature flag to implement the rollout strategy. After that, we'll explore what strategies are and how they are configured in Unleash.
-Next, you will create a feature flag on the platform and turn it on for your app.
+In the Unleash Admin UI, open a project and click **New feature flag**.
-Flags can be used with different purposes and we consider experimentation important enough to have its own flag type. Experimentation flags have a lifetime expectancy suited to let you run an experiment and gather enough data to know whether it was a success or not. Learn more about [feature flag types](/reference/feature-toggles#feature-flag-types) in our documentation.
+
-The feature flag we are creating is considered an ‘Experimentation’ flag type. The project will be ‘Default’ or the named project in which you are working in for the purpose of this tutorial. As the number of feature flags grows, you can organize them in your projects.
+Next, you will create a feature flag and turn it on.
-Read our docs on [Projects](/reference/projects) to learn more about how to configure and manage them for your team/organization. A description of the flag can help properly identify its specific purposes. However, this field is optional.
+Feature flags can be used for different purposes and we consider experimentation important enough to have its own flag type. Experimentation flags have a lifetime expectancy suited for running an experiment and gathering enough data to know whether the experiment was a success or not. The feature flag we are creating is considered an Experiment flag type.
-
+
-Once you have completed the form, you can click ‘Create feature flag’.
+Once you have completed the form, click **Create feature flag**.
-Your new feature flag has been created and is ready to be used. Upon returning to your projects view, enable the flag for your development environment, which makes it accessible to use in your app.
+Your new feature flag is now ready to be used. Next, we will configure the A/B testing strategy for your flag.
-
+### Target Users for A/B Testing
-Next, we will configure the A/B testing strategy for your new flag.
+With an A/B testing strategy, you’ll be able to:
-### Implementing a Default Activation Strategy for A/B Testing
+- Determine the percentage of users exposed to the new feature
+- Determine the percentage of users that get exposed to each version of the feature
-An important Unleash concept that enables developers to perform an A/B test is an [activation strategy](/reference/activation-strategies). An activation strategy defines who will be exposed to a particular flag or flags. Unleash comes pre-configured with multiple activation strategies that let you enable a feature only for a specified audience, depending on the parameters under which you would like to release a feature.
+To target users accordingly, let's create an [activation strategy](/reference/activation-strategies). This Unleash concept defines who will be exposed to a particular flag. Unleash comes pre-configured with multiple activation strategies that let you enable a feature only for a specified audience, depending on the parameters under which you would like to release a feature.
-Different strategies use different parameters. Predefined strategies are bundled with Unleash. The default strategy is the gradual rollout strategy with 100% rollout, which basically means that the feature is enabled for all users. In this case, we have only enabled the flag in the development environment for all users in the previous section.
+Different strategies use different parameters. Predefined strategies are bundled with Unleash. The default strategy is a gradual rollout to 100%, which means that the feature is enabled for all users. In this tutorial, we'll adjust the percentage of users who have access to the feature.
+:::note
Activation strategies are defined on the server. For server-side SDKs, activation strategy implementation is done on the client side. For frontend SDKs, the feature is calculated on the server side.
+:::
-There are two more advanced extensions of a default strategy that you will see available to customize in the form:
+Open your feature flag and click **Add strategy**.
+
+
+
+The gradual rollout strategy form has multiple fields that control the rollout of your feature. You can name the strategy something relevant to the A/B test you’re creating, but this is an optional field.
-- [Strategy Variants](/reference/strategy-variants)
-- [Strategy Constraints](/reference/strategy-constraints)
+
-Variants and constraints are not required for A/B testing. These additional customizations can be built on top of the overall strategy should you need more granular conditions for your feature beyond the rollout percentage.
+Next, configure the rollout percentage so only a certain portion of your users are targeted. For example, you can adjust the dial so that 35% of all users are targeted. The remaining percentage of users will not experience any variation of the new feature. Adjust the rollout dial to set the percentage of users the feature targets, or keep it at 100% to target all users.
+
+There are two more advanced extensions of a default strategy that you will see available to customize in the form:
-[Strategy variants](/reference/strategy-variants) can expose a particular version of a feature to select user bases when a flag is enabled. From there, a way to use the variants is to view the performance metrics and see which is more efficient. We can create several variations of this feature to release to users and gather performance metrics to determine which one yields better results.
+- [Strategy variants](/reference/strategy-variants)
+- [Strategy constraints](/reference/strategy-constraints)
-For A/B testing, _strategy variants_ are most applicable for more granular conditions of a feature release. In the next section, we’ll explore how to apply a strategy variant on top of an A/B test for more advanced use cases.
+With strategy variants and constraints, you can extend your overall strategy. They help you define more granular conditions for your feature beyond the rollout percentage. We recommend using strategy variants to configure an A/B test.
-### Applying Strategy Variants
+[Strategy variants](/reference/strategy-variants) let you expose a particular version of a feature to select user bases when a flag is enabled. You can then collect data to determine which variant performs better, which we'll cover later in this tutorial.
-Using strategy variants in your activation strategy is the canonical way to run A/B tests with Unleash and your application. You can expose a particular version of the feature to select user bases when a flag is enabled. From there, a way to use the variants is to view the performance metrics and see which is more efficient.
+Using strategy variants in your activation strategy is the canonical way to run A/B tests with Unleash and your application.
+
+
A variant has four components that define it:
-- **name**: This must be unique among the strategy's variants. When working with a feature with variants in a client, you will typically use the variant's name to find out which variant it is.
-- **weight**: The weight is the likelihood of any one user getting this specific variant. See the weights section for more info.
-- **value**
-- **(optional) payload**: A variant can also have an associated payload. Use this to deliver more data or context. See the payload section for more details.
+- a name: This must be unique among the strategy's variants. You typically use the name to identify the variant in your client.
+- a weight: The [variant weight](/reference/strategy-variants#variant-weight) is the likelihood of any one user getting this specific variant.
+- an optional payload: A variant can also have an associated [payload](/reference/strategy-variants#variant-payload) to deliver more data or context. The type defines the data format of the payload and can be one of the following options: `string`, `json`, `csv`, or `number`.
+- a value: specifies the payload data associated with the variant. Define this if you want to return a value other than `enabled`/`disabled`. It must correspond with the payload type.
-While teams may have different goals for measuring performance, Unleash enables you to configure a strategy for the feature variants within your application/service and the platform.
+Open the gradual rollout strategy, select the **Variants** tab, and click **Add variant**. Enter a unique name for the variant. For the purpose of this tutorial, we’ve created 2 variants: `variantA` and `variantB`. In a real-world use case, we recommend more specific names to be comprehensible and relevant to the versions of the feature you’re referencing. Create additional variants if you need to test more versions.
-## A/B Testing with Enterprise Security Automation
+Next, decide the percentage of users to target for each variant, known as the variant weight. By default, 50% of users will be targeted between 2 variants. For example, 50% of users within the 35% of users targeted from the rollout percentage you defined earlier would experience `variantA`. Toggle **Custom percentage** to change the default variant weights.
-For large-scale organizations, managing feature flags across many teams can be complex and challenging. Unleash was architected for your feature flag management to be scalable and traceable for enterprises, which boosts overall internal security posture while delivering software efficiently.
+
-After you have implemented an A/B test, we recommend managing it by:
+### Manage User Session Behavior
-- Tracking performance of feature releases within your application
-- Reviewing audit logs of each change to your flag configurations over time by project collaborators within your organization, which is exportable for reporting
-- Reviewing and approving change requests to your flags and strategy configurations
+Unleash is built to give developers confidence in their ability to run A/B tests effectively. One critical component of implementing A/B testing strategies is maintaining a consistent experience for each user across multiple user sessions.
-Read our documentation on how to effectively manage [feature flags at scale](/topics/feature-flags/best-practices-using-feature-flags-at-scale) while reducing security risks. Let’s walk through these recommended Unleash features in the subsequent sections.
+For example, user `uuid1234` should be the target of `variantA` regardless of their session. The original subset of users that get `variantA` will continue to experience that variation of the feature over time. At Unleash, we call this [stickiness](/reference/stickiness). You can define the parameter of stickiness in the gradual rollout form. By default, stickiness is calculated by `sessionId` and `groupId`.
-### Enabling Impression Data
+### Track A/B Testing for your Key Performance Metrics
-Once you have created a feature flag and configured your A/B test, you can use Unleash to collect insights about the ongoing results of the test. One way to collect this data is through enabling [impression data](/reference/impression-data#impression-event-data) per feature flag. Impression data contains information about a specific feature flag activation check. It’s important to review data from an A/B test, as this could inform you on how (and if) users interact with the feature you have released.
+An A/B testing strategy is most useful when you can track the results of a feature rollout to users. When your team has clearly defined the goals for your A/B tests, you can use Unleash to analyze how results tie back to key metrics, like conversion rates or time spent on a page. One way to collect this data is by enabling [impression data](/reference/impression-data) per feature flag. Impression data contains information about a specific feature flag activation check.
-Strategy variants are meant to work with impression data. You get the name of the variant to your analytics which allows you a better understanding of what happened, rather than seeing a simple true/false from your logs.
+To enable impression data for your rollout, navigate to your feature flag form and turn the toggle on.
-To enable impression data for your flag, navigate to your feature flag form and turn the toggle on.
+
-Next, in your application code, use the SDK to capture the impression events as they are being emitted in real time. Follow [language and framework-specific tutorials](/languages-and-frameworks) to learn how to capture the events and send them to data analytics and warehouse platforms of your choice.
+Next, in your application code, use the SDK to capture the impression events as they are being emitted in real time.
+Your client SDK will emit an impression event when it calls `isEnabled` or `getVariant`. Some front-end SDKs emit impression events only when a flag is enabled. You can define custom event types to track specific user actions. If you want to confirm that users from your A/B test have the new feature, Unleash will receive the `isEnabled` event. If you have created variants, the `getVariant` event type will be sent to Unleash.
-Now that the application is capturing impression events, you can configure the correct data fields and formatting to send to any analytics tool or data warehouse you use.
+Strategy variants are meant to work with impression data. You get the name of the variant sent to your analytics tool, which allows you a better understanding of what happened, rather than seeing a simple true/false from your logs.
-#### Collect Event Type Data
+The output from the impression data in your app may look like this code snippet:
-Your client SDK will emit an impression event when it calls `isEnabled` or `getVariant`. Some front-end SDKs emit impression events only when a flag is enabled.
+```js
+{
+ "eventType": "getVariant",
+ "eventId": "c41aa58b-d2c7-45cf-b668-7267f465e01a",
+ "context": {
+ "sessionId": 386689528,
+ "appName": "my-example-app",
+ "environment": "default"
+ },
+ "enabled": true,
+ "featureName": "ab-testing-example",
+ "impressionData": true,
+ "variant": "variantA"
+}
+```
-You can define custom event types to track specific user actions. If you want to confirm that users from your A/B test have the new feature, Unleash will receive the `isEnabled` event. If you have created one or more variations of the same feature, known as strategy variants, the `getVariant` event type will be sent to Unleash.
+In order to capture impression events in your app, follow our [language and framework-specific tutorials](/languages-and-frameworks).
-### Automating A/B Tests with Actions & Signals
+Now that your application is capturing impression events, you can configure the correct data fields and formatting to send to any analytics tool or data warehouse you use.
-Unleash provides the ability to automate your feature flags using [actions](/reference/actions) and [signals](/reference/signals). When running A/B tests, you can configure your projects to execute tasks in response to application metrics and thresholds you define. If an experimentation feature that targets a part of your user base logs errors, your actions can automatically disable the feature so your team is given the time to triage while still providing a seamless, alternative experience to users. In another case, you can use actions to modify the percentage of users targeted for variations of a feature based off users engaging with one variation more than the other.
+Here are two code examples of collecting impression data in an application to send to Google Analytics:
-A/B tests are performed safely and strategically with extra safeguards when you automate your flags based on user activity and other metrics of your choice.
+Example 1
+
+```js
+unleash.on(UnleashEvents.Impression, (e: ImpressionEvent) => {
+ // send to google analytics, something like
+ gtag("event", "screen_view", {
+ app_name: e.context.appName,
+ feature: e.featureName,
+ treatment: e.enabled ? e.variant : "Control", // in case we use feature disabled for control
+ });
+});
+```
+
+Example 2
+
+```js
+unleash.on(UnleashEvents.Impression, (e: ImpressionEvent) => {
+ if (e.enabled) {
+ // send to google analytics, something like
+ gtag("event", "screen_view", {
+ app_name: e.context.appName,
+ feature: e.featureName,
+ treatment: e.variant, // in case we use a variant for the control treatment
+ });
+ }
+});
+```
+
+In these example code snippets, `e` references the event object from the impression data output. Map these values to plug into the appropriate functions that make calls to your analytics tools and data warehouses.
+
+In some cases like in Example 1, you may want to use the "disabled feature" state as the "Control group".
+
+Alternatively, in Example 2, you can expose the feature to 100% of users and use two variants: "Control" and "Test". In either case, the variants are always used for the "Test" group. The difference is determined by how you use the "Control" group.
+
+An advantage of having your feature disabled for the Control group is that you can use metrics to see how many of the users are exposed to experiment(s) in comparison to the ones that are not. If you use only variants (for both the test and control group), you may see the feature metric as 100% exposed and would have to look deeper into the variant to know how many were exposed.
+
+Here is an example of a payload that is returned from Google Analytics that includes impression event data:
+
+```js
+{
+ "client_id": "unleash_client"
+ "user_id": "uuid1234"
+ "timestamp_micros": "1730407349525000"
+ "non_personalized_ads": true
+ "events": [
+ {
+ "name":"select_item"
+ "params": {
+ "items":[]
+ "event":"screen_view"
+ "app_name":"myAppName"
+ "feature":"myFeatureName"
+ "treatment":"variantValue"
+ }
+ }
+ ]
+}
+```
+
+By enabling impression data for your feature flag and listening to events within your application code, you can leverage this data flowing to your integrated analytics tools to make informed decisions faster and adjust your strategies based on real user behavior.
+
+### Rollout the Winning Variant to All Users
+
+After you have implemented your A/B test and measured the performance of a feature to a subset of users, you can decide which variant is the most optimal experience to roll out to all users in production.
+
+Unleash gives you control over which environments you release your feature to, when you release the feature, and to whom. Every team's release strategy may vary, but the overarching goal of A/B testing is to select the most effective experience for users, whether it be a change in your app's UI, a web performance improvement, or backend optimizations.
+
+When rolling out the winning variant, your flag may already be on in your production environment. Adjust the rollout strategy configurations to release to 100% of your user base in the Unleash Admin.
+
+After the flag has been available to 100% of users over time, archive the flag and clean up your codebase.
+
+## A/B Testing with Enterprise Automation
+
+With Unleash, you can automate your feature flags using [actions](/reference/actions) and [signals](/reference/signals). When running A/B tests, configure your projects to execute tasks in response to application metrics and thresholds you define. If an experimentation feature that targets a part of your user base logs errors, your actions can automatically disable the feature so your team is given the time to triage while still providing a seamless, alternative experience to users. In another case, you can use actions to modify the percentage of users targeted for variations of a feature based off users engaging with one variation more than the other.
+
+### Multi-arm Bandit Tests to Find the Winning Variant
+
+When running complex multivariate tests with numerous combinations, automating the process of finding the best variation of a feature is the most optimal, cost-effective approach for organizations with a large user base. [Multi-arm bandit tests](https://en.wikipedia.org/wiki/Multi-armed_bandit) are a powerful technique used in A/B testing to allocate traffic to different versions of a feature or application in a way that maximizes the desired outcome, such as conversion rate or click-through rate. This approach offers several advantages over traditional A/B testing and is a viable solution for large enterprise teams.
+
+The variants you created with Unleash would be the "arms" in the multi-bandit context. You can use a multi-arm bandit algorithm, such as [epsilon-greedy](https://www.geeksforgeeks.org/epsilon-greedy-algorithm-in-reinforcement-learning/) or [Thompson sampling](https://en.wikipedia.org/wiki/Thompson_sampling), to dynamically allocate traffic based on the performance of each variant. Experiment with different variants to gather more information. Allocate more traffic to the variants that are performing better. As the test progresses, the algorithm will adjust the traffic allocation to favor the variants that are showing promising results. After completing the test, you can analyze the data to determine the winning variant. By dynamically allocating traffic based on performance, multi-arm bandit tests can identify the winning variant more quickly than traditional A/B testing.
+
+
+
+> [Image Source: Matt Gershoff](https://blog.conductrics.com/balancing-earning-with-learning-bandits-and-adaptive-optimization/)
+
+To use Unleash to conduct a multi-arm bandit test, follow these steps:
+
+1. Collect the necessary data from each variant’s performance by enabling impression data for your feature flag
+2. Capture impression events in your application code
+3. Funnel the impression events captured from your application code to an external analytics tool
+4. Create [signal endpoints](/reference/signals) in Unleash and point them to your external analytics tools
+5. Create [actions](/reference/actions) in Unleash that can react to your signals
Learn how to configure [actions](/reference/actions) and [signals](/reference/signals) from our documentation to get started.
+
+This approach minimizes the "regret" associated with allocating traffic to lower-performing variants. Multi-arm bandit tests using Unleash can adapt to changing conditions, such as seasonal fluctuations or user behavior changes. In some cases, they can be used to ensure that users are not exposed to suboptimal experiences for extended periods.
+
+A/B tests are performed safely and strategically with extra safeguards when you automate your flags based on user activity and other metrics of your choice.
diff --git a/website/docs/how-to/how-to-add-sso-google.md b/website/docs/how-to/how-to-add-sso-google.md
index 9693c2c8719e..7a495a920db4 100644
--- a/website/docs/how-to/how-to-add-sso-google.md
+++ b/website/docs/how-to/how-to-add-sso-google.md
@@ -1,5 +1,5 @@
---
-title: '[Deprecated] How to add SSO with Google'
+title: 'How to add SSO with Google'
---
:::caution Deprecation notice
diff --git a/website/docs/how-to/how-to-import-export.mdx b/website/docs/how-to/how-to-import-export.mdx
index 2ed1ffa0327a..24c7e90e7f41 100644
--- a/website/docs/how-to/how-to-import-export.mdx
+++ b/website/docs/how-to/how-to-import-export.mdx
@@ -1,5 +1,5 @@
---
-title: '[Deprecated] Import & Export'
+title: 'Import & Export'
---
import ApiRequest from '@site/src/components/ApiRequest'
diff --git a/website/docs/how-to/how-to-schedule-feature-releases.mdx b/website/docs/how-to/how-to-schedule-feature-releases.mdx
index 6ee2a9486bf7..be41fead3312 100644
--- a/website/docs/how-to/how-to-schedule-feature-releases.mdx
+++ b/website/docs/how-to/how-to-schedule-feature-releases.mdx
@@ -12,9 +12,8 @@ There's a whole host of reasons why you may want to schedule the release of a fe
- **to make a feature available only up until a specific moment** (for a contest cutoff, for instance)
- **to make a feature available during a limited period** (for a 24 hour flash sale, for instance)
-There are two distinct ways to do this, depending on which version of Unleash you are running:
-- If you're using version 4.9 or later of Unleash Pro or Enterprise, you can (and should) [use strategy constraints](#strategy-constraints)
-- Otherwise, [use custom activation strategies](#custom-activation-strategies)
+Depending on which version of Unleash you are using, there are two ways to schedule a feature release. If you are using [Pro](/availability#plans) or [Enterprise](https://www.getunleash.io/pricing) version 4.9 or later, you can use [strategy constraints](#schedule-feature-releases-with-strategy-constraints).
+Otherwise, you can use [custom activation strategies](#schedule-feature-releases-with-custom-activation-strategies).
In this guide we'll schedule a feature for release at some point in time. The exact same logic applies if you want to make a feature available until some point in the future. Finally, if you want to only make a feature available during a limited time period, you can easily combine the two options.
@@ -81,4 +80,4 @@ To schedule feature releases without using strategy constraints, you can use cus
### Step 2: Implement the custom activation strategy in your clients
-In each of the client SDKs that will interact with your feature, implement the strategy ([the implementation how-to guide](../how-to/how-to-use-custom-strategies#step-3) has steps for all SDK types).
+In each of the client SDKs that will interact with your feature, implement the strategy ([the implementation how-to guide](../how-to/how-to-use-custom-strategies#step-3) has steps for all SDK types).
\ No newline at end of file
diff --git a/website/docs/quickstart.mdx b/website/docs/quickstart.mdx
index 85842d714514..2ab0bbab0c08 100644
--- a/website/docs/quickstart.mdx
+++ b/website/docs/quickstart.mdx
@@ -132,11 +132,11 @@ For other ways to get started locally, see the steps for [starting an Unleash se
#### Hosted by Unleash
-With our [Pro and Enterprise plans](https://www.getunleash.io/pricing), you can run Unleash in the cloud by using our hosted offerings.
+With our [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) plans, you can run Unleash in the cloud by using our hosted offerings.
#### Self-hosted
-Self-hosting Unleash is available for [Open-Source](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) customers. Visit [Self-hosting Unleash](/using-unleash/deploy) to learn more.
+Self-hosting Unleash is available for [Open Source](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) customers. Visit [Self-hosting Unleash](/using-unleash/deploy) to learn more.
## Next steps
diff --git a/website/docs/reference/api-tokens-and-client-keys.mdx b/website/docs/reference/api-tokens-and-client-keys.mdx
index 14464e2dbe52..1e59a54e6386 100644
--- a/website/docs/reference/api-tokens-and-client-keys.mdx
+++ b/website/docs/reference/api-tokens-and-client-keys.mdx
@@ -55,27 +55,18 @@ By default, only admin users can create API tokens, and only admins can see thei
However, any [client](#client-tokens client tokens) and [front-end tokens](#front-end-tokens) that are applicable to a project, will also be visible to any members of that project that have the `READ_PROJECT_API_TOKEN` permission (all project members by default).
Similarly, any project members with the `CREATE_PROJECT_API_TOKEN` permission can also create client and front-end tokens for that specific project ([how to create project API tokens](../how-to/how-to-create-project-api-tokens)).
-### Admin tokens
-
-**Admin tokens** grant _full read and write access_ to all resources in the Unleash server API. Admin tokens have access to all projects, all environments, and all root resources (find out more about [resources in the RBAC document](../reference/rbac#core-principles)).
-
-Use admin tokens to:
-
-- Automate Unleash behavior such as creating feature flags, projects, etc.
-- Write custom Unleash UIs to replace the default Unleash admin UI.
-Do **not** use admin tokens for:
-- [Client SDKs](../reference/sdks): You will _not_ be able to read flag data from multiple environments. Use [client tokens](#client-tokens) instead.
-
-Support for scoped admin tokens with more fine-grained permissions is currently in the planning stage.
+### Admin tokens
-**Deprecation Notice**
-We do not recommend using admin tokens anymore, they are not connected to any user, and as such is a lot harder to track.
-* For OSS and Pro users, we recommend using [Personal Access Tokens](#personal-access-tokens) instead.
-* Enterprise users have the option to use [Service accounts](./service-accounts).
+:::warning
+Admin tokens are deprecated. Use other tokens types:
+- With [Open Source](https://www.getunleash.io/pricing) and [Pro](../availability#plans), use [personal access tokens](#personal-access-tokens).
+- With [Enterprise](https://www.getunleash.io/pricing), use [service accounts](./service-accounts).
+:::
+**Admin tokens** grant _full read and write access_ to all resources in the Unleash server API. Admin tokens have access to all projects, all environments, and all root resources (find out more about [resources in the RBAC document](../reference/rbac#core-principles)).
### Personal access tokens
diff --git a/website/docs/reference/api/legacy/unleash/admin/segments.mdx b/website/docs/reference/api/legacy/unleash/admin/segments.mdx
index ab99ce927d78..81d0503a8f93 100644
--- a/website/docs/reference/api/legacy/unleash/admin/segments.mdx
+++ b/website/docs/reference/api/legacy/unleash/admin/segments.mdx
@@ -6,7 +6,7 @@ import ApiRequest from '@site/src/components/ApiRequest'; export const basePath
:::note Availability
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.13+`
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.13+`
:::
diff --git a/website/docs/reference/feature-toggles.mdx b/website/docs/reference/feature-toggles.mdx
index fdd0e5f9dea2..519ee79c5c32 100644
--- a/website/docs/reference/feature-toggles.mdx
+++ b/website/docs/reference/feature-toggles.mdx
@@ -125,7 +125,7 @@ If an archived feature is revived, it starts a new lifecycle with a new [initial
:::note Availability
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing)
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing)
**Unleash version**: `5.7+` | **Unleash Edge version**: `13.1+` | **Unleash Proxy version**: `0.18+`. Requires [SDK compatibility](../reference/sdks#server-side-sdk-compatibility-table) for variants.
:::
@@ -151,7 +151,7 @@ Note that metrics are affected only by child feature flag evaluations.
:::note Availability
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.12+`
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.12+`
:::
diff --git a/website/docs/reference/insights.mdx b/website/docs/reference/insights.mdx
index 51ba7db67918..ad5d989512d0 100644
--- a/website/docs/reference/insights.mdx
+++ b/website/docs/reference/insights.mdx
@@ -6,7 +6,7 @@ import Figure from '@site/src/components/Figure/Figure.tsx'
:::note Availability
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `6.0+`
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `6.0+`
:::
diff --git a/website/docs/reference/integrations/jira-cloud-plugin-installation.mdx b/website/docs/reference/integrations/jira-cloud-plugin-installation.mdx
index 072e25c18317..14b8b8d70e94 100644
--- a/website/docs/reference/integrations/jira-cloud-plugin-installation.mdx
+++ b/website/docs/reference/integrations/jira-cloud-plugin-installation.mdx
@@ -5,7 +5,7 @@ import Figure from '@site/src/components/Figure/Figure.tsx'
:::note Availability
-**Version**: `4.0+`
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.0+`
:::
@@ -24,8 +24,6 @@ For Jira Data Center, check out the [Jira Server plugin](jira-server-plugin-inst
You will need an Unleash admin user to configure the access tokens needed to connect the plugin to Unleash.
-This plugin requires an Unleash Pro or an Unleash Enterprise instance.
-
We recommend using a [service account](../service-accounts.md) token for communicating with Unleash. Service accounts are also required to integrate with [change requests](../change-requests)
### Jira
diff --git a/website/docs/reference/network-view.mdx b/website/docs/reference/network-view.mdx
index bac9610240d5..13f34553cbfa 100644
--- a/website/docs/reference/network-view.mdx
+++ b/website/docs/reference/network-view.mdx
@@ -6,7 +6,7 @@ import Figure from '@site/src/components/Figure/Figure.tsx'
:::note Availability
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.21+`
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.21+`
:::
diff --git a/website/docs/reference/notifications.md b/website/docs/reference/notifications.md
index b4ea9787395e..e0a1153a6a82 100644
--- a/website/docs/reference/notifications.md
+++ b/website/docs/reference/notifications.md
@@ -4,7 +4,7 @@ title: Notifications
:::note Availability
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.22+`
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.22+`
:::
diff --git a/website/docs/reference/projects.mdx b/website/docs/reference/projects.mdx
index 22ee9c95d190..10fe92474fbb 100644
--- a/website/docs/reference/projects.mdx
+++ b/website/docs/reference/projects.mdx
@@ -17,7 +17,7 @@ By default, projects have an open [collaboration mode](./project-collaboration-m
:::note Availability
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
:::
@@ -31,7 +31,7 @@ To create a new project:
:::note Availability
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
:::
@@ -45,7 +45,7 @@ The available project settings depend on a user's [root and project roles](./rba
:::note Availability
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing). | **Version**: `6.3+`
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing). | **Version**: `6.3+`
:::
@@ -67,7 +67,7 @@ To revive an archived project, go to **Projects > Archived projects** and click
:::note Availability
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
:::
diff --git a/website/docs/reference/rbac.md b/website/docs/reference/rbac.md
index fb1dd2c0072a..3e27001683d6 100644
--- a/website/docs/reference/rbac.md
+++ b/website/docs/reference/rbac.md
@@ -29,8 +29,8 @@ Unleash has two levels in its hierarchy of resources:
## Predefined roles
Unleash comes with a set of built-in predefined roles that you can use. The _root roles_ are available to all Unleash
-users, while the _project-based roles_ are only available to Pro and Enterprise users. The below table lists the roles,
-what they do, and what plans they are available in. Additionally, Enterprise users can create their
+users, while the _project-based roles_ are only available to [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) users. The below table lists the roles,
+what they do, and what plans they are available in. Additionally, [Enterprise](https://www.getunleash.io/pricing) users can create their
own [custom root roles](#custom-root-roles) and [custom project roles](#custom-project-roles).
When you add a new user, you can assign them one of the root roles listed below.
@@ -40,8 +40,8 @@ When you add a new user, you can assign them one of the root roles listed below.
| **Admin** | Root | Users with the root admin role have superuser access to Unleash and can perform any operation within the Unleash platform. | All versions |
| **Editor** | Root | Users with the root editor role have access to most features in Unleash, but can not manage users and roles in the root scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default. | All versions |
| **Viewer** | Root | Users with the root viewer role can only read root resources in Unleash. Viewers can be added to specific projects as project members. Users with the viewer role may not view API tokens. | All versions |
-| **Owner** | Project | Users with the project owner role have full control over the project, and can add and manage other users within the project context, manage feature flags within the project, and control advanced project features like archiving and deleting the project. | Pro and Enterprise |
-| **Member** | Project | Users with the project member role are allowed to view, create, and update feature flags within a project, but have limited permissions in regards to managing the project's user access and can not archive or delete the project. | Pro and Enterprise |
+| **Owner** | Project | Users with the project owner role have full control over the project, and can add and manage other users within the project context, manage feature flags within the project, and control advanced project features like archiving and deleting the project. | [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) |
+| **Member** | Project | Users with the project member role are allowed to view, create, and update feature flags within a project, but have limited permissions in regards to managing the project's user access and can not archive or delete the project. | [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) |
## Custom Root Roles
diff --git a/website/docs/reference/resource-limits.mdx b/website/docs/reference/resource-limits.mdx
index f62700e9ab73..0d5338935c64 100644
--- a/website/docs/reference/resource-limits.mdx
+++ b/website/docs/reference/resource-limits.mdx
@@ -15,7 +15,7 @@ To ensure that Unleash operates smoothly, it includes resource limits for some o
The resources and their respective limits and environment variables are:
-| Resource | OSS limit | Pro limit | Enterprise limit | Environment variable |
+| Resource | [Open Source](https://www.getunleash.io/pricing) limit | [Pro](/availability#plans) limit | [Enterprise](https://www.getunleash.io/pricing) limit | Environment variable |
|----------------------------------------------------------------|----------:|----------:|-----------------:|------------------------------------------------|
| [Feature flags](./feature-toggles)[^1] | 5,000 | 5,000 | 50,000 | `UNLEASH_FEATURE_FLAGS_LIMIT` |
| [Strategies](./activation-strategies) per flag per environment | 30 | 30 | 30 | `UNLEASH_FEATURE_ENVIRONMENT_STRATEGIES_LIMIT` |
@@ -51,8 +51,6 @@ If you try to set their limits lower than that, Unleash will automatically adjus
If you operate a self-hosted Unleash instance, you can adjust the limit yourself. For hosted users of Unleash, you'll need to reach out and talk to your Unleash contact.
-The only limits that can't be changed, are
-- the limits for projects and environments for OSS instances
-- the limits for projects and environments for Pro instances
+The only limits that can't be changed, are projects and environments for [Open Source](https://www.getunleash.io/pricing) and [Pro](/availability#plans) instances.
[^1]: Archived feature flags do not count towards your feature flag total. The limit only applies to active (i.e. not archived) feature flags.
diff --git a/website/docs/reference/segments.mdx b/website/docs/reference/segments.mdx
index c69c1ce6c45b..f1a456ef1e97 100644
--- a/website/docs/reference/segments.mdx
+++ b/website/docs/reference/segments.mdx
@@ -7,7 +7,7 @@ import VideoContent from '@site/src/components/VideoContent.jsx'
:::note Availability
-**Version**: `4.13+` for [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
+**Version**: `4.13+` for [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
**Version**: `5.5+` for [Open Source](https://www.getunleash.io/pricing).
:::
@@ -42,11 +42,11 @@ If an activation strategy has a segment _and_ additional constraints applied, th
In theory, you could create segments with a thousand constraints, each with a million values. But this wouldn't scale well, so there are limitations in place to stop you from doing this. Unleash enforces the following limits on use of segments:
-- If you're on a Pro plan
+- If you're on a [Pro](/availability#plans) plan:
A segment can have **at most 250 values** specified across all of its constraints. That means that if you add a constraint that uses 10 values, you will have 240 more values to use for any other constraints you add to the same segment.
-- If you're on an Enterprise plan
+- If you're on an [Enterprise](https://www.getunleash.io/pricing) plan:
A segment can have **at most 1000 values** specified across all of its constraints. That means that if you add a constraint that uses 70 values, you will have 930 more values to use for any other constraints you add to the same segment.
diff --git a/website/docs/reference/terraform.mdx b/website/docs/reference/terraform.mdx
new file mode 100644
index 000000000000..8f2411565898
--- /dev/null
+++ b/website/docs/reference/terraform.mdx
@@ -0,0 +1,76 @@
+---
+title: Using Unleash through Terraform
+description: "Set up and configure your Unleash instance using infastructure as code."
+---
+
+:::note Availability
+
+**Version**: `5.6+`
+
+:::
+
+
+## Overview
+
+The [Unleash Terraform provider](https://github.com/Unleash/terraform-provider-unleash) enables you to manage and configure Unleash programmatically, leveraging infrastructure as code (IaC) for automated and scalable configuration.
+
+This provider is designed to help you with the **initial setup and configuration** of an instance. The provider does not support managing feature flags through Terraform. Since most [feature flags are short-lived](/topics/feature-flags/feature-flag-best-practices#7-make-flags-short-lived), we recommend managing them through the Unleash Admin UI.
+
+For a detailed video tutorial, check out [Managing Unleash through Terraform](https://www.youtube.com/watch?v=B4OIBC1u1ns).
+For more examples of specific resources and data sources, visit the [Terraform registry](https://registry.terraform.io/providers/Unleash/unleash/latest/docs/data-sources/permission).
+
+## Manage Terraform access
+
+The permissions of the API token you use with Terraform and your Unleash [plan](https://www.getunleash.io/pricing) determine which objects Terraform can manage:
+- For [Open Source](https://www.getunleash.io/pricing) and [Pro](../availability#plans), use [personal access tokens](/reference/api-tokens-and-client-keys#personal-access-tokens).
+- For [Enterprise](https://www.getunleash.io/pricing), use [service accounts](/reference/service-accounts). For larger teams, we recommend multiple service accounts with different permissions and separate Terraform repositories for each team under their respective projects.
+
+## Resources
+
+### API tokens
+
+- `unleash_api_token`: Manage access and maintain secure communication with verified integrations.
+
+Example usage:
+```hcl
+resource "unleash_api_token" "client_token" {
+ token_name = "client_token"
+ type = "client"
+ expires_at = "2024-12-31T23:59:59Z"
+ project = "default"
+ environment = "development"
+}
+```
+
+### Projects
+
+- `unleash_project`: Create and manage projects.
+- `unleash_project_access`: Assign access roles and users to specific project resources.
+
+### Users and roles
+
+- `unleash_role`: Define permissions systematically.
+- `unleash_user`: Automate user management. Use `send_email = true` to generate an invitation link.
+
+### Service accounts
+
+- `unleash_service_account`: Define and manage service accounts for secure automated access.
+- `unleash_service_account_token`: Generate tokens associated with service accounts.
+
+### Single sign-on protocols
+
+- `unleash_oidc`: Manage your [OpenID Connect configuration](../how-to/how-to-add-sso-open-id-connect).
+- `unleash_saml`: Manage your [SAML configuration](../how-to/sso).
+
+For example usage and schemas, visit the resources documentation of the [Unleash Terraform provider](https://github.com/Unleash/terraform-provider-unleash/tree/main/docs/resources).
+
+## Data sources
+
+You can use the following data sources to fetch resources from Unleash:
+
+- `unleash_project`
+- `unleash_user`
+- `unleash_role`
+- `unleash_permission`
+
+For example usage and schemas, visit the data sources documentation of the [Unleash Terraform provider](https://github.com/Unleash/terraform-provider-unleash/tree/main/docs/data-sources).
\ No newline at end of file
diff --git a/website/docs/understanding-unleash/proxy-hosting.mdx b/website/docs/understanding-unleash/proxy-hosting.mdx
index 20b6f499230b..b64f1d46e37e 100644
--- a/website/docs/understanding-unleash/proxy-hosting.mdx
+++ b/website/docs/understanding-unleash/proxy-hosting.mdx
@@ -23,7 +23,7 @@ In general, we recommend you use Edge over the [Frontend API](https://docs.getun
If you want Unleash to host the Frontend API for you, you should be aware of the following limitations:
-- This is only available to Pro and Enterprise customers who have signed up for a managed Unleash instance.
+- This is only available to [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) customers who have signed up for a managed Unleash instance.
- We allow short spikes in traffic and our adaptive infrastructure will automatically scale to your needs.
- Please check the [Fair Use Policy](https://www.getunleash.io/fair-use-policy) to see the limits of the Unleash-hosted Frontend API.
- There's no guarantee that it'll be geographically close to your end users, this means your end users might be getting slower response times on feature flag evaluations.
@@ -45,12 +45,12 @@ Hosting Edge requires a little more setup than the Unleash-hosted Frontend API d
:::note Availability
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
:::
-Unleash no longer hosts instances of the proxy, but makes the [Frontend API](../reference/front-end-api) available to all Pro and Enterprise customers. The API is backed by an Amazon RDS database. Your applications can connect to the frontend API from your own cloud or from other hosting solutions.
+Unleash no longer hosts instances of the proxy, but makes the [Frontend API](../reference/front-end-api) available to all [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) customers. The API is backed by an Amazon RDS database. Your applications can connect to the frontend API from your own cloud or from other hosting solutions.
In order to access the frontend API you'll need:
- A [Frontend API key](../reference/api-tokens-and-client-keys#front-end-tokens) for the environment you'd like to use.
@@ -66,7 +66,7 @@ While this is easy to get started with, it comes with the limitations described
:::note Availability
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
:::
@@ -155,7 +155,7 @@ Please take note of the section covering features Edge does not currently suppor
:::note Availability
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
:::
diff --git a/website/docs/understanding-unleash/the-anatomy-of-unleash.mdx b/website/docs/understanding-unleash/the-anatomy-of-unleash.mdx
index 066ee050f173..472b01646875 100644
--- a/website/docs/understanding-unleash/the-anatomy-of-unleash.mdx
+++ b/website/docs/understanding-unleash/the-anatomy-of-unleash.mdx
@@ -26,7 +26,7 @@ Some things in Unleash are configured and defined on the root level. These optio
All Unleash instances must have at least one project at any given time. New instances get a project called “Default”.
-Pro and Enterprise customers can create, rename, and delete projects as they wish (as long as there is always **at least one project**). Open-source users, on the other hand, only get access to the Default project.
+[Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) customers can create, rename, and delete projects. [Open Source](https://www.getunleash.io/pricing) users have a single project called 'Default'.
{
+ const { defaultCreateSitemapItems, ...rest } = params;
+ const items = await defaultCreateSitemapItems(rest);
+ return items.filter(
+ (item) => !item.url.includes('/page/'),
+ );
+ },
+ },
},
],
],
diff --git a/website/sidebars.ts b/website/sidebars.ts
index 36891126a7a0..00d463103887 100644
--- a/website/sidebars.ts
+++ b/website/sidebars.ts
@@ -445,7 +445,7 @@ const sidebars: SidebarsConfig = {
],
},
{
- label: 'Integrations',
+ label: 'Integrations and automation',
type: 'category',
link: { type: 'doc', id: 'reference/integrations/index' },
items: [
@@ -461,9 +461,100 @@ const sidebars: SidebarsConfig = {
],
},
'reference/integrations/slack-app',
- 'reference/integrations/slack',
'reference/integrations/teams',
'reference/integrations/webhook',
+ {
+ type: 'doc',
+ label: 'Terraform',
+ id: 'reference/terraform',
+ },
+ ],
+ },
+ {
+ type: 'category',
+ link: {
+ type: 'generated-index',
+ title: 'Self-Hosting Unleash',
+ description:
+ 'All you need to learn how to deploy and manage your own Unleash instance.',
+ slug: '/using-unleash/deploy',
+ },
+ label: 'Self-hosting',
+ items: [
+ 'using-unleash/deploy/getting-started',
+ 'using-unleash/deploy/configuring-unleash',
+ 'using-unleash/deploy/database-setup',
+ 'using-unleash/deploy/database-backup',
+ 'using-unleash/deploy/email-service',
+ 'using-unleash/deploy/google-auth-hook',
+ 'using-unleash/deploy/upgrading-unleash',
+ 'using-unleash/deploy/securing-unleash',
+ 'using-unleash/deploy/license-keys',
+ ],
+ },
+ {
+ label: 'Single sign-on',
+ items: [
+ 'how-to/how-to-add-sso-open-id-connect',
+ 'how-to/how-to-add-sso-saml',
+ 'how-to/how-to-add-sso-saml-keycloak',
+ 'how-to/how-to-add-sso-azure-saml',
+ 'how-to/how-to-setup-sso-keycloak-group-sync',
+ ],
+ type: 'category',
+ link: {
+ type: 'generated-index',
+ title: 'How-to: Single sign-on',
+ description: 'Single sign-on guides.',
+ slug: '/how-to/sso',
+ },
+ },
+ {
+ label: 'Automatic provisioning',
+ items: [
+ 'how-to/how-to-setup-provisioning-with-okta',
+ 'how-to/how-to-setup-provisioning-with-entra',
+ ],
+ type: 'category',
+ link: {
+ type: 'generated-index',
+ title: 'How to: Provisioning',
+ description: 'Provisioning how-to guides.',
+ slug: '/how-to/provisioning',
+ },
+ },
+ {
+ type: 'category',
+ label: 'Unleash Edge',
+ collapsed: true,
+ link: {
+ type: 'doc',
+ id: 'generated/unleash-edge',
+ },
+ items: [
+ 'generated/unleash-edge/concepts',
+ 'generated/unleash-edge/deploying',
+ ],
+ },
+ 'generated/unleash-proxy',
+ {
+ label: 'Troubleshooting',
+ type: 'category',
+ link: {
+ type: 'generated-index',
+ title: 'How-to: troubleshooting',
+ description:
+ 'Troubleshooting common problems. If you want to suggest new items, please phrase the title as a concrete problem',
+ slug: '/using-unleash/troubleshooting',
+ },
+ items: [
+ 'using-unleash/troubleshooting/cors',
+ 'using-unleash/troubleshooting/https',
+ 'using-unleash/troubleshooting/email-service',
+ 'using-unleash/troubleshooting/feature-not-available',
+ 'using-unleash/troubleshooting/flag-exposure',
+ 'using-unleash/troubleshooting/flag-not-returned',
+ 'using-unleash/troubleshooting/flag-abn-test-unexpected-result',
],
},
{
@@ -538,10 +629,7 @@ const sidebars: SidebarsConfig = {
description: 'Environments how-to guides.',
slug: '/how-to/env',
},
- items: [
- 'how-to/how-to-import-export',
- 'how-to/how-to-environment-import-export',
- ],
+ items: ['how-to/how-to-environment-import-export'],
},
{
label: 'Users and permissions',
@@ -561,96 +649,8 @@ const sidebars: SidebarsConfig = {
slug: '/how-to/users-and-permissions',
},
},
- {
- label: 'Single sign-on SSO',
- items: [
- 'how-to/how-to-add-sso-open-id-connect',
- 'how-to/how-to-add-sso-saml',
- 'how-to/how-to-add-sso-saml-keycloak',
- 'how-to/how-to-add-sso-azure-saml',
- 'how-to/how-to-setup-sso-keycloak-group-sync',
- 'how-to/how-to-add-sso-google',
- ],
- type: 'category',
- link: {
- type: 'generated-index',
- title: 'How-to: Single sign-on',
- description: 'Single sign-on guides.',
- slug: '/how-to/sso',
- },
- },
- {
- label: 'Automatic provisioning',
- items: [
- 'how-to/how-to-setup-provisioning-with-okta',
- 'how-to/how-to-setup-provisioning-with-entra',
- ],
- type: 'category',
- link: {
- type: 'generated-index',
- title: 'How to: Provisioning',
- description: 'Provisioning how-to guides.',
- slug: '/how-to/provisioning',
- },
- },
],
},
- {
- type: 'category',
- link: {
- type: 'generated-index',
- title: 'Self-Hosting Unleash',
- description:
- 'All you need to learn how to deploy and manage your own Unleash instance.',
- slug: '/using-unleash/deploy',
- },
- label: 'Self-Hosting Unleash',
- items: [
- 'using-unleash/deploy/getting-started',
- 'using-unleash/deploy/configuring-unleash',
- 'using-unleash/deploy/database-setup',
- 'using-unleash/deploy/database-backup',
- 'using-unleash/deploy/email-service',
- 'using-unleash/deploy/google-auth-hook',
- 'using-unleash/deploy/upgrading-unleash',
- 'using-unleash/deploy/securing-unleash',
- 'using-unleash/deploy/license-keys',
- ],
- },
- {
- label: 'Troubleshooting',
- type: 'category',
- link: {
- type: 'generated-index',
- title: 'How-to: troubleshooting',
- description:
- 'Troubleshooting common problems. If you want to suggest new items, please phrase the title as a concrete problem',
- slug: '/using-unleash/troubleshooting',
- },
- items: [
- 'using-unleash/troubleshooting/cors',
- 'using-unleash/troubleshooting/https',
- 'using-unleash/troubleshooting/email-service',
- 'using-unleash/troubleshooting/feature-not-available',
- 'using-unleash/troubleshooting/flag-exposure',
- 'using-unleash/troubleshooting/flag-not-returned',
- 'using-unleash/troubleshooting/flag-abn-test-unexpected-result',
- ],
- },
- {
- type: 'category',
- label: 'Unleash Edge',
- collapsed: true,
- link: {
- type: 'doc',
- id: 'generated/unleash-edge',
- },
- items: [
- 'generated/unleash-edge/concepts',
- 'generated/unleash-edge/deploying',
- ],
- },
- 'generated/unleash-proxy',
],
},
{
diff --git a/website/static/img/tutorial-building-blocks-strategy-variants.png b/website/static/img/tutorial-building-blocks-strategy-variants.png
new file mode 100644
index 000000000000..e1cfd4ecaa29
Binary files /dev/null and b/website/static/img/tutorial-building-blocks-strategy-variants.png differ
diff --git a/website/static/img/use-case-ab-testing-vs-bandit.png b/website/static/img/use-case-ab-testing-vs-bandit.png
new file mode 100644
index 000000000000..58283439e6d8
Binary files /dev/null and b/website/static/img/use-case-ab-testing-vs-bandit.png differ
diff --git a/website/static/img/use-case-create-experiment-flag.png b/website/static/img/use-case-create-experiment-flag.png
new file mode 100644
index 000000000000..623f218daed5
Binary files /dev/null and b/website/static/img/use-case-create-experiment-flag.png differ
diff --git a/website/static/img/use-case-experiment-add-strategy.png b/website/static/img/use-case-experiment-add-strategy.png
new file mode 100644
index 000000000000..bc498afd5207
Binary files /dev/null and b/website/static/img/use-case-experiment-add-strategy.png differ
diff --git a/website/static/img/use-case-experiment-enable-impression-data.png b/website/static/img/use-case-experiment-enable-impression-data.png
new file mode 100644
index 000000000000..d4f1e2357430
Binary files /dev/null and b/website/static/img/use-case-experiment-enable-impression-data.png differ
diff --git a/website/static/img/use-case-experiment-gradual-rollout.png b/website/static/img/use-case-experiment-gradual-rollout.png
new file mode 100644
index 000000000000..d87b950b5ea2
Binary files /dev/null and b/website/static/img/use-case-experiment-gradual-rollout.png differ
diff --git a/website/static/img/use-case-experiment-variants.png b/website/static/img/use-case-experiment-variants.png
new file mode 100644
index 000000000000..6ed1a41e5135
Binary files /dev/null and b/website/static/img/use-case-experiment-variants.png differ
diff --git a/website/static/img/use-case-new-flag.png b/website/static/img/use-case-new-flag.png
new file mode 100644
index 000000000000..6904b7aa7501
Binary files /dev/null and b/website/static/img/use-case-new-flag.png differ
-