diff --git a/src/test/e2e/helpers/database.json b/src/test/e2e/helpers/database.json index 602bba301f..63a025170f 100644 --- a/src/test/e2e/helpers/database.json +++ b/src/test/e2e/helpers/database.json @@ -34,7 +34,7 @@ { "name": "groupId", "type": "string", - "description": "Used to define a activation groups, which allows you to correlate across feature toggles.", + "description": "Used to define a activation groups, which allows you to correlate across feature flags.", "required": true } ] diff --git a/src/test/examples/import.yml b/src/test/examples/import.yml index 3976723f4b..47765849bf 100644 --- a/src/test/examples/import.yml +++ b/src/test/examples/import.yml @@ -30,7 +30,7 @@ features: - name: default parameters: {} - name: feature.with.variants - description: A feature toggle with watiants + description: A feature flag with variants enabled: true archived: false strategies: diff --git a/website/docs/feature-flag-tutorials/dotnet/dotnet-examples.md b/website/docs/feature-flag-tutorials/dotnet/dotnet-examples.md index 4812cc0f5a..96902eeb99 100644 --- a/website/docs/feature-flag-tutorials/dotnet/dotnet-examples.md +++ b/website/docs/feature-flag-tutorials/dotnet/dotnet-examples.md @@ -232,11 +232,11 @@ At the flag level in Unleash, navigate to the Settings view. ![From your flag page in Unleash, you go to Settings and edit the settings for your flag called 'feature information'.](../ruby/flag-settings.png) -In the Settings view, there's an edit button with pencil icon. This will take us to the ‘Edit Feature toggle’ form. +In the Settings view, there's an edit button with pencil icon. This will take us to the ‘Edit Feature flag’ form. Turn on the impression data and then save it. Events will now be emitted every time the feature flag is triggered. -![There is a toggle that turns on the impression data events in your flag form.](../ruby/enable-impression-data.png) +![There is a flag that turns on the impression data events in your flag form.](../ruby/enable-impression-data.png) You can also use our API command to enable the impression data: diff --git a/website/docs/reference/api/legacy/unleash/admin/archive.md b/website/docs/reference/api/legacy/unleash/admin/archive.md index fe87d83df7..68079f5880 100644 --- a/website/docs/reference/api/legacy/unleash/admin/archive.md +++ b/website/docs/reference/api/legacy/unleash/admin/archive.md @@ -4,11 +4,11 @@ title: /api/admin/archive > In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token. -### Fetch archived toggles {#fetch-archived-toggles} +### Fetch archived flags {#fetch-archived-toggles} `GET http://unleash.host.com/api/admin/archive/features` -Used to fetch list of archived feature toggles +Used to fetch list of archived feature flags **Example response:** @@ -30,14 +30,14 @@ Used to fetch list of archived feature toggles } ``` -### Revive feature toggle {#revive-feature-toggle} +### Revive feature flag {#revive-feature-toggle} `POST http://unleash.host.com/api/admin/archive/revive/:featureName` -Response: **200 OK** - When feature toggle was successfully revived. +Response: **200 OK** - When feature flag was successfully revived. -### Delete an archived feature toggle +### Delete an archived feature flag `DELETE http://unleash.host.com/api/admin/archive/:featureName` -Will fully remove the feature toggle and associated configuration. Impossible to restore after this action. +Will fully remove the feature flag and associated configuration. Impossible to restore after this action. diff --git a/website/docs/reference/api/legacy/unleash/admin/features.md b/website/docs/reference/api/legacy/unleash/admin/features.md index 405a3d3cb1..d903f6f298 100644 --- a/website/docs/reference/api/legacy/unleash/admin/features.md +++ b/website/docs/reference/api/legacy/unleash/admin/features.md @@ -14,17 +14,17 @@ In order to access the admin API endpoints you need to identify yourself. Unless ::: -## Fetching Feature Toggles {#fetching-feature-toggles} +## Fetching Feature Flags {#fetching-feature-toggles} :::caution Deprecation notice -This endpoint was removed in Unleash v5. Please use the [project-based endpoint to fetch all toggles](/reference/api/legacy/unleash/admin/features-v2.md#fetching-toggles) instead. +This endpoint was removed in Unleash v5. Please use the [project-based endpoint to fetch all flags](/reference/api/legacy/unleash/admin/features-v2.md#fetching-toggles) instead. ::: `GET: http://unleash.host.com/api/admin/features` -This endpoint is the one all admin ui should use to fetch all available feature toggles from the _unleash-server_. The response returns all active feature toggles and their current strategy configuration. A feature toggle will have _at least_ one configured strategy. A strategy will have a `name` and `parameters` map. +This endpoint is the one all admin ui should use to fetch all available feature flags from the _unleash-server_. The response returns all active feature flags and their current strategy configuration. A feature flag will have _at least_ one configured strategy. A strategy will have a `name` and `parameters` map. **Example response:** @@ -88,7 +88,7 @@ This endpoint is the one all admin ui should use to fetch all available feature } ``` -### Filter feature toggles {#filter-feature-toggles} +### Filter feature flags {#filter-feature-toggles} Supports three params for now @@ -108,11 +108,11 @@ To filter for any feature belonging to project `myproject` use Response format is the same as `api/admin/features` -## Fetch specific feature toggle {#fetch-specific-feature-toggle} +## Fetch specific feature flag {#fetch-specific-feature-toggle} :::caution Removal notice -This endpoint was removed in Unleash v5 (deprecated since v4). Please use the [project-based endpoint to fetch specific toggles](/reference/api/legacy/unleash/admin/features-v2.md#get-toggle) instead. +This endpoint was removed in Unleash v5 (deprecated since v4). Please use the [project-based endpoint to fetch specific flags](/reference/api/legacy/unleash/admin/features-v2.md#get-toggle) instead. ::: @@ -138,11 +138,11 @@ Used to fetch details about a specific featureToggle. This is mostly provded to } ``` -## Create a new Feature Toggle {#create-a-new-feature-toggle} +## Create a new Feature Flag {#create-a-new-feature-toggle} :::caution Removal notice -This endpoint was removed in Unleash v5 (deprecated since v4). Please use the [project-based endpoint to create feature toggles](/reference/api/legacy/unleash/admin/features-v2.md#create-toggle) instead. +This endpoint was removed in Unleash v5 (deprecated since v4). Please use the [project-based endpoint to create feature flags](/reference/api/legacy/unleash/admin/features-v2.md#create-toggle) instead. ::: @@ -168,19 +168,19 @@ This endpoint was removed in Unleash v5 (deprecated since v4). Please use the [p } ``` -Used by the admin-dashboard to create a new feature toggles. +Used by the admin-dashboard to create a new feature flags. **Notes:** - _name_ **must be globally unique**, otherwise you will get a _403-response_. - _type_ is optional. If not defined it defaults to `release` -Returns 200-response if the feature toggle was created successfully. +Returns 200-response if the feature flag was created successfully. -## Update a Feature Toggle {#update-a-feature-toggle} +## Update a Feature Flag {#update-a-feature-toggle} :::caution Removal notice -This endpoint was removed in Unleash v5. Please use the [project-based endpoint to update a feature toggle](/reference/api/legacy/unleash/admin/features-v2.md#update-toggle) instead. +This endpoint was removed in Unleash v5. Please use the [project-based endpoint to update a feature flag](/reference/api/legacy/unleash/admin/features-v2.md#update-toggle) instead. ::: @@ -205,11 +205,11 @@ This endpoint was removed in Unleash v5. Please use the [project-based endpoint } ``` -Used by the admin dashboard to update a feature toggles. The name has to match an existing features toggle. +Used by the admin dashboard to update a feature flags. The name has to match an existing features flag. -Returns 200-response if the feature toggle was updated successfully. +Returns 200-response if the feature flag was updated successfully. -## Tag a Feature Toggle {#tag-a-feature-toggle} +## Tag a Feature Flag {#tag-a-feature-toggle} `POST https://unleash.host.com/api/admin/features/:featureName/tags` @@ -235,11 +235,11 @@ If the tuple (type, value) does not already exist, it will be added to the list - Returns _404-NOT-FOUND_ if the `type` was not found -## Remove a tag from a Feature Toggle {#remove-a-tag-from-a-feature-toggle} +## Remove a tag from a Feature Flag {#remove-a-tag-from-a-feature-toggle} `DELETE https://unleash.host.com/api/admin/features/:featureName/tags/:type/:value` -Removes the specified tag from the `(type, value)` tuple from the Feature Toggle's list of tags. +Removes the specified tag from the `(type, value)` tuple from the Feature Flag's list of tags. **Success** @@ -250,27 +250,27 @@ Removes the specified tag from the `(type, value)` tuple from the Feature Toggle - Returns 404 if the tag does not exist - Returns 500 if the database could not be reached -## Archive a Feature Toggle {#archive-a-feature-toggle} +## Archive a Feature Flag {#archive-a-feature-toggle} :::caution Removal notice -This endpoint was removed in v5. Please use the [project-based endpoint to archive toggles](/reference/api/legacy/unleash/admin/features-v2.md#archive-toggle) instead. +This endpoint was removed in v5. Please use the [project-based endpoint to archive flags](/reference/api/legacy/unleash/admin/features-v2.md#archive-toggle) instead. ::: `DELETE: http://unleash.host.com/api/admin/features/:toggleName` -Used to archive a feature toggle. A feature toggle can never be totally be deleted, but can be archived. This is a design decision to make sure that a old feature toggle does not suddenly reappear because someone else is re-using the same name. +Used to archive a feature flag. A feature flag can never be totally be deleted, but can be archived. This is a design decision to make sure that a old feature flag does not suddenly reappear because someone else is re-using the same name. -## Enable a Feature Toggle {#enable-a-feature-toggle} +## Enable a Feature Flag {#enable-a-feature-toggle} :::caution Removal notice -This endpoint was removed in v5. Please use the [project-based endpoint to enable feature toggles](/reference/api/legacy/unleash/admin/features-v2.md#enable-env) instead. +This endpoint was removed in v5. Please use the [project-based endpoint to enable feature flags](/reference/api/legacy/unleash/admin/features-v2.md#enable-env) instead. ::: `POST: http://unleash.host.com/api/admin/features/:featureName/toggle/on` -Used to enable a feature toggle. The :featureName must match an existing Feature Toggle. Returns 200-response if the feature toggle was enabled successfully. +Used to enable a feature flag. The :featureName must match an existing Feature Flag. Returns 200-response if the feature flag was enabled successfully. **Body** @@ -295,15 +295,15 @@ None } ``` -## Disable a Feature Toggle {#disable-a-feature-toggle} +## Disable a Feature Flag {#disable-a-feature-toggle} :::caution Removal notice -This endpoint was removed in v5. Please use the [project-based endpoint to disable feature toggles](/reference/api/legacy/unleash/admin/features-v2.md#disable-env) instead. +This endpoint was removed in v5. Please use the [project-based endpoint to disable feature flags](/reference/api/legacy/unleash/admin/features-v2.md#disable-env) instead. ::: `POST: http://unleash.host.com/api/admin/features/:featureName/toggle/off` -Used to disable a feature toggle. The :featureName must match an existing Feature Toggle. Returns 200-response if the feature toggle was disabled successfully. +Used to disable a feature flag. The :featureName must match an existing Feature Flag. Returns 200-response if the feature flag was disabled successfully. **Body** @@ -329,16 +329,16 @@ None } ``` -## Mark a Feature Toggle as "stale" {#mark-a-feature-toggle-as-stale} +## Mark a Feature Flag as "stale" {#mark-a-feature-toggle-as-stale} :::caution Removal notice -This endpoint was removed in v5. Please use the [project-based endpoint to patch a feature toggle and mark it as stale](/reference/api/legacy/unleash/admin/features-v2.md#patch-toggle) instead. +This endpoint was removed in v5. Please use the [project-based endpoint to patch a feature flag and mark it as stale](/reference/api/legacy/unleash/admin/features-v2.md#patch-toggle) instead. ::: `POST: http://unleash.host.com/api/admin/features/:featureName/stale/on` -Used to mark a feature toggle as stale (deprecated). The :featureName must match an existing Feature Toggle. Returns 200-response if the feature toggle was enabled successfully. +Used to mark a feature flag as stale (deprecated). The :featureName must match an existing Feature Flag. Returns 200-response if the feature flag was enabled successfully. **Body** @@ -364,15 +364,15 @@ None } ``` -## Mark a Feature Toggle as "active" {#mark-a-feature-toggle-as-active} +## Mark a Feature Flag as "active" {#mark-a-feature-toggle-as-active} :::caution Removal notice -This endpoint was removed in v5. Please use the [project-based endpoint to patch a feature toggle and mark it as not stale](/reference/api/legacy/unleash/admin/features-v2.md#patch-toggle) instead. +This endpoint was removed in v5. Please use the [project-based endpoint to patch a feature flag and mark it as not stale](/reference/api/legacy/unleash/admin/features-v2.md#patch-toggle) instead. ::: `POST: http://unleash.host.com/api/admin/features/:featureName/stale/off` -Used to mark a feature toggle active (remove stale marking). The :featureName must match an existing Feature Toggle. Returns 200-response if the feature toggle was disabled successfully. +Used to mark a feature flag active (remove stale marking). The :featureName must match an existing Feature Flag. Returns 200-response if the feature flag was disabled successfully. **Body** diff --git a/website/docs/reference/api/legacy/unleash/admin/metrics.md b/website/docs/reference/api/legacy/unleash/admin/metrics.md index af2673dd0b..35d3835e3f 100644 --- a/website/docs/reference/api/legacy/unleash/admin/metrics.md +++ b/website/docs/reference/api/legacy/unleash/admin/metrics.md @@ -16,7 +16,7 @@ This endpoint has been deprecated `GET http://unleash.host.com/api/admin/metrics/seen-toggles` -This enpoints returns a list of applications and what toogles unleash has seen for each application. It will only guarantee toggles reported by client applications within the last hour, but will in most cases remember seen toggles for applications longer. +This enpoints returns a list of applications and what toogles unleash has seen for each application. It will only guarantee flags reported by client applications within the last hour, but will in most cases remember seen flags for applications longer. **Example response:** @@ -24,12 +24,12 @@ This enpoints returns a list of applications and what toogles unleash has seen f [ { "appName": "demo-app", - "seenToggles": ["add-feature-2", "toggle-2", "toggle-3"], + "seenToggles": ["add-feature-2", "flag-2", "flag-3"], "metricsCount": 127 }, { "appName": "demo-app-2", - "seenToggles": ["add-feature-2", "toggle-2", "toggle-3"], + "seenToggles": ["add-feature-2", "flag-2", "flag-3"], "metricsCount": 21 } ] @@ -39,13 +39,13 @@ This enpoints returns a list of applications and what toogles unleash has seen f - **appName** - Name of the application seen by unleash-server - **seenToggles** - array of toggles names seen by unleash-server for this application -- **metricsCount** - number of metrics counted across all toggles for this application. +- **metricsCount** - number of metrics counted across all flags for this application. ### Feature-Toggles metrics {#feature-toggles-metrics} `GET http://unleash.host.com/api/admin/metrics/feature-toggles` -This endpoint gives _last minute_ and _last hour_ metrics for all active toggles. This is based on metrics reported by client applications. Yes is the number of times a given feature toggle was evaluated to enabled in a client application, and no is the number it was evaluated to false. +This endpoint gives _last minute_ and _last hour_ metrics for all active flags. This is based on metrics reported by client applications. Yes is the number of times a given feature flag was evaluated to enabled in a client application, and no is the number it was evaluated to false. **Example response:** @@ -56,11 +56,11 @@ This endpoint gives _last minute_ and _last hour_ metrics for all active toggles "yes": 0, "no": 527 }, - "toggle-2": { + "flag-2": { "yes": 265, "no": 85 }, - "toggle-3": { + "flag-3": { "yes": 257, "no": 93 } @@ -70,11 +70,11 @@ This endpoint gives _last minute_ and _last hour_ metrics for all active toggles "yes": 0, "no": 527 }, - "toggle-2": { + "flag-2": { "yes": 265, "no": 85 }, - "toggle-3": { + "flag-3": { "yes": 257, "no": 93 } @@ -84,8 +84,8 @@ This endpoint gives _last minute_ and _last hour_ metrics for all active toggles **Fields:** -- **lastHour** - Hour projection collected metrics for all feature toggles. -- **lastMinute** - Minute projection collected metrics for all feature toggles. +- **lastHour** - Hour projection collected metrics for all feature flags. +- **lastMinute** - Minute projection collected metrics for all feature flags. ### Applications {#applications} @@ -126,7 +126,7 @@ You can also specify the query param: _strategyName_, which will return all appl `GET http://unleash.host.com/api/admin/metrics/applications/:appName` -This endpoint gives insight into details about a client application, such as instances, strategies implemented and seen toggles. +This endpoint gives insight into details about a client application, such as instances, strategies implemented and seen flags. ```json { @@ -151,7 +151,7 @@ This endpoint gives insight into details about a client application, such as ins "strategies": ["default", "extra"] } ], - "seenToggles": ["add-feature-2", "toggle-2", "toggle-3"] + "seenToggles": ["add-feature-2", "flag-2", "flag-3"] } ``` @@ -165,7 +165,7 @@ This endpoint has been deprecated `GET http://unleash.host.com/api/admin/metrics/seen-apps` -This endpoint gives insight into details about application seen per feature toggle. +This endpoint gives insight into details about application seen per feature flag. ```json { diff --git a/website/docs/reference/api/legacy/unleash/admin/segments.mdx b/website/docs/reference/api/legacy/unleash/admin/segments.mdx index b80997a354..c1826fe29b 100644 --- a/website/docs/reference/api/legacy/unleash/admin/segments.mdx +++ b/website/docs/reference/api/legacy/unleash/admin/segments.mdx @@ -276,7 +276,7 @@ Use a JSON object with the following properties to update the list of applied se | Property | Type | Required | Description | Example value | |-----------------|-------------------------------|----------|---------------------------------------------------|-----------------| -| `projectId` | string | Yes | The ID of the feature toggle's project. | `"my-project"` | +| `projectId` | string | Yes | The ID of the feature flag's project. | `"my-project"` | | `strategyId` | string | Yes | The ID of the strategy. | `"my-strategy"` | | `environmentId` | string | Yes | The ID of the environment. | `"development"` | | `segmentIds` | list of segment IDs (numbers) | Yes | The list of segment IDs to apply to the strategy. | `[]` | diff --git a/website/docs/reference/api/legacy/unleash/admin/state.md b/website/docs/reference/api/legacy/unleash/admin/state.md index a7a73830af..f9d8aa7b5b 100644 --- a/website/docs/reference/api/legacy/unleash/admin/state.md +++ b/website/docs/reference/api/legacy/unleash/admin/state.md @@ -11,7 +11,7 @@ Api admin state is deprecated from version 5. We recommend using the new [Enviro > In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token. -### Export Feature Toggles & Strategies {#export-feature-toggles--strategies} +### Export Feature Flags & Strategies {#export-feature-toggles--strategies} `GET: http://unleash.host.com/api/admin/state/export` @@ -64,7 +64,7 @@ strategies: required: true ``` -### Import Feature Toggles & Strategies {#import-feature-toggles--strategies} +### Import Feature Flags & Strategies {#import-feature-toggles--strategies} `POST: http://unleash.host.com/api/admin/state/import` @@ -74,7 +74,7 @@ You can either send the data as JSON in the POST-body or send a `file` parameter **Query Paramters** - **drop** - Use this parameter if you want the database to be cleaned before import (all strategies and features will be removed). -- **keep** - Use this query parameter if you want to keep all exiting feature toggle (and strategy) configurations as is (no override), and only insert missing feature toggles from the data provided. +- **keep** - Use this query parameter if you want to keep all exiting feature flag (and strategy) configurations as is (no override), and only insert missing feature flags from the data provided. > You should be careful using the `drop` parameter in production environments. diff --git a/website/docs/reference/dependent-features.md b/website/docs/reference/dependent-features.md index 6c7fe3f5d9..24b801bbe5 100644 --- a/website/docs/reference/dependent-features.md +++ b/website/docs/reference/dependent-features.md @@ -32,7 +32,7 @@ Parent value criteria can be set to one of the 3 options: For the **variant dependencies**, if the parent feature variant is evaluated to the expected value, the dependency is satisfied. You can specify variant values from all [strategy variants](./strategy-variants.md) and all [feature environment variants](./feature-toggle-variants.md). The parent dependency variant is compared to the actual value that the parent dependency is evaluated to in a given environment. -Consult [strategy variants order](./strategy-variants.md#strategy-variants-and-strategies-order) and [variants comparison](./strategy-variants#strategy-variants-vs-feature-toggle-variants) sections for more details on the variant evaluation order. +Consult [strategy variants order](./strategy-variants.md#strategy-variants-and-strategies-order) and [variants comparison](./strategy-variants#strategy-variants-vs-feature-flag-variants) sections for more details on the variant evaluation order. ## Managing dependencies diff --git a/website/docs/reference/strategy-variants.md b/website/docs/reference/strategy-variants.md index 7df720113a..745f3b7ba3 100644 --- a/website/docs/reference/strategy-variants.md +++ b/website/docs/reference/strategy-variants.md @@ -77,7 +77,7 @@ Strategy stickiness is calculated on the received user and context, as described If you would like to reassign users to different variants using existing stickiness parameter then you can change the groupId of the strategy. This will provide different input to the stickiness calculation. -### Strategy variants vs feature toggle variants +### Strategy variants vs feature flag variants Strategy variants take precedence over the [feature flag variants](./feature-toggle-variants.md). If your matching activation strategy doesn't have any variants configured you will fall back to the [feature flag variants](./feature-toggle-variants.md). Since strategy variants are part of activation strategies they have full access to constraints and segments. Feature variants are much more limited since they only allow simple overrides. diff --git a/website/docs/reference/technical-debt.md b/website/docs/reference/technical-debt.md index 1414648c9e..7b41b8145d 100644 --- a/website/docs/reference/technical-debt.md +++ b/website/docs/reference/technical-debt.md @@ -2,29 +2,29 @@ title: Technical Debt --- -At Unleash we care deeply about code quality. Technical debt creeps up over time and slowly builds to the point where it really starts to hurt. At that point it's too late. Feature toggles that have outlived their feature and are not cleaned up represent technical debt that you should remove from your code. +At Unleash we care deeply about code quality. Technical debt creeps up over time and slowly builds to the point where it really starts to hurt. At that point it's too late. Feature flags that have outlived their feature and are not cleaned up represent technical debt that you should remove from your code. ## Stale and potentially stale toggles -When a toggle is no longer useful, we say that it has become _stale_. A stale toggle is a toggle that has served its purpose and that you should remove from the code base. For a toggle to become stale, you have to explicitly mark it as such. You can mark a toggle as stale in the [technical debt dashboard](#the-technical-debt-dashboard). +When a flag is no longer useful, we say that it has become _stale_. A stale flag is a flag that has served its purpose and that you should remove from the code base. For a flag to become stale, you have to explicitly mark it as such. You can mark a flag as stale in the [technical debt dashboard](#the-technical-debt-dashboard). -Unleash also has a concept of _potentially_ stale toggles. These are toggles that have lived longer than what Unleash expects them to based on their [feature toggle type](../reference/feature-toggle-types.md). However, Unleash can't know for sure whether a toggle is actually stale or not, so it's up to you to make the decision on whether to mark it as stale or to keep it as an active toggle. +Unleash also has a concept of _potentially_ stale flags. These are flags that have lived longer than what Unleash expects them to based on their [feature flag type](../reference/feature-toggle-types.md). However, Unleash can't know for sure whether a flag is actually stale or not, so it's up to you to make the decision on whether to mark it as stale or to keep it as an active flag. -A toggle being (potentially) stale, does not affect how it performs in your application; it's only there to make it easier for you to manage your toggles. +A flag being (potentially) stale, does not affect how it performs in your application; it's only there to make it easier for you to manage your flags. ## The technical debt dashboard -In order to assist with removing unused feature toggles, Unleash provides project health dashboards for each project. The health dashboard is listed as one of a project's tabs. +In order to assist with removing unused feature flags, Unleash provides project health dashboards for each project. The health dashboard is listed as one of a project's tabs. -![Three UI elements describing the health rating of the project. The first card has info on the project, including its name. The second is the "report card", containing the project's overall health rating, a toggle report, and potential actions. The last card is a list of all the project's toggles with data on when it was last seen, when it was created, when it expired, its status and a report.](/img/reporting.png) +![Three UI elements describing the health rating of the project. The first card has info on the project, including its name. The second is the "report card", containing the project's overall health rating, a flag report, and potential actions. The last card is a list of all the project's flags with data on when it was last seen, when it was created, when it expired, its status and a report.](/img/reporting.png) -The dashboard includes a health report card, and a list of toggles that can be filtered on different parameters. +The dashboard includes a health report card, and a list of flags that can be filtered on different parameters. ### Report card {#report-card} -![The project's health report card. It lists the project's health rating and when it was last updated; a toggle report containing the number of active toggles in the project; and potential actions, in this case asking the user to review potentially stale toggles.](/img/reportcard.png) +![The project's health report card. It lists the project's health rating and when it was last updated; a flag report containing the number of active flags in the project; and potential actions, in this case asking the user to review potentially stale flags.](/img/reportcard.png) -The report card includes some statistics of your application. It lists the overall amount of your active toggles, the overall amount of stale toggles, and lastly, the toggles that Unleash believes should be stale. This calculation is performed on the basis of toggle types: +The report card includes some statistics of your application. It lists the overall amount of your active flags, the overall amount of stale flags, and lastly, the flags that Unleash believes should be stale. This calculation is performed on the basis of flag types: - **Release** - Used to enable trunk-based development for teams practicing Continuous Delivery. _Expected lifetime 40 days_ - **Experiment** - Used to perform multivariate or A/B testing. _Expected lifetime 40 days_ @@ -32,18 +32,18 @@ The report card includes some statistics of your application. It lists the overa - **Kill switch** - Used to to gracefully degrade system functionality. _(permanent)_ - **Permission** - Used to change the features or product experience that certain users receive. _(permanent)_ -If your toggle exceeds the expected lifetime of its toggle type it will be marked as _potentially stale_. +If your flag exceeds the expected lifetime of its flag type it will be marked as _potentially stale_. One thing to note is that the report card and corresponding list are showing stats related to the currently selected project. If you have more than one project, you will be provided with a project selector in order to swap between the projects. ### Health rating -Unleash calculates a project's health rating based on the project's total number of active toggles and how many of those active toggles are stale or potentially stale. When you archive a toggle, it no longer counts towards your project's health rating. +Unleash calculates a project's health rating based on the project's total number of active flags and how many of those active flags are stale or potentially stale. When you archive a flag, it no longer counts towards your project's health rating. -The health rating updates once every hour, so there may be some lag if you have recently added, removed, or changed the status of a toggle. +The health rating updates once every hour, so there may be some lag if you have recently added, removed, or changed the status of a flag. -### Toggle list {#toggle-list} +### Flag list {#toggle-list} -![A table of the toggles in the current project with their health reports. The table has the following columns: name, last seen, created, expired, status, and report.](/img/togglelist.png) +![A table of the flags in the current project with their health reports. The table has the following columns: name, last seen, created, expired, status, and report.](/img/togglelist.png) -The toggle list gives an overview over all of your toggles and their status. In this list you can sort the toggles by their name, last seen, created, expired, status and report. This will allow you to quickly get an overview over which toggles may be worth deprecating and removing from the code. +The flag list gives an overview over all of your flags and their status. In this list you can sort the flags by their name, last seen, created, expired, status and report. This will allow you to quickly get an overview over which flags may be worth deprecating and removing from the code. diff --git a/website/docs/reference/unleash-context.md b/website/docs/reference/unleash-context.md index 8c34978f11..f87533077a 100644 --- a/website/docs/reference/unleash-context.md +++ b/website/docs/reference/unleash-context.md @@ -2,7 +2,7 @@ title: Unleash Context --- -The **Unleash Context** contains information relating to the current feature toggle request. Unleash uses this context to evaluate [activation strategies](activation-strategies.md) and [strategy constraints](../reference/strategy-constraints.md) and to calculate [toggle stickiness](../reference/stickiness.md). The Unleash Context is an important feature of all the [Unleash client SDKs](../reference/sdks/index.md). +The **Unleash Context** contains information relating to the current feature flag request. Unleash uses this context to evaluate [activation strategies](activation-strategies.md) and [strategy constraints](../reference/strategy-constraints.md) and to calculate [flag stickiness](../reference/stickiness.md). The Unleash Context is an important feature of all the [Unleash client SDKs](../reference/sdks/index.md). ## Structure @@ -10,7 +10,7 @@ You can group the Unleash Context fields into two separate groups based on how t **Static** fields' values remain constant throughout an application's lifetime. You'll typically set these when you initialize the client SDK. -**Dynamic** fields, however, can change with every request. You'll typically provide these when checking whether a toggle is enabled in your client. +**Dynamic** fields, however, can change with every request. You'll typically provide these when checking whether a flag is enabled in your client. _All fields are optional_, but some strategies depend on certain fields being present. For instance, [the UserIDs strategy](activation-strategies.md#userids) requires that the `userId` field is present on the Context. @@ -48,7 +48,7 @@ Before Unleash 4.16, custom context fields were only available to Unleash Pro an ::: -Custom context fields allow you to extend the Unleash Context with more data that is applicable to your situation. Each context field definition consists of a name and an optional description. Additionally, you can choose to define a set of [_legal values_](#legal-values "legal values for custom context fields"), and you can choose whether or not the context field can be used in [custom stickiness calculations](../reference/stickiness.md#custom-stickiness) for the [gradual rollout strategy](activation-strategies.md#customize-stickiness-beta) and for [feature toggle variants](../reference/feature-toggle-variants.md). +Custom context fields allow you to extend the Unleash Context with more data that is applicable to your situation. Each context field definition consists of a name and an optional description. Additionally, you can choose to define a set of [_legal values_](#legal-values "legal values for custom context fields"), and you can choose whether or not the context field can be used in [custom stickiness calculations](../reference/stickiness.md#custom-stickiness) for the [gradual rollout strategy](activation-strategies.md#customize-stickiness-beta) and for [feature flag variants](../reference/feature-toggle-variants.md). When interacting with custom context fields in code, they must be accessed via the Unleash Context's `properties` map, using the context field's name as the key. diff --git a/website/docs/reference/whats-new-v4.md b/website/docs/reference/whats-new-v4.md index d0b8f7cbeb..dc7b1d2815 100644 --- a/website/docs/reference/whats-new-v4.md +++ b/website/docs/reference/whats-new-v4.md @@ -51,4 +51,4 @@ In version 4 we improved the API Access and made it available for Unleash Open-S ### Custom stickiness {#custom-stickiness} In Unleash Enterprise v4 you can configure stickiness when you are -doing a gradual rollout with the "gradual rollout" strategy (previously known as "flexible rollout") or together with feature toggle variants. This means that you can now have consistent behavior based on any field available on the [Unleash context](unleash-context.md). +doing a gradual rollout with the "gradual rollout" strategy (previously known as "flexible rollout") or together with feature flag variants. This means that you can now have consistent behavior based on any field available on the [Unleash context](unleash-context.md). diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index cdcefbb8da..09f56fc321 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -41,7 +41,7 @@ const addDocsRoutePrefix = ({ from, ...rest }) => { /** @type {import('@docusaurus/types').DocusaurusConfig} */ module.exports = { title: 'Unleash', - tagline: 'The enterprise ready feature toggle service', + tagline: 'The enterprise ready feature flag service', url: 'https://docs.getunleash.io', baseUrl: '/', onBrokenLinks: 'throw',