diff --git a/pages/feature-flags/_meta.json b/pages/feature-flags/_meta.json index afa7b79..acf45cb 100644 --- a/pages/feature-flags/_meta.json +++ b/pages/feature-flags/_meta.json @@ -1,8 +1,9 @@ { + "the-flag-list": "The Flag List", + "organizing-flags": "Organizing flags", "create-flag-variations": "Create flag variations", "targeting-users-with-flags": "Targeting users with flags", "the-flag-insights": "The flag insights", - "organizing-flags": "Organizing flags", "users-and-user-segments": "Users and user segments", "feature-workflow": "Feature workflow", "audit-log": "Audit log" diff --git a/pages/feature-flags/assets/organizing-flags/clone-existing-flags/open-clone-dialog.png b/pages/feature-flags/assets/organizing-flags/clone-existing-flags/open-clone-dialog.png new file mode 100644 index 0000000..9eee1d4 Binary files /dev/null and b/pages/feature-flags/assets/organizing-flags/clone-existing-flags/open-clone-dialog.png differ diff --git a/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/compare-drawer.png b/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/compare-drawer.png new file mode 100644 index 0000000..fcd92de Binary files /dev/null and b/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/compare-drawer.png differ diff --git a/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/compare-settings.png b/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/compare-settings.png new file mode 100644 index 0000000..51a68ea Binary files /dev/null and b/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/compare-settings.png differ diff --git a/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/helicopter-view-index.png b/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/helicopter-view-index.png new file mode 100644 index 0000000..7e73cf4 Binary files /dev/null and b/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/helicopter-view-index.png differ diff --git a/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/helicopter-view-open-detail.png b/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/helicopter-view-open-detail.png new file mode 100644 index 0000000..0a25669 Binary files /dev/null and b/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/helicopter-view-open-detail.png differ diff --git a/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/helicopter-view-results.png b/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/helicopter-view-results.png new file mode 100644 index 0000000..194821f Binary files /dev/null and b/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/helicopter-view-results.png differ diff --git a/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/value-after-applied.png b/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/value-after-applied.png new file mode 100644 index 0000000..2173a79 Binary files /dev/null and b/pages/feature-flags/assets/organizing-flags/compare-and-copy-settings/value-after-applied.png differ diff --git a/pages/feature-flags/assets/organizing-flags/copy-flags/batch-copy-flags.png b/pages/feature-flags/assets/organizing-flags/copy-flags/batch-copy-flags.png new file mode 100644 index 0000000..cd33d99 Binary files /dev/null and b/pages/feature-flags/assets/organizing-flags/copy-flags/batch-copy-flags.png differ diff --git a/pages/feature-flags/assets/organizing-flags/copy-flags/choose-env-n-flags.png b/pages/feature-flags/assets/organizing-flags/copy-flags/choose-env-n-flags.png deleted file mode 100644 index 81f110b..0000000 Binary files a/pages/feature-flags/assets/organizing-flags/copy-flags/choose-env-n-flags.png and /dev/null differ diff --git a/pages/feature-flags/assets/organizing-flags/copy-flags/copy-setting-validation.png b/pages/feature-flags/assets/organizing-flags/copy-flags/copy-setting-validation.png deleted file mode 100644 index c98e90b..0000000 Binary files a/pages/feature-flags/assets/organizing-flags/copy-flags/copy-setting-validation.png and /dev/null differ diff --git a/pages/feature-flags/assets/organizing-flags/copy-flags/copy-single-flag-precheck-result.png b/pages/feature-flags/assets/organizing-flags/copy-flags/copy-single-flag-precheck-result.png new file mode 100644 index 0000000..8bbbd3f Binary files /dev/null and b/pages/feature-flags/assets/organizing-flags/copy-flags/copy-single-flag-precheck-result.png differ diff --git a/pages/feature-flags/assets/organizing-flags/copy-flags/copy-single-flag.png b/pages/feature-flags/assets/organizing-flags/copy-flags/copy-single-flag.png new file mode 100644 index 0000000..1a287e8 Binary files /dev/null and b/pages/feature-flags/assets/organizing-flags/copy-flags/copy-single-flag.png differ diff --git a/pages/feature-flags/assets/organizing-flags/copy-flags/restrictions.png b/pages/feature-flags/assets/organizing-flags/copy-flags/restrictions.png index 87d9a63..c44e554 100644 Binary files a/pages/feature-flags/assets/organizing-flags/copy-flags/restrictions.png and b/pages/feature-flags/assets/organizing-flags/copy-flags/restrictions.png differ diff --git a/pages/feature-flags/assets/organizing-flags/copy-flags/select-flags.png b/pages/feature-flags/assets/organizing-flags/copy-flags/select-flags.png index c403ab9..ec11603 100644 Binary files a/pages/feature-flags/assets/organizing-flags/copy-flags/select-flags.png and b/pages/feature-flags/assets/organizing-flags/copy-flags/select-flags.png differ diff --git a/pages/feature-flags/assets/organizing-flags/the-flags-list/001.webp b/pages/feature-flags/assets/organizing-flags/the-flags-list/001.webp deleted file mode 100644 index 48cacd3..0000000 Binary files a/pages/feature-flags/assets/organizing-flags/the-flags-list/001.webp and /dev/null differ diff --git a/pages/feature-flags/assets/organizing-flags/the-flags-list/002.webp b/pages/feature-flags/assets/organizing-flags/the-flags-list/002.webp deleted file mode 100644 index dcd8912..0000000 Binary files a/pages/feature-flags/assets/organizing-flags/the-flags-list/002.webp and /dev/null differ diff --git a/pages/feature-flags/assets/organizing-flags/the-flags-list/003.webp b/pages/feature-flags/assets/organizing-flags/the-flags-list/003.webp deleted file mode 100644 index 7241e49..0000000 Binary files a/pages/feature-flags/assets/organizing-flags/the-flags-list/003.webp and /dev/null differ diff --git a/pages/feature-flags/assets/organizing-flags/the-flags-list/004.webp b/pages/feature-flags/assets/organizing-flags/the-flags-list/004.webp deleted file mode 100644 index 11f8725..0000000 Binary files a/pages/feature-flags/assets/organizing-flags/the-flags-list/004.webp and /dev/null differ diff --git a/pages/feature-flags/assets/the-flag-list/overview.png b/pages/feature-flags/assets/the-flag-list/overview.png new file mode 100644 index 0000000..57b10ff Binary files /dev/null and b/pages/feature-flags/assets/the-flag-list/overview.png differ diff --git a/pages/feature-flags/assets/the-flag-list/sort-flags-by.png b/pages/feature-flags/assets/the-flag-list/sort-flags-by.png new file mode 100644 index 0000000..3922f90 Binary files /dev/null and b/pages/feature-flags/assets/the-flag-list/sort-flags-by.png differ diff --git a/pages/feature-flags/organizing-flags/_meta.json b/pages/feature-flags/organizing-flags/_meta.json index 17953ea..b60f11e 100644 --- a/pages/feature-flags/organizing-flags/_meta.json +++ b/pages/feature-flags/organizing-flags/_meta.json @@ -1,7 +1,8 @@ { - "the-flags-list": "Targeting rules", - "copy-flags": "Copy flags", "projects": "Projects", "environments": "Environments", + "copy-flags": "Copy flags", + "clone-existing-flags": "Clone existing flags", + "compare-and-copy-settings": "Compare and copy settings", "archiving-and-deleting": "Archiving and Deleting" } \ No newline at end of file diff --git a/pages/feature-flags/organizing-flags/clone-existing-flags.md b/pages/feature-flags/organizing-flags/clone-existing-flags.md new file mode 100644 index 0000000..21dd3c4 --- /dev/null +++ b/pages/feature-flags/organizing-flags/clone-existing-flags.md @@ -0,0 +1,18 @@ +# Cloning existing flags + +## Overview + +This topic explains how to create new flags within the same environment by cloning existing flags. When you clone a flag, FeatBit creates a new flag and copies the original flag’s on/off state and targeting settings to the new flag. You can then modify the clone’s configuration if needed. + +To clone a flag: + +1. Navigate to the flag list and choose the flag you want to clone. +2. Click the **Clone** action button to open the "Clone feature flag" dialog. + + ![Clone feature flag](../../feature-flags/assets/organizing-flags/clone-existing-flags/open-clone-dialog.png) + +3. In the dialog, enter a unique, human-readable **Name** for the new flag. +4. (Optional) The **Key** field auto-populates based on the name you enter, but you can modify it if needed. +5. (Optional) Enter a Description of the new flag. A brief, human-readable description helps your team members understand what the flag is for. +6. (Optional) Choose one or more tags for your flag. +7. Click the **Clone** button to create the new flag. \ No newline at end of file diff --git a/pages/feature-flags/organizing-flags/compare-and-copy-settings.mdx b/pages/feature-flags/organizing-flags/compare-and-copy-settings.mdx new file mode 100644 index 0000000..b5de64f --- /dev/null +++ b/pages/feature-flags/organizing-flags/compare-and-copy-settings.mdx @@ -0,0 +1,55 @@ +import { Callout } from 'nextra/components' + +# Compare and copy settings + +## Overview + +This topic explains how to compare a feature flag’s settings between two project environments and copy selected settings to another environment for the same flag key. + +## Compare settings + +To compare flag settings between two project environments: + +1. Navigate to the flags list and select the flag you want to compare. +2. Click **Compare** to open the Compare drawer, as shown below: + + ![Compare feature flag drawer](../assets/organizing-flags/compare-and-copy-settings/compare-drawer.png) + +3. In the drawer, select the target environment to compare with the current environment. +4. If a flag with the same key does not exist in the target environment, you will see a message indicating that. Otherwise, a side-by-side comparison of the flag settings appears, as shown below: + + ![Compare flag settings](../assets/organizing-flags/compare-and-copy-settings/compare-settings.png) + +## Copy settings + +When reviewing the comparison result, you can select settings that differ and copy them from the current environment to the target environment. + +When copying `Individual Targeting` and `Targeting Rules`, you can choose whether to **append** to the existing settings in the target environment or **overwrite** them. + + +Targeting rules cannot be copied if any rule references environment-specific segments or uses shared segments that are incompatible with the target environment. + + +1. In the comparison view, select the settings you want to copy by checking the corresponding checkboxes. +2. When you select a setting, the "Value after applied" section shows the expected value after the copy is applied. + + ![Show value after applied](../assets/organizing-flags/compare-and-copy-settings/value-after-applied.png) + +3. After selecting the desired settings, click the **Copy Settings** button. + +## Helicopter view + +You can also get a helicopter view of all flags with differences between project environments. To do this: + +1. Navigate to the flag list of your project. +2. Click the **Compare** button in the top right corner of the page to open the helicopter view index page. + + ![Helicopter view index](../assets/organizing-flags/compare-and-copy-settings/helicopter-view-index.png) +3. On the helicopter view index page, select the target project environments you want to compare with the current environment, and then click **Apply**. +4. A comparison overview table appears. Columns represent the selected target environments, while rows represent the flags. Each cell shows differences between the current environment and the target environment for that flag. + + ![Helicopter view results](../assets/organizing-flags/compare-and-copy-settings/helicopter-view-results.png) + +5. You can also click on a cell to open the detailed comparison view for that specific flag between the two environments. + + ![Helicopter view open detail](../assets/organizing-flags/compare-and-copy-settings/helicopter-view-open-detail.png) \ No newline at end of file diff --git a/pages/feature-flags/organizing-flags/copy-flags.md b/pages/feature-flags/organizing-flags/copy-flags.md new file mode 100644 index 0000000..e409531 --- /dev/null +++ b/pages/feature-flags/organizing-flags/copy-flags.md @@ -0,0 +1,38 @@ +# Copy feature flags across project environments + +## Overview + +This topic explains how to copy feature flags across different project environments within your organization. + +## Copy Feature Flags + +In the flags list page, click the **Copy To** action button and then the dialog shows up: + +![Copy single flag](../../feature-flags/assets/organizing-flags/copy-flags/copy-single-flag.png) + +After that, choose the target environment to which you want to copy the flag, a precheck will then be done to make sure if we can fully copy the flag to the target environment + +![Copy precheck result](../../feature-flags/assets/organizing-flags/copy-flags/copy-single-flag-precheck-result.png) + +If there is no issue to you, click the **Save** button to confirm, and the feature flag will be copied to the target project environment. + +## Batch Copy + +Select the flags you want to copy from the flags list. Then, click the **Batch Copy To** button, as shown below: + +![Select the flags to copy](../../feature-flags/assets/organizing-flags/copy-flags/select-flags.png) + +Choose the target environment to which you want to copy the flags. Then, check the flags you want to copy. Once you've made your selections, click the **Save** button. + +## Current Restrictions + +Certain scenarios will prevent fully copying feature flags: + +1. **Duplicate Keys**: A flag cannot be copied if the target environment already contains a flag with the same key. +2. **Individual Users**: Individual user targets cannot be copied because user data is environment-specific. +3. **Restricted Shareable Segments**: Targeting rules cannot be copied if the flag references a shareable segment, but the scope of that shareable segment does not contain the target environment. +4. **Environment-Specific Segments**: Targeting rules cannot be copied if the flag references an environment-specific segment. + +As shown below, a warning message will appear if you attempt to copy a feature flag that has one or more of these restrictions. + +![Restrictions on copying feature flags](../../feature-flags/assets/organizing-flags/copy-flags/restrictions.png) diff --git a/pages/feature-flags/organizing-flags/copy-flags.mdx b/pages/feature-flags/organizing-flags/copy-flags.mdx deleted file mode 100644 index 93d70ed..0000000 --- a/pages/feature-flags/organizing-flags/copy-flags.mdx +++ /dev/null @@ -1,37 +0,0 @@ -import { Callout } from 'nextra/components' - -# Copy feature flags (with settings) across environments - -## Overview - -This topic explains how to copy feature flags (with settings) from an environment to another in the same project. - -## Select the flags to copy - -Select the flags you want to copy from the list. Then, click the 'Copy to environment' button, as shown below: - -![Select the flags to copy](../../feature-flags/assets/organizing-flags/copy-flags/select-flags.png) - -Choose the target environment to which you want to copy the flags. Then, select the flags you want to copy. Once you've made your selections, click the 'Save' button. - -![Choose the target environment and the flags to copy](../../feature-flags/assets/organizing-flags/copy-flags/choose-env-n-flags.png) - -This process will copy both the flags and their settings to the target environment, as shown below. - -![Copying feature flags and their settings to the target environment](../../feature-flags/assets/organizing-flags/copy-flags/copy-setting-validation.png) - -However, there are some restrictions on which settings can be copied, and certain feature flags or settings cannot be copied. - -## Restrictions on copying feature flags and their settings - -Certain scenarios will prevent the copying of feature flags and their settings: - -1. If the target environment already contains the same feature flag key, it will not be copied. -2. If the feature flag includes a shareable segment, but the scope of the shareable segment does not include the target environment, the feature flag can be copied, but the targeting rules will not be. -3. If the targeting rules contain a non-shareable segment, the feature flag can be copied, but the targeting rules will not be. -4. Individual targeting users will not be copied. -5. Any element related to individual targeting users in the feature flag or segment will impact the entire copy process. - -As shown below, a warning message will appear if you attempt to copy a feature flag that has one or more of these restrictions." - -![Restrictions on copying feature flags and their settings](../../feature-flags/assets/organizing-flags/copy-flags/restrictions.png) diff --git a/pages/feature-flags/organizing-flags/the-flags-list.mdx b/pages/feature-flags/organizing-flags/the-flags-list.mdx deleted file mode 100644 index 165241d..0000000 --- a/pages/feature-flags/organizing-flags/the-flags-list.mdx +++ /dev/null @@ -1,54 +0,0 @@ -import { Callout } from 'nextra/components' - -# The flags list - -## Overview - -This topic explains how to use the feature flags list, which shows your feature flags and gives you options to create, modify, and manage them. - -## Viewing feature flags - -All of your feature flags **within an environment** appear on the flags list. Creating a new flag adds it to the list, and archiving a flag removes it from the list. You can use the search bar to find a flag by name, key, tag, or status. - -By default, the most recently updated flags appear first, and archived flags **will not** be shown in the list. To view the archived flag list, you need to check the 'Archived' checkbox. - -Here is an image of the feature flags list: - -![](../../feature-flags/assets/organizing-flags/the-flags-list/001.webp) - -## Creating feature flags - -To create a feature flag: - -1. Navigate to the flag list. -2. Click **Add** button. The "New feature flag" dialog appears. -3. Enter a unique, human-readable Name. -4. Click **Save** button. - -![](../../feature-flags/assets/organizing-flags/the-flags-list/002.webp) - - -**NOTE:** A suggested key auto-populates when you enter the name, you'll use this key to reference the flag in your code. After you save the flag key, you **cannot modify** it. You can change a flag's name, however, whenever you want. - - -You just created a feature flag. It appears in the list. - -## Copying feature flags - -To copy flags from one environment to another environment: - -1. Navigate to the flag list. -2. Choose the flags you wish to copy. -3. Hover on the overflow menu button and choose **Copy to environment**. - -![](../../feature-flags/assets/organizing-flags/the-flags-list/003.webp) - -4. Check the selected flags again and choose the targeting environment which flags will be copied to. - -![](../../feature-flags/assets/organizing-flags/the-flags-list/004.webp) - -5. Click **Ok** button. - - -**Note: The Targeting user and rules will not be copied.** Because one of your rules may references a segment that does not exist in the target environment and the targeting user also may not exist in the target environment. - diff --git a/pages/feature-flags/the-flag-list.md b/pages/feature-flags/the-flag-list.md new file mode 100644 index 0000000..156e46f --- /dev/null +++ b/pages/feature-flags/the-flag-list.md @@ -0,0 +1,26 @@ +# The flag list + +## Overview + +This topic explains how to use the feature flags list, which shows your feature flags and gives you options to create, modify, and manage them. + +## Viewing feature flags + +All of your feature flags **within an environment** appear on the flags list. Creating a new flag adds it to the list, and archiving a flag removes it from the list. You can use the search bar to find a flag by name, key, tag, or status. +By default, the archived flags **will not** be shown in the list. To view them, you need to check the **Archived** checkbox. + +Here is an image of the feature flags list: + +![Flag List](../feature-flags/assets/the-flag-list/overview.png) + +## Sort feature flags + +By default, the most recently created flags appear first, and you can configure this default sorting behavior at the **organization level**. +We currently support two sorting options: + +- **Recently created**: Flags are sorted based on their creation date, in **descending** order. +- **Key Alphabetical order**: Flags are sorted in alphabetical order based on their keys, in **ascending** order (a to z). + +Here is an image showing how to configure the default sorting behavior: + +![Sort Flags By](../feature-flags/assets/the-flag-list/sort-flags-by.png) diff --git a/pages/licenses/overview.md b/pages/licenses/overview.md index 9b01ade..d94d060 100644 --- a/pages/licenses/overview.md +++ b/pages/licenses/overview.md @@ -4,9 +4,14 @@ FeatBit is an Open Core product, with the majority of its code under the permiss Certain features in FeatBit are subject to licensing restrictions and require a valid license key. These features include: -- Schedule -- Change request +- Schedule Flag Changes +- Flag Change Requests - Single Sign-On (SSO) - Multi-organizations +- Global User +- Shareable Segments +- Auto Agents +- Fine-grained Access Control +- Flag Comparison Each license key is associated with a specific workspace. Once set up, the license key applies to all organizations within that workspace. \ No newline at end of file