From ee6a2d7b7a29ce1acc896b6845e903dc63f5c672 Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Date: Wed, 9 Jul 2025 08:47:48 -0300 Subject: [PATCH 01/14] doc: add flags core management guide --- docs/docs/managing-flags/_category_.json | 4 + docs/docs/managing-flags/core-management.md | 82 +++++++++++++++++++++ 2 files changed, 86 insertions(+) create mode 100644 docs/docs/managing-flags/_category_.json create mode 100644 docs/docs/managing-flags/core-management.md diff --git a/docs/docs/managing-flags/_category_.json b/docs/docs/managing-flags/_category_.json new file mode 100644 index 000000000000..e2ce7fc8f7af --- /dev/null +++ b/docs/docs/managing-flags/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Managing Flags", + "position": 10 +} \ No newline at end of file diff --git a/docs/docs/managing-flags/core-management.md b/docs/docs/managing-flags/core-management.md new file mode 100644 index 000000000000..6e72048d8fdc --- /dev/null +++ b/docs/docs/managing-flags/core-management.md @@ -0,0 +1,82 @@ +--- +title: Core Management +sidebar_label: Core Management +sidebar_position: 1 +--- + +Flags in Flagsmith are used to categorize and monitor user actions or events, such as detecting spam or abuse. This guide covers how to create, edit, clone, and delete flags in your project. + +--- + +## Creating a Flag + +To create a new feature flag: + +1. Go to the **Features** section in your dashboard. +2. Click **Create Feature**. +3. Enter a descriptive name for your flag (e.g., `new_ui_enabled`). +4. Fill in the available fields according to the specifications of your feature. Note that these values are applied to all your [environments]. You can edit each environment individually later. + - **Enabled by default**: determines the initial state of the flag for all environments. This can be edited for each environment later. + - **Value** (optional): additionally to their boolean value, you can choose a format and a value for your flag. + - **Tags** (optional): organise your flags by tags or add `protected`to prevent them from accidentally being deleted. + - **Description** (optional): add a feature flag description. + - **Server-side only**: enabling this prevents your flag from being accessed by client-side SDKs. +5. Click **Create Feature**. + +:::tip +By clicking the **Create A/B/n Test** button, you can define values for A/B testing. To learn more about this operation, check the [A/B Testing guide](../advanced-use/ab-testing). +::: + +--- + +## Editing a Flag + +You create feature flags once per project, but you edit them within each environment. To edit an existing flag: + +1. While on the **Environments** tab on the dashboard, use the dropdown to select the environment where you want to apply the changes. +2. Locate the feature flag you want to edit and click on it. You can use the search bar to find the flag by its name. + +:::tip +If you just want to toggle the feature flag *on* or *off*, use the switch under the **View** column in the list view. +::: + +3. On the **Value** tab, you can set the flag to be on/off, as well as editing a value for it. Click the **Update Feature Value** to save your changes. +4. Optionally create segment-specific features and define **Segment Overrides**. Check the documentation to learn more about [Segment Overrides](../segments/segment-overrides.md). Save any changes by clicking the **Update Segment Overrides** button. +5. On the **Settings** tab, you can: + - Add tags to your feature flag. + - Assign it to specific *users* and *groups*. + - Update the flag's description. + - Mark the flag as **Server-side only** to prevent it being accessed by client-side SDKs. + - Set the **Archived** status to filter the flag as no longer relevant. Note that the flag will still be returned by the endpoint as before. + Click **Update Settings** to save your changes. + +:::tip +Changes made in the **Settings** tab affect all environments. Changes made in other tabs while editing a feature flag are valid only for the selected environment. +::: + +--- + +## Deleting a Flag + +To delete a feature flag: + +1. In the **Features** section, locate the flag you want to remove and click the **three dots** icon on the right. +2. Select the **Remove feature** option. +3. Type in the name of the feature to confirm the deletion. + +:::caution +Deleting a flag is permanent and cannot be undone. Make sure your applications do not contain any reference to this feature before confirming deleting it. +::: + +--- + +## Troubleshooting + +### Flags Not Updating + +- Make sure you have saved your changes in each tab of the edit feature flag panel. +- Check that you are in the correct project and environment. + +### Permission Issues + +- You may need additional permissions to create, edit, clone, or delete flags. If you see permission errors or options are disabled, contact your Flagsmith administrator to review your access rights. For more information, see the [Permissions and Roles](../system-administration/rbac.md) page. From 81c65baaf828da91c2b19846e5e7419a5fa0662f Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Date: Wed, 9 Jul 2025 08:52:24 -0300 Subject: [PATCH 02/14] doc: minor adjustments on core management guide --- docs/docs/managing-flags/core-management.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/docs/managing-flags/core-management.md b/docs/docs/managing-flags/core-management.md index 6e72048d8fdc..4ff202efb79c 100644 --- a/docs/docs/managing-flags/core-management.md +++ b/docs/docs/managing-flags/core-management.md @@ -24,7 +24,9 @@ To create a new feature flag: 5. Click **Create Feature**. :::tip + By clicking the **Create A/B/n Test** button, you can define values for A/B testing. To learn more about this operation, check the [A/B Testing guide](../advanced-use/ab-testing). + ::: --- @@ -37,11 +39,13 @@ You create feature flags once per project, but you edit them within each environ 2. Locate the feature flag you want to edit and click on it. You can use the search bar to find the flag by its name. :::tip + If you just want to toggle the feature flag *on* or *off*, use the switch under the **View** column in the list view. + ::: 3. On the **Value** tab, you can set the flag to be on/off, as well as editing a value for it. Click the **Update Feature Value** to save your changes. -4. Optionally create segment-specific features and define **Segment Overrides**. Check the documentation to learn more about [Segment Overrides](../segments/segment-overrides.md). Save any changes by clicking the **Update Segment Overrides** button. +4. Optionally create segment-specific features and define **Segment Overrides**. Check the documentation to learn more about [Segments](../basic-features/segments.md). Save any changes by clicking the **Update Segment Overrides** button. 5. On the **Settings** tab, you can: - Add tags to your feature flag. - Assign it to specific *users* and *groups*. @@ -51,7 +55,9 @@ If you just want to toggle the feature flag *on* or *off*, use the switch under Click **Update Settings** to save your changes. :::tip + Changes made in the **Settings** tab affect all environments. Changes made in other tabs while editing a feature flag are valid only for the selected environment. + ::: --- @@ -65,7 +71,9 @@ To delete a feature flag: 3. Type in the name of the feature to confirm the deletion. :::caution + Deleting a flag is permanent and cannot be undone. Make sure your applications do not contain any reference to this feature before confirming deleting it. + ::: --- From 460e82b651122504e15c62d71d456e4a7afd9585 Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Date: Fri, 11 Jul 2025 13:49:15 -0300 Subject: [PATCH 03/14] doc: add tagging how to guide --- docs/docs/managing-flags/_category_.json | 3 +- docs/docs/managing-flags/tagging.md | 66 ++++++++++++++++++++++++ 2 files changed, 68 insertions(+), 1 deletion(-) create mode 100644 docs/docs/managing-flags/tagging.md diff --git a/docs/docs/managing-flags/_category_.json b/docs/docs/managing-flags/_category_.json index e2ce7fc8f7af..11b4341db9c2 100644 --- a/docs/docs/managing-flags/_category_.json +++ b/docs/docs/managing-flags/_category_.json @@ -1,4 +1,5 @@ { "label": "Managing Flags", - "position": 10 + "position": 10, + "sidebar_label": "Managing Flags" } \ No newline at end of file diff --git a/docs/docs/managing-flags/tagging.md b/docs/docs/managing-flags/tagging.md new file mode 100644 index 000000000000..d461a630abdc --- /dev/null +++ b/docs/docs/managing-flags/tagging.md @@ -0,0 +1,66 @@ +--- +title: Tagging +sidebar_label: Tagging +sidebar_position: 2 +--- + +You can create tags within Flagsmith and tag Flags in order to organise them. Tags can also be used to filter the list of Flags in the event that you have a large number of them. + +This guide explains how to create and apply tags to feature flags within Flagsmith, as well as some tagging good practices and conventions. + +--- + +## Creating and Applying Tags + +You can add tags to feature flags during creation or when editing an existing flag. + +### When Creating a Flag + +1. Go to the **Features** section in your dashboard. +2. Click **Create Feature**. +3. Fill in the flag details. In the **Tags** field (optional), enter one or more tags to organise your flag. You can also add special tags like `protected` to prevent accidental deletion. +4. Click **Create Feature** to save your changes. + +### When Editing a Flag + +1. In the **Features** section, select the flag you want to edit. +2. Go to the **Settings** tab. +3. In the **Tags** field, add or remove tags as needed. +4. Click **Update Settings** to save your changes. + +You can quickly find and manage flags by using the **tag filter** in the Features list to display only flags with specific tags. This is especially useful for large projects with many flags. + +--- + +## Tag Conventions + +- **General Recommendations:** + - Use clear, descriptive tag names (e.g., `beta`, `deprecated`, `marketing`). + - Establish a naming convention for your team. For example, use all lowercase, hyphen-separated tags. + - Avoid using case-sensitive tags unless necessary. By default, tags are not case-sensitive. + +:::info Protected Tags + +Tags with the following names will prevent users from being able to delete tagged Flags via the dashboard: + +- `protected` +- `donotdelete` +- `permanent` + +::: + + +--- + +## Best Practices for Tag Management +- Use tags to group related flags (e.g., by feature, team, or release). +- Apply protected tags (`protected`, `donotdelete`, `permanent`) to critical or long-lived flags to prevent accidental deletion. +- Regularly review and update tags to keep your flag management organized. + +--- + +## What's Next + +- Learn how to configure [tag-based permissions for roles](../system-administration/rbac.md). +- See more advanced [flag management](../advanced-use/flag-management.md) techniques. + From c305c40a3f8338e305b4e06d100531d212c415db Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Date: Fri, 11 Jul 2025 13:49:51 -0300 Subject: [PATCH 04/14] doc: add scheduled flags page --- .../manage-flags/_category_.json | 5 ++ .../manage-flags/scheduled-flags.md | 56 +++++++++++++++++++ 2 files changed, 61 insertions(+) create mode 100644 docs/docs/managing-flags/manage-flags/_category_.json create mode 100644 docs/docs/managing-flags/manage-flags/scheduled-flags.md diff --git a/docs/docs/managing-flags/manage-flags/_category_.json b/docs/docs/managing-flags/manage-flags/_category_.json new file mode 100644 index 000000000000..c9280fd8e832 --- /dev/null +++ b/docs/docs/managing-flags/manage-flags/_category_.json @@ -0,0 +1,5 @@ +{ + "label": "Manage Flags", + "position": 10, + "sidebar_label": "Manage Flags" +} \ No newline at end of file diff --git a/docs/docs/managing-flags/manage-flags/scheduled-flags.md b/docs/docs/managing-flags/manage-flags/scheduled-flags.md new file mode 100644 index 000000000000..08b3a260a447 --- /dev/null +++ b/docs/docs/managing-flags/manage-flags/scheduled-flags.md @@ -0,0 +1,56 @@ +--- +title: Scheduled Flags +sidebar_label: Scheduled Flags +sidebar_position: 3 +--- + +Scheduled Flags allow you to queue and automatically apply changes to feature flags at a specified future time, eliminating the need for manual intervention at the exact moment of change. This page shows you how to schedule flag changes. + +There are two methods for creating a Scheduled Flag change: + +- As part of a Change Request. +- Directly while editing a feature flag, if Change Requests are not enforced. + +## Prerequisites + +- To schedule flag changes with a Change Request, you must [have Change Requests enabled](../../advanced-use/change-requests.md) in your environment. This is not necessary to directly schedule changes when editing a flag. +- Scheduled Flags are available only for our **Scale-up** and **Enterprise** plans. + +--- + +## How to create a Scheduled Flag change as part of a Change Request + +1. Ensure your Environment has Change Requests enabled. +2. Attempt to change a flag value within the environment. You will be prompted to create a new Change Request. +3. Fill in the following details: + - The title of the Change Request + - (Optional) A description of the reason for the Change Request + - The date and time you want the flag change to take effect +4. Submit the Change Request. The scheduled change will appear in the Change Request area as 'Pending'. + +--- + +## How to create a stand-alone Scheduled Flag change + +If Change Requests are not enabled for your environment, you can schedule a flag change directly: + +1. In the Features list view, go to the feature flag you want to edit. +2. Choose the new value or state for the flag. +3. Click the **Schedule Update** button to set the date and time for the change to take effect. +4. Save your changes. The scheduled change will be queued and applied automatically at the specified time. + +--- + +## Scheduled Flags and Change Requests + +Scheduled Flags awaiting application will be listed in the Change Request area as 'Pending'. + +Once the scheduled date and time have passed and the flag change has been applied, the Scheduled Flag will automatically move to the 'Closed' list in the Change Request area. + +--- + +## What's next? + +- To learn more about managing and approving changes to your flags, see the [Change Requests](../../advanced-use/change-requests.md) page. +- To understand how environments work and how to configure them, visit the [Flag Environments](../environments.md) documentation. +- To see how to view the history of changes to your flags, check out the [Flag History](../flag-history.md) section. From 0356592afc307a8a610362583d1ed35b4c0974de Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Date: Fri, 11 Jul 2025 13:50:16 -0300 Subject: [PATCH 05/14] doc: add feature health metrics page --- .../manage-flags/feature-health-metrics.md | 119 ++++++++++++++++++ 1 file changed, 119 insertions(+) create mode 100644 docs/docs/managing-flags/manage-flags/feature-health-metrics.md diff --git a/docs/docs/managing-flags/manage-flags/feature-health-metrics.md b/docs/docs/managing-flags/manage-flags/feature-health-metrics.md new file mode 100644 index 000000000000..a1111f70d893 --- /dev/null +++ b/docs/docs/managing-flags/manage-flags/feature-health-metrics.md @@ -0,0 +1,119 @@ +--- +title: Feature Health +sidebar_label: Feature Health +sidebar_position: 4 +--- + +Feature Health enables you to monitor observability metrics within Flagsmith, specifically in relation to your Features and Environments. When your observability provider sends alert notifications, Flagsmith can mark Features (and optionally Environments) as **Unhealthy**, providing details about the alerts. This helps your team respond quickly and make informed decisions. + +:::info + +Feature Health is in Beta, please email support@flagsmith.com or chat with us here if you'd like to join. + +::: + +## Prerequisites + +- You must have a supported observability provider (see below). +- You need admin access to your Flagsmith project settings. + +--- + +## How to enable Feature Health + +1. Go to your **Project Settings** in Flagsmith. +2. Navigate to the **Feature Health** section. +3. Choose your desired provider from the **Provider Name** drop-down menu (e.g., Grafana/Prometheus Alertmanager or Sample). +4. Click **Create** and copy the Webhook URL. + +--- + +## How to integrate with Feature Health providers + +### Grafana / Prometheus Alertmanager + +[Learn more](/integrations/apm/grafana/#feature-health-provider-setup) about configuring Grafana / Prometheus Alertmanager Feature Health provider. + +### Sample Provider + +We provide a Sample Provider for your custom integrations. To create a Sample Feature Health webhook: + +1. Go to Project Settings > Feature Health. +2. Select "Sample" from the Provider Name drop-down menu. +3. Click Create and copy the Webhook URL. + +You can use the webhook in your custom integration. Refer to the payload schema below: + +```json +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "title": "SampleEvent", + "type": "object", + "properties": { + "environment": { + "type": "string" + }, + "feature": { + "type": "string" + }, + "status": { + "type": "string", + "enum": ["healthy", "unhealthy"] + }, + "reason": { + "$ref": "#/definitions/FeatureHealthEventReason" + } + }, + "required": ["feature", "status"], + "definitions": { + "FeatureHealthEventReason": { + "type": "object", + "properties": { + "text_blocks": { + "type": "array", + "items": { + "$ref": "#/definitions/FeatureHealthEventReasonTextBlock" + } + }, + "url_blocks": { + "type": "array", + "items": { + "$ref": "#/definitions/FeatureHealthEventReasonUrlBlock" + } + } + } + }, + "FeatureHealthEventReasonTextBlock": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "required": ["text"] + }, + "FeatureHealthEventReasonUrlBlock": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "required": ["url"] + } + } +} +``` + +--- + +## What's next? + +- For more on observability integrations, see the [Integrations documentation](/integrations/). +- Need help or want to join the Beta? Contact [support@flagsmith.com](mailto:support@flagsmith.com) or chat with us in-app. From 1cd912d13460f4a16fa23290a52fc6ff6825b4d5 Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Date: Fri, 11 Jul 2025 13:50:35 -0300 Subject: [PATCH 06/14] doc: crete rollout by attribute guide --- .../managing-flags/rollout/_category_.json | 5 ++ .../rollout/rollout-by-attribute.md | 58 +++++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 docs/docs/managing-flags/rollout/_category_.json create mode 100644 docs/docs/managing-flags/rollout/rollout-by-attribute.md diff --git a/docs/docs/managing-flags/rollout/_category_.json b/docs/docs/managing-flags/rollout/_category_.json new file mode 100644 index 000000000000..9d0b53b203d8 --- /dev/null +++ b/docs/docs/managing-flags/rollout/_category_.json @@ -0,0 +1,5 @@ +{ + "label": "Rollout", + "position": 10, + "sidebar_label": "Rollout" +} \ No newline at end of file diff --git a/docs/docs/managing-flags/rollout/rollout-by-attribute.md b/docs/docs/managing-flags/rollout/rollout-by-attribute.md new file mode 100644 index 000000000000..b52a366acebd --- /dev/null +++ b/docs/docs/managing-flags/rollout/rollout-by-attribute.md @@ -0,0 +1,58 @@ +--- +title: Rollout by Attribute +sidebar_label: Rollout by Attribute +sidebar_position: 1 +--- + +This guide explains how to enable a feature for specific users based on their attributes (traits) in Flagsmith using Segments and Segment Overrides. Attributes can include user role, subscription plan, app version, or device type. + +## Prerequisites + +- A Flagsmith project and environment. +- A feature flag created in your project. +- Your application's [Flagsmith SDK](../../sdks/) integrated and configured. + +## Steps + +### 1. Identify and Send User Traits + +Ensure your application is identifying users and sending their relevant attributes (traits) to Flagsmith. For example, you might send traits like `plan`, `email`, `platform`, or `version` using your SDK: + +```javascript +flagsmith.identify('user_123'); +flagsmith.setTrait('plan', 'pro'); +flagsmith.setTrait('version', '5.4.1'); +``` + +### 2. Create a Segment Based on Attribute(s) + +1. Go to the **Segments** section in the Flagsmith dashboard. +2. Create a new segment and add rules that match the attribute(s) you want to target. For example: + - `plan = pro` + - `email Contains @yourcompany.com` + - `version SemVer >= 5.4.0` +3. You can combine multiple rules for more precise targeting. + +### 3. Apply a Segment Override to Your Feature Flag + +1. In the environment where you want to apply the rollout, go to the **Features** section and select the feature you want to roll out. +2. Navigate to the **Segment Overrides** tab. +- Select the segment you created in the dropdown and set the desired flag state or value for users in that segment. +- Save your changes. + +Done! Now you can test with users who match (and don’t match) the segment to ensure the feature is enabled/disabled as expected. + +--- + +## Advanced Use Cases + +- You can combine attribute rules with a **% Split** rule for staged rollouts (e.g., only 10% of "pro" users). +- You can use operators like `In`, `SemVer`, `Modulo`, etc., for more complex targeting. + +--- + +## What's next + +- Read the [Segments documentation](../../basic-features/segments.md) to understand how they work and their relationship with overrides. +- See the [Staged Feature Rollouts guide](../rollout-by-percentage.md) to combine attribute rules with percentage-based rollouts for gradual releases. +- Understand [Managing Identities](../../basic-features/managing-identities.md) to ensure consistent user identification and attribute management across your application. From 012ec7fd1d938b52232fa1dadaa667471969c95f Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Date: Fri, 11 Jul 2025 13:50:49 -0300 Subject: [PATCH 07/14] doc: create rollout by percentage guide --- .../rollout/rollout-by-percentage.md | 79 +++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 docs/docs/managing-flags/rollout/rollout-by-percentage.md diff --git a/docs/docs/managing-flags/rollout/rollout-by-percentage.md b/docs/docs/managing-flags/rollout/rollout-by-percentage.md new file mode 100644 index 000000000000..fd41ff060363 --- /dev/null +++ b/docs/docs/managing-flags/rollout/rollout-by-percentage.md @@ -0,0 +1,79 @@ +--- +title: Rollout by Percentage +sidebar_label: Rollout by Percentage +sidebar_position: 2 +--- + +**Rollouts by Percentage** (also known as Staged Feature Rollouts) allow you to test a new feature with a small subset of your user base. If you are happy with the feature, you can increase the percentage of users that see the feature until it is available to your entire user base. + +This method increases confidence in rolling out a new feature. If issues arise, you can disable the Feature Flag, thus hiding the feature within your application. + +## Prerequisites + +:::important + +Staged Rollouts **_only_** come into effect if you are getting the Flags for a particular Identity. If you are just retrieving the flags for an Environment without passing in an Identity, your user will never be included in the "% Split" Segment. + +::: + +Before you begin, make sure you have: + +- A feature flag created in your project. +- Your application's [Flagsmith SDK](../../sdks/) integrated and configured. +- **Identifying users in your application:** You must identify users so that percentage rollouts are evaluated per user. For example: + + ```javascript + flagsmith.identify('user_123'); + ``` + +- (Optional) Any user traits you want to use for more advanced segment rules. + +--- + +## How to Rollout by Percentage + +### 1. Create a segment with a percentage split rule + +- Go to the **Segments** section in the Flagsmith dashboard. +- Create a new segment. +- Add a rule defined with the **% Split** condition. Specify a value between 1 and 100 to define what percentage of your user base is included within this Segment. +- You can optionally use the **% Split** rule alongside other Segment rules. + +### 2. Connect the Segment to a Feature Flag + +- Go to the **Features** section and select the feature you want to roll out. +- In the environment where you want to apply the rollout, go to the **Segment Overrides** tab. +- Add the segment you created and set the desired flag state or value for users in that segment. + +### 3. Save and Monitor + +- Save your changes. +- Monitor the rollout. If all goes well, gradually increase the **% Split** value to roll out the feature to more users over time. +- If issues arise, you can quickly disable the feature for all users by removing the override or setting the flag to disabled. + +--- + +## How it works + +Each Identity and Segment has a unique identifier. These two pieces of data are merged, then hashed, and a floating point value between 0.0 and 1.0 is generated from this hash. This value is then evaluated against the "% Split" rule. + +### An Example + +For a single Identity, the following steps are performed: + +1. Take the internal Segment ID and their internal Identity ID and combine them into a single string +2. Hash that string +3. Generate a float value between 0 and 1 based on that hash + +For every Segment/Identity combination, a value of between 0 and 1 is generated. Due to the hashing algorithm used, there is a consistent spread of values from 0 to 1. + +- If the number comes out at `0.351` for a particular Identity, and you create a Segment % split to be 30%, that Identity will **not** be included in that Segment because `0.351` is greater than `0.3` (30%). +- If you then modify the Segment to be a 40% split, the Identity **will** be in that Segment because `0.4 > 0.351`. That way you get a consistent experience as an end-user. This works because the ID of a Segment doesn't change after it has been created. +- A second Identity might have their value hash be equal to `0.94`. In that case, they would not be in the Segment with the split at either 30% or 40%. + +--- + +## What's next + +- Read the [Segments documentation](../../basic-features/segments.md) to understand how segments work and how to combine them with percentage splits. +- See how to [roll out features by user attribute](./rollout-by-attribute.md) for targeted releases. From c808f382d06be08f6b046a7dec5fea1afc453a4d Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Date: Fri, 11 Jul 2025 14:52:56 -0300 Subject: [PATCH 08/14] doc: fix frontmatter --- docs/docs/managing-flags/_category_.json | 3 +-- docs/docs/managing-flags/manage-flags/_category_.json | 3 +-- docs/docs/managing-flags/rollout/_category_.json | 3 +-- 3 files changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/docs/managing-flags/_category_.json b/docs/docs/managing-flags/_category_.json index 11b4341db9c2..e2ce7fc8f7af 100644 --- a/docs/docs/managing-flags/_category_.json +++ b/docs/docs/managing-flags/_category_.json @@ -1,5 +1,4 @@ { "label": "Managing Flags", - "position": 10, - "sidebar_label": "Managing Flags" + "position": 10 } \ No newline at end of file diff --git a/docs/docs/managing-flags/manage-flags/_category_.json b/docs/docs/managing-flags/manage-flags/_category_.json index c9280fd8e832..ba5303ed3b40 100644 --- a/docs/docs/managing-flags/manage-flags/_category_.json +++ b/docs/docs/managing-flags/manage-flags/_category_.json @@ -1,5 +1,4 @@ { "label": "Manage Flags", - "position": 10, - "sidebar_label": "Manage Flags" + "position": 10 } \ No newline at end of file diff --git a/docs/docs/managing-flags/rollout/_category_.json b/docs/docs/managing-flags/rollout/_category_.json index 9d0b53b203d8..53322d2ee977 100644 --- a/docs/docs/managing-flags/rollout/_category_.json +++ b/docs/docs/managing-flags/rollout/_category_.json @@ -1,5 +1,4 @@ { "label": "Rollout", - "position": 10, - "sidebar_label": "Rollout" + "position": 10 } \ No newline at end of file From 51d3b90da534aa003769e7329726f099474e40f0 Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Date: Fri, 11 Jul 2025 15:20:59 -0300 Subject: [PATCH 09/14] doc: fix links --- .../managing-flags/manage-flags/feature-health-metrics.md | 4 ++-- docs/docs/managing-flags/manage-flags/scheduled-flags.md | 3 +-- docs/docs/managing-flags/rollout/rollout-by-attribute.md | 4 ++-- docs/docs/managing-flags/rollout/rollout-by-percentage.md | 2 +- 4 files changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/docs/managing-flags/manage-flags/feature-health-metrics.md b/docs/docs/managing-flags/manage-flags/feature-health-metrics.md index a1111f70d893..98b05d894cc2 100644 --- a/docs/docs/managing-flags/manage-flags/feature-health-metrics.md +++ b/docs/docs/managing-flags/manage-flags/feature-health-metrics.md @@ -1,6 +1,6 @@ --- -title: Feature Health -sidebar_label: Feature Health +title: Feature Health Metrics +sidebar_label: Feature Health Metrics sidebar_position: 4 --- diff --git a/docs/docs/managing-flags/manage-flags/scheduled-flags.md b/docs/docs/managing-flags/manage-flags/scheduled-flags.md index 08b3a260a447..203122e7093c 100644 --- a/docs/docs/managing-flags/manage-flags/scheduled-flags.md +++ b/docs/docs/managing-flags/manage-flags/scheduled-flags.md @@ -52,5 +52,4 @@ Once the scheduled date and time have passed and the flag change has been applie ## What's next? - To learn more about managing and approving changes to your flags, see the [Change Requests](../../advanced-use/change-requests.md) page. -- To understand how environments work and how to configure them, visit the [Flag Environments](../environments.md) documentation. -- To see how to view the history of changes to your flags, check out the [Flag History](../flag-history.md) section. +- To learn how to monitor the performance and health of your feature flags, see the [Feature Health Metrics](../feature-health-metrics.md) page. diff --git a/docs/docs/managing-flags/rollout/rollout-by-attribute.md b/docs/docs/managing-flags/rollout/rollout-by-attribute.md index b52a366acebd..19c1be54fa5d 100644 --- a/docs/docs/managing-flags/rollout/rollout-by-attribute.md +++ b/docs/docs/managing-flags/rollout/rollout-by-attribute.md @@ -10,7 +10,7 @@ This guide explains how to enable a feature for specific users based on their at - A Flagsmith project and environment. - A feature flag created in your project. -- Your application's [Flagsmith SDK](../../sdks/) integrated and configured. +- Your application's [Flagsmith SDK](../../clients/index.md) integrated and configured. ## Steps @@ -54,5 +54,5 @@ Done! Now you can test with users who match (and don’t match) the segment to e ## What's next - Read the [Segments documentation](../../basic-features/segments.md) to understand how they work and their relationship with overrides. -- See the [Staged Feature Rollouts guide](../rollout-by-percentage.md) to combine attribute rules with percentage-based rollouts for gradual releases. +- See the [Staged Feature Rollouts guide](./rollout-by-percentage.md) to combine attribute rules with percentage-based rollouts for gradual releases. - Understand [Managing Identities](../../basic-features/managing-identities.md) to ensure consistent user identification and attribute management across your application. diff --git a/docs/docs/managing-flags/rollout/rollout-by-percentage.md b/docs/docs/managing-flags/rollout/rollout-by-percentage.md index fd41ff060363..dcaf27c4f33c 100644 --- a/docs/docs/managing-flags/rollout/rollout-by-percentage.md +++ b/docs/docs/managing-flags/rollout/rollout-by-percentage.md @@ -19,7 +19,7 @@ Staged Rollouts **_only_** come into effect if you are getting the Flags for a p Before you begin, make sure you have: - A feature flag created in your project. -- Your application's [Flagsmith SDK](../../sdks/) integrated and configured. +- Your application's [Flagsmith SDK](../../clients/index.md) integrated and configured. - **Identifying users in your application:** You must identify users so that percentage rollouts are evaluated per user. For example: ```javascript From 1fc236e6378261592f30a53e8f82e94c319e9e42 Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Date: Thu, 17 Jul 2025 09:36:54 -0300 Subject: [PATCH 10/14] doc: check spelling --- docs/docs/managing-flags/core-management.md | 12 ++++++------ .../manage-flags/feature-health-metrics.md | 2 +- .../managing-flags/manage-flags/scheduled-flags.md | 2 +- .../managing-flags/rollout/rollout-by-attribute.md | 4 ++-- .../managing-flags/rollout/rollout-by-percentage.md | 2 +- docs/docs/managing-flags/tagging.md | 4 ++-- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/docs/managing-flags/core-management.md b/docs/docs/managing-flags/core-management.md index 4ff202efb79c..49e08afa69e9 100644 --- a/docs/docs/managing-flags/core-management.md +++ b/docs/docs/managing-flags/core-management.md @@ -4,7 +4,7 @@ sidebar_label: Core Management sidebar_position: 1 --- -Flags in Flagsmith are used to categorize and monitor user actions or events, such as detecting spam or abuse. This guide covers how to create, edit, clone, and delete flags in your project. +Flags in Flagsmith are used to categorise and monitor user actions or events, such as detecting spam or abuse. This guide covers how to create, edit, clone, and delete flags in your project. --- @@ -18,14 +18,14 @@ To create a new feature flag: 4. Fill in the available fields according to the specifications of your feature. Note that these values are applied to all your [environments]. You can edit each environment individually later. - **Enabled by default**: determines the initial state of the flag for all environments. This can be edited for each environment later. - **Value** (optional): additionally to their boolean value, you can choose a format and a value for your flag. - - **Tags** (optional): organise your flags by tags or add `protected`to prevent them from accidentally being deleted. + - **Tags** (optional): organise your flags by tags or add `protected` to prevent them from accidentally being deleted. - **Description** (optional): add a feature flag description. - **Server-side only**: enabling this prevents your flag from being accessed by client-side SDKs. 5. Click **Create Feature**. :::tip -By clicking the **Create A/B/n Test** button, you can define values for A/B testing. To learn more about this operation, check the [A/B Testing guide](../advanced-use/ab-testing). +By clicking the **Create A/B/n Test** button, you can define values for A/B testing. To learn more about this operation, refer to the [A/B Testing guide](../advanced-use/ab-testing). ::: @@ -44,13 +44,13 @@ If you just want to toggle the feature flag *on* or *off*, use the switch under ::: -3. On the **Value** tab, you can set the flag to be on/off, as well as editing a value for it. Click the **Update Feature Value** to save your changes. -4. Optionally create segment-specific features and define **Segment Overrides**. Check the documentation to learn more about [Segments](../basic-features/segments.md). Save any changes by clicking the **Update Segment Overrides** button. +3. On the **Value** tab, you can set the flag to be on or off, as well as edit a value for it. Click **Update Feature Value** to save your changes. +4. Optionally, create segment-specific features and define **Segment Overrides**. Refer to the documentation to learn more about [Segments](../basic-features/segments.md). Save any changes by clicking the **Update Segment Overrides** button. 5. On the **Settings** tab, you can: - Add tags to your feature flag. - Assign it to specific *users* and *groups*. - Update the flag's description. - - Mark the flag as **Server-side only** to prevent it being accessed by client-side SDKs. + - Mark the flag as **Server-side only** to prevent it from being accessed by client-side SDKs. - Set the **Archived** status to filter the flag as no longer relevant. Note that the flag will still be returned by the endpoint as before. Click **Update Settings** to save your changes. diff --git a/docs/docs/managing-flags/manage-flags/feature-health-metrics.md b/docs/docs/managing-flags/manage-flags/feature-health-metrics.md index 98b05d894cc2..ec10a5c23a14 100644 --- a/docs/docs/managing-flags/manage-flags/feature-health-metrics.md +++ b/docs/docs/managing-flags/manage-flags/feature-health-metrics.md @@ -4,7 +4,7 @@ sidebar_label: Feature Health Metrics sidebar_position: 4 --- -Feature Health enables you to monitor observability metrics within Flagsmith, specifically in relation to your Features and Environments. When your observability provider sends alert notifications, Flagsmith can mark Features (and optionally Environments) as **Unhealthy**, providing details about the alerts. This helps your team respond quickly and make informed decisions. +Feature Health enables you to monitor observability metrics within Flagsmith, specifically in relation to your Features and Environments. When your observability provider sends alert notifications, Flagsmith can mark Features (and optionally Environments) as **Unhealthy**, providing details about the alerts. This assists your team in responding quickly and making informed decisions. :::info diff --git a/docs/docs/managing-flags/manage-flags/scheduled-flags.md b/docs/docs/managing-flags/manage-flags/scheduled-flags.md index 203122e7093c..5104f45af95f 100644 --- a/docs/docs/managing-flags/manage-flags/scheduled-flags.md +++ b/docs/docs/managing-flags/manage-flags/scheduled-flags.md @@ -25,7 +25,7 @@ There are two methods for creating a Scheduled Flag change: 3. Fill in the following details: - The title of the Change Request - (Optional) A description of the reason for the Change Request - - The date and time you want the flag change to take effect + - The date and time at which you want the flag change to take effect 4. Submit the Change Request. The scheduled change will appear in the Change Request area as 'Pending'. --- diff --git a/docs/docs/managing-flags/rollout/rollout-by-attribute.md b/docs/docs/managing-flags/rollout/rollout-by-attribute.md index 19c1be54fa5d..c4574420464b 100644 --- a/docs/docs/managing-flags/rollout/rollout-by-attribute.md +++ b/docs/docs/managing-flags/rollout/rollout-by-attribute.md @@ -4,7 +4,7 @@ sidebar_label: Rollout by Attribute sidebar_position: 1 --- -This guide explains how to enable a feature for specific users based on their attributes (traits) in Flagsmith using Segments and Segment Overrides. Attributes can include user role, subscription plan, app version, or device type. +This guide explains how to enable a feature for specific users based on their attributes (traits) in Flagsmith using Segments and Segment Overrides. Attributes can include user role, subscription plan, application version, or device type. ## Prerequisites @@ -47,7 +47,7 @@ Done! Now you can test with users who match (and don’t match) the segment to e ## Advanced Use Cases - You can combine attribute rules with a **% Split** rule for staged rollouts (e.g., only 10% of "pro" users). -- You can use operators like `In`, `SemVer`, `Modulo`, etc., for more complex targeting. +- You can use operators such as `In`, `SemVer`, `Modulo`, etc., for more complex targeting. --- diff --git a/docs/docs/managing-flags/rollout/rollout-by-percentage.md b/docs/docs/managing-flags/rollout/rollout-by-percentage.md index dcaf27c4f33c..2f4d29afd1c4 100644 --- a/docs/docs/managing-flags/rollout/rollout-by-percentage.md +++ b/docs/docs/managing-flags/rollout/rollout-by-percentage.md @@ -65,7 +65,7 @@ For a single Identity, the following steps are performed: 2. Hash that string 3. Generate a float value between 0 and 1 based on that hash -For every Segment/Identity combination, a value of between 0 and 1 is generated. Due to the hashing algorithm used, there is a consistent spread of values from 0 to 1. +For every Segment/Identity combination, a value between 0 and 1 is generated. Due to the hashing algorithm used, there is a consistent spread of values from 0 to 1. - If the number comes out at `0.351` for a particular Identity, and you create a Segment % split to be 30%, that Identity will **not** be included in that Segment because `0.351` is greater than `0.3` (30%). - If you then modify the Segment to be a 40% split, the Identity **will** be in that Segment because `0.4 > 0.351`. That way you get a consistent experience as an end-user. This works because the ID of a Segment doesn't change after it has been created. diff --git a/docs/docs/managing-flags/tagging.md b/docs/docs/managing-flags/tagging.md index d461a630abdc..1b139b9a50d8 100644 --- a/docs/docs/managing-flags/tagging.md +++ b/docs/docs/managing-flags/tagging.md @@ -18,7 +18,7 @@ You can add tags to feature flags during creation or when editing an existing fl 1. Go to the **Features** section in your dashboard. 2. Click **Create Feature**. -3. Fill in the flag details. In the **Tags** field (optional), enter one or more tags to organise your flag. You can also add special tags like `protected` to prevent accidental deletion. +3. Fill in the flag details. In the **Tags** field (optional), enter one or more tags to organise your flag. You can also add special tags such as `protected` to prevent accidental deletion. 4. Click **Create Feature** to save your changes. ### When Editing a Flag @@ -55,7 +55,7 @@ Tags with the following names will prevent users from being able to delete tagge ## Best Practices for Tag Management - Use tags to group related flags (e.g., by feature, team, or release). - Apply protected tags (`protected`, `donotdelete`, `permanent`) to critical or long-lived flags to prevent accidental deletion. -- Regularly review and update tags to keep your flag management organized. +- Regularly review and update tags to keep your flag management organised. --- From 03213566bc15ec1b20a853fe27c4040bfb4c1d11 Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Date: Mon, 28 Jul 2025 09:47:35 -0300 Subject: [PATCH 11/14] doc: fix link --- docs/docs/managing-flags/manage-flags/scheduled-flags.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/managing-flags/manage-flags/scheduled-flags.md b/docs/docs/managing-flags/manage-flags/scheduled-flags.md index 5104f45af95f..9a24d49db622 100644 --- a/docs/docs/managing-flags/manage-flags/scheduled-flags.md +++ b/docs/docs/managing-flags/manage-flags/scheduled-flags.md @@ -52,4 +52,4 @@ Once the scheduled date and time have passed and the flag change has been applie ## What's next? - To learn more about managing and approving changes to your flags, see the [Change Requests](../../advanced-use/change-requests.md) page. -- To learn how to monitor the performance and health of your feature flags, see the [Feature Health Metrics](../feature-health-metrics.md) page. +- To learn how to monitor the performance and health of your feature flags, see the [Feature Health Metrics](./feature-health-metrics.md) page. From 7ef37885ee00f34f26a27c876f3216fa050521a7 Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Date: Thu, 31 Jul 2025 14:52:19 -0300 Subject: [PATCH 12/14] doc: update managing flags section --- docs/docs/managing-flags/core-management.md | 2 +- .../manage-flags/feature-health-metrics.md | 10 +++--- .../manage-flags/scheduled-flags.md | 34 +++++++++---------- .../rollout/rollout-by-attribute.md | 10 +++--- .../rollout/rollout-by-percentage.md | 26 +++++++------- docs/docs/managing-flags/tagging.md | 4 +-- 6 files changed, 43 insertions(+), 43 deletions(-) diff --git a/docs/docs/managing-flags/core-management.md b/docs/docs/managing-flags/core-management.md index 49e08afa69e9..dbc52643ca4c 100644 --- a/docs/docs/managing-flags/core-management.md +++ b/docs/docs/managing-flags/core-management.md @@ -45,7 +45,7 @@ If you just want to toggle the feature flag *on* or *off*, use the switch under ::: 3. On the **Value** tab, you can set the flag to be on or off, as well as edit a value for it. Click **Update Feature Value** to save your changes. -4. Optionally, create segment-specific features and define **Segment Overrides**. Refer to the documentation to learn more about [Segments](../basic-features/segments.md). Save any changes by clicking the **Update Segment Overrides** button. +4. Optionally, create segment-specific features and define **segment overrides**. Refer to the documentation to learn more about [segments](../basic-features/segments.md). Save any changes by clicking the **Update Segment Overrides** button. 5. On the **Settings** tab, you can: - Add tags to your feature flag. - Assign it to specific *users* and *groups*. diff --git a/docs/docs/managing-flags/manage-flags/feature-health-metrics.md b/docs/docs/managing-flags/manage-flags/feature-health-metrics.md index ec10a5c23a14..9d4c0cda6b03 100644 --- a/docs/docs/managing-flags/manage-flags/feature-health-metrics.md +++ b/docs/docs/managing-flags/manage-flags/feature-health-metrics.md @@ -4,7 +4,7 @@ sidebar_label: Feature Health Metrics sidebar_position: 4 --- -Feature Health enables you to monitor observability metrics within Flagsmith, specifically in relation to your Features and Environments. When your observability provider sends alert notifications, Flagsmith can mark Features (and optionally Environments) as **Unhealthy**, providing details about the alerts. This assists your team in responding quickly and making informed decisions. +Feature health enables you to monitor observability metrics within Flagsmith, specifically in relation to your features and environments. When your observability provider sends alert notifications, Flagsmith can mark features (and optionally environments) as **unhealthy**, providing details about the alerts. This assists your team in responding quickly and making informed decisions. :::info @@ -24,7 +24,7 @@ Feature Health is in Beta, please email support@flagsmith.com or chat with us Feature Health. 2. Select "Sample" from the Provider Name drop-down menu. -3. Click Create and copy the Webhook URL. +3. Click Create and copy the webhook URL. You can use the webhook in your custom integration. Refer to the payload schema below: @@ -115,5 +115,5 @@ You can use the webhook in your custom integration. Refer to the payload schema ## What's next? -- For more on observability integrations, see the [Integrations documentation](/integrations/). +- For more on observability integrations, see the [integrations documentation](/integrations/). - Need help or want to join the Beta? Contact [support@flagsmith.com](mailto:support@flagsmith.com) or chat with us in-app. diff --git a/docs/docs/managing-flags/manage-flags/scheduled-flags.md b/docs/docs/managing-flags/manage-flags/scheduled-flags.md index 9a24d49db622..59f592e655cb 100644 --- a/docs/docs/managing-flags/manage-flags/scheduled-flags.md +++ b/docs/docs/managing-flags/manage-flags/scheduled-flags.md @@ -4,35 +4,35 @@ sidebar_label: Scheduled Flags sidebar_position: 3 --- -Scheduled Flags allow you to queue and automatically apply changes to feature flags at a specified future time, eliminating the need for manual intervention at the exact moment of change. This page shows you how to schedule flag changes. +Scheduled flags allow you to queue and automatically apply changes to feature flags at a specified future time, eliminating the need for manual intervention at the exact moment of change. This page shows you how to schedule flag changes. -There are two methods for creating a Scheduled Flag change: +There are two methods for creating a scheduled flag change: -- As part of a Change Request. -- Directly while editing a feature flag, if Change Requests are not enforced. +- As part of a change request. +- Directly while editing a feature flag, if change requests are not enforced. ## Prerequisites -- To schedule flag changes with a Change Request, you must [have Change Requests enabled](../../advanced-use/change-requests.md) in your environment. This is not necessary to directly schedule changes when editing a flag. -- Scheduled Flags are available only for our **Scale-up** and **Enterprise** plans. +- To schedule flag changes with a change request, you must [have change requests enabled](../../advanced-use/change-requests.md) in your environment. This is not necessary to directly schedule changes when editing a flag. +- Scheduled flags are available only for our **Scale-up** and **Enterprise** plans. --- ## How to create a Scheduled Flag change as part of a Change Request -1. Ensure your Environment has Change Requests enabled. -2. Attempt to change a flag value within the environment. You will be prompted to create a new Change Request. +1. Ensure your environment has change requests enabled. +2. Attempt to change a flag value within the environment. You will be prompted to create a new change request. 3. Fill in the following details: - - The title of the Change Request - - (Optional) A description of the reason for the Change Request + - The title of the change request + - (Optional) A description of the reason for the change request - The date and time at which you want the flag change to take effect -4. Submit the Change Request. The scheduled change will appear in the Change Request area as 'Pending'. +4. Submit the change request. The scheduled change will appear in the change request area as 'Pending'. --- -## How to create a stand-alone Scheduled Flag change +## How to create a stand-alone scheduled flag change -If Change Requests are not enabled for your environment, you can schedule a flag change directly: +If change requests are not enabled for your environment, you can schedule a flag change directly: 1. In the Features list view, go to the feature flag you want to edit. 2. Choose the new value or state for the flag. @@ -43,13 +43,13 @@ If Change Requests are not enabled for your environment, you can schedule a flag ## Scheduled Flags and Change Requests -Scheduled Flags awaiting application will be listed in the Change Request area as 'Pending'. +Scheduled flags awaiting application will be listed in the change request area as 'Pending'. -Once the scheduled date and time have passed and the flag change has been applied, the Scheduled Flag will automatically move to the 'Closed' list in the Change Request area. +Once the scheduled date and time have passed and the flag change has been applied, the scheduled flag will automatically move to the 'Closed' list in the change request area. --- ## What's next? -- To learn more about managing and approving changes to your flags, see the [Change Requests](../../advanced-use/change-requests.md) page. -- To learn how to monitor the performance and health of your feature flags, see the [Feature Health Metrics](./feature-health-metrics.md) page. +- To learn more about managing and approving changes to your flags, see the [change requests](../../advanced-use/change-requests.md) page. +- To learn how to monitor the performance and health of your feature flags, see the [feature health metrics](./feature-health-metrics.md) page. diff --git a/docs/docs/managing-flags/rollout/rollout-by-attribute.md b/docs/docs/managing-flags/rollout/rollout-by-attribute.md index c4574420464b..acd9e6186e7e 100644 --- a/docs/docs/managing-flags/rollout/rollout-by-attribute.md +++ b/docs/docs/managing-flags/rollout/rollout-by-attribute.md @@ -4,7 +4,7 @@ sidebar_label: Rollout by Attribute sidebar_position: 1 --- -This guide explains how to enable a feature for specific users based on their attributes (traits) in Flagsmith using Segments and Segment Overrides. Attributes can include user role, subscription plan, application version, or device type. +This guide explains how to enable a feature for specific users based on their attributes (traits) in Flagsmith using segments and segment overrides. Attributes can include user role, subscription plan, application version, or device type. ## Prerequisites @@ -46,13 +46,13 @@ Done! Now you can test with users who match (and don’t match) the segment to e ## Advanced Use Cases -- You can combine attribute rules with a **% Split** rule for staged rollouts (e.g., only 10% of "pro" users). +- You can combine attribute rules with a **% split** rule for staged rollouts (e.g., only 10% of "pro" users). - You can use operators such as `In`, `SemVer`, `Modulo`, etc., for more complex targeting. --- ## What's next -- Read the [Segments documentation](../../basic-features/segments.md) to understand how they work and their relationship with overrides. -- See the [Staged Feature Rollouts guide](./rollout-by-percentage.md) to combine attribute rules with percentage-based rollouts for gradual releases. -- Understand [Managing Identities](../../basic-features/managing-identities.md) to ensure consistent user identification and attribute management across your application. +- Read the [segments documentation](../../basic-features/segments.md) to understand how they work and their relationship with overrides. +- See the [staged feature rollouts guide](./rollout-by-percentage.md) to combine attribute rules with percentage-based rollouts for gradual releases. +- Understand [managing identities](../../basic-features/managing-identities.md) to ensure consistent user identification and attribute management across your application. diff --git a/docs/docs/managing-flags/rollout/rollout-by-percentage.md b/docs/docs/managing-flags/rollout/rollout-by-percentage.md index 2f4d29afd1c4..a1a2ad1a4aea 100644 --- a/docs/docs/managing-flags/rollout/rollout-by-percentage.md +++ b/docs/docs/managing-flags/rollout/rollout-by-percentage.md @@ -4,15 +4,15 @@ sidebar_label: Rollout by Percentage sidebar_position: 2 --- -**Rollouts by Percentage** (also known as Staged Feature Rollouts) allow you to test a new feature with a small subset of your user base. If you are happy with the feature, you can increase the percentage of users that see the feature until it is available to your entire user base. +**Rollouts by percentage** (also known as staged feature rollouts) allow you to test a new feature with a small subset of your user base. If you are happy with the feature, you can increase the percentage of users that see the feature until it is available to your entire user base. -This method increases confidence in rolling out a new feature. If issues arise, you can disable the Feature Flag, thus hiding the feature within your application. +This method increases confidence in rolling out a new feature. If issues arise, you can disable the feature flag, thus hiding the feature within your application. ## Prerequisites :::important -Staged Rollouts **_only_** come into effect if you are getting the Flags for a particular Identity. If you are just retrieving the flags for an Environment without passing in an Identity, your user will never be included in the "% Split" Segment. +Staged rollouts **_only_** come into effect if you are getting the flags for a particular identity. If you are just retrieving the flags for an environment without passing in an identity, your user will never be included in the "% split" segment. ::: @@ -36,8 +36,8 @@ Before you begin, make sure you have: - Go to the **Segments** section in the Flagsmith dashboard. - Create a new segment. -- Add a rule defined with the **% Split** condition. Specify a value between 1 and 100 to define what percentage of your user base is included within this Segment. -- You can optionally use the **% Split** rule alongside other Segment rules. +- Add a rule defined with the **% Split** condition. Specify a value between 1 and 100 to define what percentage of your user base is included within this segment. +- You can optionally use the **% Split** rule alongside other segment rules. ### 2. Connect the Segment to a Feature Flag @@ -55,25 +55,25 @@ Before you begin, make sure you have: ## How it works -Each Identity and Segment has a unique identifier. These two pieces of data are merged, then hashed, and a floating point value between 0.0 and 1.0 is generated from this hash. This value is then evaluated against the "% Split" rule. +Each identity and segment has a unique identifier. These two pieces of data are merged, then hashed, and a floating point value between 0.0 and 1.0 is generated from this hash. This value is then evaluated against the "% split" rule. ### An Example -For a single Identity, the following steps are performed: +For a single identity, the following steps are performed: -1. Take the internal Segment ID and their internal Identity ID and combine them into a single string +1. Take the internal segment ID and their internal identity ID and combine them into a single string 2. Hash that string 3. Generate a float value between 0 and 1 based on that hash -For every Segment/Identity combination, a value between 0 and 1 is generated. Due to the hashing algorithm used, there is a consistent spread of values from 0 to 1. +For every segment/identity combination, a value between 0 and 1 is generated. Due to the hashing algorithm used, there is a consistent spread of values from 0 to 1. -- If the number comes out at `0.351` for a particular Identity, and you create a Segment % split to be 30%, that Identity will **not** be included in that Segment because `0.351` is greater than `0.3` (30%). -- If you then modify the Segment to be a 40% split, the Identity **will** be in that Segment because `0.4 > 0.351`. That way you get a consistent experience as an end-user. This works because the ID of a Segment doesn't change after it has been created. -- A second Identity might have their value hash be equal to `0.94`. In that case, they would not be in the Segment with the split at either 30% or 40%. +- If the number comes out at `0.351` for a particular identity, and you create a segment % split to be 30%, that identity will **not** be included in that segment because `0.351` is greater than `0.3` (30%). +- If you then modify the segment to be a 40% split, the identity **will** be in that segment because `0.4 > 0.351`. That way you get a consistent experience as an end-user. This works because the ID of a segment doesn't change after it has been created. +- A second identity might have their value hash be equal to `0.94`. In that case, they would not be in the segment with the split at either 30% or 40%. --- ## What's next -- Read the [Segments documentation](../../basic-features/segments.md) to understand how segments work and how to combine them with percentage splits. +- Read the [segments documentation](../../basic-features/segments.md) to understand how segments work and how to combine them with percentage splits. - See how to [roll out features by user attribute](./rollout-by-attribute.md) for targeted releases. diff --git a/docs/docs/managing-flags/tagging.md b/docs/docs/managing-flags/tagging.md index 1b139b9a50d8..e5aaf700854d 100644 --- a/docs/docs/managing-flags/tagging.md +++ b/docs/docs/managing-flags/tagging.md @@ -4,7 +4,7 @@ sidebar_label: Tagging sidebar_position: 2 --- -You can create tags within Flagsmith and tag Flags in order to organise them. Tags can also be used to filter the list of Flags in the event that you have a large number of them. +You can create tags within Flagsmith and tag flags in order to organise them. Tags can also be used to filter the list of flags in the event that you have a large number of them. This guide explains how to create and apply tags to feature flags within Flagsmith, as well as some tagging good practices and conventions. @@ -41,7 +41,7 @@ You can quickly find and manage flags by using the **tag filter** in the Feature :::info Protected Tags -Tags with the following names will prevent users from being able to delete tagged Flags via the dashboard: +Tags with the following names will prevent users from being able to delete tagged flags via the dashboard: - `protected` - `donotdelete` From 366f6b723173a18c825b9d06e3251d042e2a03df Mon Sep 17 00:00:00 2001 From: Guilherme Afonso Date: Thu, 14 Aug 2025 13:16:15 -0300 Subject: [PATCH 13/14] doc: adjust namming convention --- docs/docs/managing-flags/core-management.md | 36 +++++++++---------- .../manage-flags/scheduled-flags.md | 18 +++++----- .../rollout/rollout-by-attribute.md | 4 +-- .../rollout/rollout-by-percentage.md | 6 ++-- docs/docs/managing-flags/tagging.md | 22 ++++++------ 5 files changed, 43 insertions(+), 43 deletions(-) diff --git a/docs/docs/managing-flags/core-management.md b/docs/docs/managing-flags/core-management.md index dbc52643ca4c..127a18f447f6 100644 --- a/docs/docs/managing-flags/core-management.md +++ b/docs/docs/managing-flags/core-management.md @@ -1,14 +1,14 @@ --- -title: Core Management -sidebar_label: Core Management +title: Basic Flag Management +sidebar_label: Basic Flag Management sidebar_position: 1 --- -Flags in Flagsmith are used to categorise and monitor user actions or events, such as detecting spam or abuse. This guide covers how to create, edit, clone, and delete flags in your project. +Feature Flags in Flagsmith are used to categorise and monitor user actions or events, such as detecting spam or abuse. This guide covers how to create, edit, clone, and delete flags in your project. --- -## Creating a Flag +## Creating a Feature Flag To create a new feature flag: @@ -31,12 +31,12 @@ By clicking the **Create A/B/n Test** button, you can define values for A/B test --- -## Editing a Flag +## Editing a Feature Flag -You create feature flags once per project, but you edit them within each environment. To edit an existing flag: +You create feature flags once per project, but you edit them within each environment. To edit an existing feature flag: 1. While on the **Environments** tab on the dashboard, use the dropdown to select the environment where you want to apply the changes. -2. Locate the feature flag you want to edit and click on it. You can use the search bar to find the flag by its name. +2. Locate the feature flag you want to edit and click on it. You can use the search bar to find the feature flag by its name. :::tip @@ -44,14 +44,14 @@ If you just want to toggle the feature flag *on* or *off*, use the switch under ::: -3. On the **Value** tab, you can set the flag to be on or off, as well as edit a value for it. Click **Update Feature Value** to save your changes. -4. Optionally, create segment-specific features and define **segment overrides**. Refer to the documentation to learn more about [segments](../basic-features/segments.md). Save any changes by clicking the **Update Segment Overrides** button. +3. On the **Value** tab, you can set the feature flag to be on or off, as well as edit a value for it. Click **Update Feature Value** to save your changes. +4. Optionally, create segment-specific feature flags and define **segment overrides**. Refer to the documentation to learn more about [segments](../basic-features/segments.md). Save any changes by clicking the **Update Segment Overrides** button. 5. On the **Settings** tab, you can: - Add tags to your feature flag. - Assign it to specific *users* and *groups*. - - Update the flag's description. - - Mark the flag as **Server-side only** to prevent it from being accessed by client-side SDKs. - - Set the **Archived** status to filter the flag as no longer relevant. Note that the flag will still be returned by the endpoint as before. + - Update the feature flag's description. + - Mark the feature flag as **Server-side only** to prevent it from being accessed by client-side SDKs. + - Set the **Archived** status to filter the feature flag as no longer relevant. Note that the feature flag will still be returned by the endpoint as before. Click **Update Settings** to save your changes. :::tip @@ -62,17 +62,17 @@ Changes made in the **Settings** tab affect all environments. Changes made in ot --- -## Deleting a Flag +## Deleting a Feature Flag To delete a feature flag: -1. In the **Features** section, locate the flag you want to remove and click the **three dots** icon on the right. +1. In the **Features** section, locate the feature flag you want to remove and click the **three dots** icon on the right. 2. Select the **Remove feature** option. -3. Type in the name of the feature to confirm the deletion. +3. Type in the name of the feature flag to confirm the deletion. :::caution -Deleting a flag is permanent and cannot be undone. Make sure your applications do not contain any reference to this feature before confirming deleting it. +Deleting a feature flag is permanent and cannot be undone. Make sure your applications do not contain any reference to this feature flag before confirming deleting it. ::: @@ -80,11 +80,11 @@ Deleting a flag is permanent and cannot be undone. Make sure your applications d ## Troubleshooting -### Flags Not Updating +### Feature Flags Not Updating - Make sure you have saved your changes in each tab of the edit feature flag panel. - Check that you are in the correct project and environment. ### Permission Issues -- You may need additional permissions to create, edit, clone, or delete flags. If you see permission errors or options are disabled, contact your Flagsmith administrator to review your access rights. For more information, see the [Permissions and Roles](../system-administration/rbac.md) page. +- You may need additional permissions to create, edit, clone, or delete feature flags. If you see permission errors or options are disabled, contact your Flagsmith administrator to review your access rights. For more information, see the [Permissions and Roles](../system-administration/rbac.md) page. diff --git a/docs/docs/managing-flags/manage-flags/scheduled-flags.md b/docs/docs/managing-flags/manage-flags/scheduled-flags.md index 59f592e655cb..87394d4c4e3e 100644 --- a/docs/docs/managing-flags/manage-flags/scheduled-flags.md +++ b/docs/docs/managing-flags/manage-flags/scheduled-flags.md @@ -6,14 +6,14 @@ sidebar_position: 3 Scheduled flags allow you to queue and automatically apply changes to feature flags at a specified future time, eliminating the need for manual intervention at the exact moment of change. This page shows you how to schedule flag changes. -There are two methods for creating a scheduled flag change: +There are two methods for creating a scheduled feature flag change: - As part of a change request. - Directly while editing a feature flag, if change requests are not enforced. ## Prerequisites -- To schedule flag changes with a change request, you must [have change requests enabled](../../advanced-use/change-requests.md) in your environment. This is not necessary to directly schedule changes when editing a flag. +- To schedule feature flag changes with a change request, you must [have change requests enabled](../../advanced-use/change-requests.md) in your environment. This is not necessary to directly schedule changes when editing a flag. - Scheduled flags are available only for our **Scale-up** and **Enterprise** plans. --- @@ -21,21 +21,21 @@ There are two methods for creating a scheduled flag change: ## How to create a Scheduled Flag change as part of a Change Request 1. Ensure your environment has change requests enabled. -2. Attempt to change a flag value within the environment. You will be prompted to create a new change request. +2. Attempt to change a feature flag value within the environment. You will be prompted to create a new change request. 3. Fill in the following details: - The title of the change request - (Optional) A description of the reason for the change request - - The date and time at which you want the flag change to take effect + - The date and time at which you want the feature flag change to take effect 4. Submit the change request. The scheduled change will appear in the change request area as 'Pending'. --- -## How to create a stand-alone scheduled flag change +## How to create a stand-alone scheduled feature flag change If change requests are not enabled for your environment, you can schedule a flag change directly: 1. In the Features list view, go to the feature flag you want to edit. -2. Choose the new value or state for the flag. +2. Choose the new value or state for the feature flag. 3. Click the **Schedule Update** button to set the date and time for the change to take effect. 4. Save your changes. The scheduled change will be queued and applied automatically at the specified time. @@ -43,13 +43,13 @@ If change requests are not enabled for your environment, you can schedule a flag ## Scheduled Flags and Change Requests -Scheduled flags awaiting application will be listed in the change request area as 'Pending'. +Scheduled feature flags awaiting application will be listed in the change request area as 'Pending'. -Once the scheduled date and time have passed and the flag change has been applied, the scheduled flag will automatically move to the 'Closed' list in the change request area. +Once the scheduled date and time have passed and the feature flag change has been applied, the scheduled feature flag will automatically move to the 'Closed' list in the change request area. --- ## What's next? -- To learn more about managing and approving changes to your flags, see the [change requests](../../advanced-use/change-requests.md) page. +- To learn more about managing and approving changes to your feature flags, see the [change requests](../../advanced-use/change-requests.md) page. - To learn how to monitor the performance and health of your feature flags, see the [feature health metrics](./feature-health-metrics.md) page. diff --git a/docs/docs/managing-flags/rollout/rollout-by-attribute.md b/docs/docs/managing-flags/rollout/rollout-by-attribute.md index acd9e6186e7e..6bd079cdd48b 100644 --- a/docs/docs/managing-flags/rollout/rollout-by-attribute.md +++ b/docs/docs/managing-flags/rollout/rollout-by-attribute.md @@ -35,9 +35,9 @@ flagsmith.setTrait('version', '5.4.1'); ### 3. Apply a Segment Override to Your Feature Flag -1. In the environment where you want to apply the rollout, go to the **Features** section and select the feature you want to roll out. +1. In the environment where you want to apply the rollout, go to the **Features** section and select the feature flag you want to roll out. 2. Navigate to the **Segment Overrides** tab. -- Select the segment you created in the dropdown and set the desired flag state or value for users in that segment. +- Select the segment you created in the dropdown and set the desired feature flag state or value for users in that segment. - Save your changes. Done! Now you can test with users who match (and don’t match) the segment to ensure the feature is enabled/disabled as expected. diff --git a/docs/docs/managing-flags/rollout/rollout-by-percentage.md b/docs/docs/managing-flags/rollout/rollout-by-percentage.md index a1a2ad1a4aea..a89bca38b95b 100644 --- a/docs/docs/managing-flags/rollout/rollout-by-percentage.md +++ b/docs/docs/managing-flags/rollout/rollout-by-percentage.md @@ -6,7 +6,7 @@ sidebar_position: 2 **Rollouts by percentage** (also known as staged feature rollouts) allow you to test a new feature with a small subset of your user base. If you are happy with the feature, you can increase the percentage of users that see the feature until it is available to your entire user base. -This method increases confidence in rolling out a new feature. If issues arise, you can disable the feature flag, thus hiding the feature within your application. +This method increases confidence in rolling out a new feature. If issues arise, you can disable the feature flag, thus hiding the feature flag within your application. ## Prerequisites @@ -43,13 +43,13 @@ Before you begin, make sure you have: - Go to the **Features** section and select the feature you want to roll out. - In the environment where you want to apply the rollout, go to the **Segment Overrides** tab. -- Add the segment you created and set the desired flag state or value for users in that segment. +- Add the segment you created and set the desired feature flag state or value for users in that segment. ### 3. Save and Monitor - Save your changes. - Monitor the rollout. If all goes well, gradually increase the **% Split** value to roll out the feature to more users over time. -- If issues arise, you can quickly disable the feature for all users by removing the override or setting the flag to disabled. +- If issues arise, you can quickly disable the feature flag for all users by removing the override or setting the feature flag to disabled. --- diff --git a/docs/docs/managing-flags/tagging.md b/docs/docs/managing-flags/tagging.md index e5aaf700854d..cbebe1f37f91 100644 --- a/docs/docs/managing-flags/tagging.md +++ b/docs/docs/managing-flags/tagging.md @@ -4,7 +4,7 @@ sidebar_label: Tagging sidebar_position: 2 --- -You can create tags within Flagsmith and tag flags in order to organise them. Tags can also be used to filter the list of flags in the event that you have a large number of them. +You can create tags within Flagsmith and tag feature flags in order to organise them. Tags can also be used to filter the list of feature flags in the event that you have a large number of them. This guide explains how to create and apply tags to feature flags within Flagsmith, as well as some tagging good practices and conventions. @@ -14,21 +14,21 @@ This guide explains how to create and apply tags to feature flags within Flagsmi You can add tags to feature flags during creation or when editing an existing flag. -### When Creating a Flag +### When Creating a Feature Flag 1. Go to the **Features** section in your dashboard. 2. Click **Create Feature**. -3. Fill in the flag details. In the **Tags** field (optional), enter one or more tags to organise your flag. You can also add special tags such as `protected` to prevent accidental deletion. +3. Fill in the feature flag details. In the **Tags** field (optional), enter one or more tags to organise your feature flag. You can also add special tags such as `protected` to prevent accidental deletion. 4. Click **Create Feature** to save your changes. -### When Editing a Flag +### When Editing a Feature Flag -1. In the **Features** section, select the flag you want to edit. +1. In the **Features** section, select the feature flag you want to edit. 2. Go to the **Settings** tab. 3. In the **Tags** field, add or remove tags as needed. 4. Click **Update Settings** to save your changes. -You can quickly find and manage flags by using the **tag filter** in the Features list to display only flags with specific tags. This is especially useful for large projects with many flags. +You can quickly find and manage feature flags by using the **tag filter** in the Features list to display only feature flags with specific tags. This is especially useful for large projects with many feature flags. --- @@ -41,7 +41,7 @@ You can quickly find and manage flags by using the **tag filter** in the Feature :::info Protected Tags -Tags with the following names will prevent users from being able to delete tagged flags via the dashboard: +Tags with the following names will prevent users from being able to delete tagged feature flags via the dashboard: - `protected` - `donotdelete` @@ -53,14 +53,14 @@ Tags with the following names will prevent users from being able to delete tagge --- ## Best Practices for Tag Management -- Use tags to group related flags (e.g., by feature, team, or release). -- Apply protected tags (`protected`, `donotdelete`, `permanent`) to critical or long-lived flags to prevent accidental deletion. -- Regularly review and update tags to keep your flag management organised. +- Use tags to group related feature flags (e.g., by feature, team, or release). +- Apply protected tags (`protected`, `donotdelete`, `permanent`) to critical or long-lived feature flags to prevent accidental deletion. +- Regularly review and update tags to keep your feature flag management organised. --- ## What's Next - Learn how to configure [tag-based permissions for roles](../system-administration/rbac.md). -- See more advanced [flag management](../advanced-use/flag-management.md) techniques. +- See more advanced [feature flag management](../advanced-use/flag-management.md) techniques. From 6745fccddd71682765f947819a607d5d7feee49f Mon Sep 17 00:00:00 2001 From: Guilherme Date: Fri, 29 Aug 2025 09:48:27 -0300 Subject: [PATCH 14/14] Update docs/docs/managing-flags/core-management.md --- docs/docs/managing-flags/core-management.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/managing-flags/core-management.md b/docs/docs/managing-flags/core-management.md index 127a18f447f6..4b97095352e6 100644 --- a/docs/docs/managing-flags/core-management.md +++ b/docs/docs/managing-flags/core-management.md @@ -4,7 +4,7 @@ sidebar_label: Basic Flag Management sidebar_position: 1 --- -Feature Flags in Flagsmith are used to categorise and monitor user actions or events, such as detecting spam or abuse. This guide covers how to create, edit, clone, and delete flags in your project. +Feature flags in Flagsmith are used to categorise and monitor user actions or events, such as detecting spam or abuse. This guide covers how to create, edit, clone, and delete flags in your project. ---