Align availability information in the docs (#8177)

Unleash · Oct 3, 2024 · 415e348 · 415e348
1 parent 10dffcd
commit 415e348
Show file tree

Hide file tree

Showing 68 changed files with 256 additions and 253 deletions.
diff --git a/website/docs/how-to/how-to-add-feature-flag-naming-patterns.mdx b/website/docs/how-to/how-to-add-feature-flag-naming-patterns.mdx
@@ -2,9 +2,9 @@
 title: How to add feature flag naming patterns
 ---
 
-:::info Availability
+:::note Availability
 
-Feature flag naming patterns is an in-development, **enterprise-only** feature.
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.7`+
 
 :::
 

diff --git a/website/docs/how-to/how-to-add-strategy-constraints.md b/website/docs/how-to/how-to-add-strategy-constraints.md
@@ -2,9 +2,9 @@
 title: How to add strategy constraints
 ---
 
-:::info Availability
+:::note Availability
 
-Before Unleash 4.16, strategy constraints were only available to Unleash Pro and Enterprise users. From 4.16 onwards, they're **available to everyone**.
+**Version**: `4.16+`
 
 :::
 

diff --git a/website/docs/how-to/how-to-add-users-to-unleash.md b/website/docs/how-to/how-to-add-users-to-unleash.md
@@ -2,7 +2,12 @@
 title: How to add new users to your Unleash instance
 ---
 
-> This feature was introduced in Unleash v4 for Unleash Open-Source.
+:::note Availability
+
+**Version**: `4.0+`
+
+:::
+
 
 You can add new users to Unleash in `Admin > Users`.
 

diff --git a/website/docs/how-to/how-to-clone-environments.mdx b/website/docs/how-to/how-to-clone-environments.mdx
@@ -2,9 +2,9 @@
 title: How to clone environments
 ---
 
-:::info availability
+:::note Availability
 
-Environment cloning was made available in Unleash 4.19.
+**Plan**: [Enterprise](https://www.getunleash.io/plans/enterprise) | **Version**: `4.19+`
 
 :::
 

diff --git a/website/docs/how-to/how-to-create-and-assign-custom-project-roles.md b/website/docs/how-to/how-to-create-and-assign-custom-project-roles.md
@@ -4,9 +4,9 @@ title: How to create and assign custom project roles
 
 import VideoContent from '@site/src/components/VideoContent.jsx'
 
-:::info availability
+:::note Availability
 
-Custom project roles were introduced in **Unleash 4.6** and are only available in Unleash Enterprise.
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.6+`
 
 :::
 
@@ -32,9 +32,9 @@ It takes about three steps to create custom project roles:
 
 ## Assigning custom project roles
 
-:::info Multiple project roles
+:::note Availability
 
-Multiple project roles is an enterprise feature available from **Unleash 5.6** onwards. See [multiple project roles](../reference/rbac.md#multiple-project-roles) for more info.
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.6+`.
 
 :::
 

diff --git a/website/docs/how-to/how-to-create-and-assign-custom-root-roles.md b/website/docs/how-to/how-to-create-and-assign-custom-root-roles.md
@@ -2,9 +2,9 @@
 title: How to create and assign custom root roles
 ---
 
-:::info availability
+:::note Availability
 
-Custom root roles were introduced in **Unleash 5.4** and are only available in Unleash Enterprise.
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.4+`
 
 :::
 

diff --git a/website/docs/how-to/how-to-create-and-display-banners.md b/website/docs/how-to/how-to-create-and-display-banners.md
@@ -2,9 +2,9 @@
 title: How to create and display banners
 ---
 
-:::info Availability
+:::note Availability
 
-Banners were introduced in **Unleash 5.7** and are only available in Unleash Enterprise.
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.7+`
 
 :::
 

diff --git a/website/docs/how-to/how-to-create-and-manage-user-groups.md b/website/docs/how-to/how-to-create-and-manage-user-groups.md
@@ -2,9 +2,9 @@
 title: How to create and manage user groups
 ---
 
-:::info availability
+:::note Availability
 
-User groups are available to Unleash Enterprise users since **Unleash 4.14**.
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.14+`
 
 :::
 

diff --git a/website/docs/how-to/how-to-create-personal-access-tokens.mdx b/website/docs/how-to/how-to-create-personal-access-tokens.mdx
@@ -2,9 +2,9 @@
 title: How to create Personal Access Tokens
 ---
 
-:::info availability
+:::note Availability
 
-Personal access tokens are planned to be released in **Unleash 4.17**.
+**Version**: `4.17+`
 
 :::
 

diff --git a/website/docs/how-to/how-to-create-service-accounts.mdx b/website/docs/how-to/how-to-create-service-accounts.mdx
@@ -2,9 +2,9 @@
 title: How to create service accounts
 ---
 
-:::info availability
+:::note Availability
 
-Service accounts is an enterprise feature available from Unleash 4.21 onwards.
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.21+`
 
 :::
 

diff --git a/website/docs/how-to/how-to-define-custom-context-fields.md b/website/docs/how-to/how-to-define-custom-context-fields.md
@@ -2,10 +2,9 @@
 title: How to define custom context fields
 ---
 
-:::info Availability
+:::note Availability
 
-
-Before Unleash 4.16, custom context fields were only available to Unleash Pro and Enterprise users. From 4.16 onwards, they're **available to everyone**. They were introduced in Unleash 3.2.28.
+**Version**: `4.16+`
 
 :::
 

diff --git a/website/docs/how-to/how-to-download-login-history.mdx b/website/docs/how-to/how-to-download-login-history.mdx
@@ -2,9 +2,9 @@
 title: How to download your login history
 ---
 
-:::info availability
+:::note Availability
 
-Login history is an enterprise feature available from Unleash 4.22 onwards.
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.22+`
 
 :::
 

diff --git a/website/docs/how-to/how-to-enable-openapi.mdx b/website/docs/how-to/how-to-enable-openapi.mdx
@@ -6,10 +6,9 @@ import Tabs from '@theme/Tabs';
 
 import TabItem from '@theme/TabItem';
 
-:::info Availability
+:::note Availability
 
-OpenAPI schemas were introduced in v4.13.0 of Unleash and v0.10.0 of the Unleash proxy.
-Since v5.2.0 Unleash has OpenAPI enabled by default.
+**Unleash version**: `4.13+` | **Unleash Proxy version**: `0.10+`
 
 :::
 

diff --git a/website/docs/how-to/how-to-environment-import-export.mdx b/website/docs/how-to/how-to-environment-import-export.mdx
@@ -3,9 +3,9 @@ title: Environment Import & Export
 ---
 import VideoContent from '@site/src/components/VideoContent.jsx'
 
-:::info Availability
+:::note Availability
 
-The environment import and export first appeared in Unleash 4.22.0.
+**Version**: `4.22+`
 
 :::
 

diff --git a/website/docs/how-to/how-to-import-export.md b/website/docs/how-to/how-to-import-export.md
@@ -3,9 +3,9 @@ title: '[Deprecated] Import & Export'
 ---
 import ApiRequest from '@site/src/components/ApiRequest'
 
-:::info Availability
+:::note Availability
 
-The import and export API first appeared in Unleash 3.3.0.
+**Version**: `3.3+`
 
 :::
 

diff --git a/website/docs/how-to/how-to-set-up-group-sso-sync.md b/website/docs/how-to/how-to-set-up-group-sso-sync.md
@@ -4,7 +4,7 @@ title: How to Set Up User Group SSO Syncing
 
 :::note Availability
 
-**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: 4.18+
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.18+`
 
 :::
 

diff --git a/website/docs/how-to/how-to-setup-provisioning-with-entra.md b/website/docs/how-to/how-to-setup-provisioning-with-entra.md
@@ -2,9 +2,9 @@
 title: How to Setup Entra Provisioning
 ---
 
-:::info availability
+:::note Availability
 
-The **Provisioning capability** is only available for customers on the Enterprise subscription. Check out the [Unleash plans](https://www.getunleash.io/plans) for details.
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `6.1+`
 
 :::
 

diff --git a/website/docs/how-to/how-to-setup-provisioning-with-okta.md b/website/docs/how-to/how-to-setup-provisioning-with-okta.md
@@ -2,9 +2,9 @@
 title: How to Setup Okta Provisioning
 ---
 
-:::info availability
+:::note Availability
 
-The **Provisioning capability** is only available for customers on the Enterprise subscription. Check out the [Unleash plans](https://www.getunleash.io/plans) for details.
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `6.1+`
 
 :::
 

diff --git a/website/docs/how-to/how-to-setup-sso-keycloak-group-sync.md b/website/docs/how-to/how-to-setup-sso-keycloak-group-sync.md
@@ -2,10 +2,9 @@
 title: 'How to set up Keycloak and Unleash to sync user groups'
 ---
 
-
 :::note Availability
 
-**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: 4.18+
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.18+`
 
 :::
 

diff --git a/website/docs/reference/actions.md b/website/docs/reference/actions.md
@@ -2,11 +2,13 @@
 title: Actions
 ---
 
-:::info Availability
+:::note Availability
 
-Actions were introduced as a beta feature in **Unleash 5.11** and are only available in Unleash Enterprise.
+
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.11+` in BETA
 
 :::
+
 ## Overview
 
 Actions allow you to configure automated actions to be executed based on signals received from an external system.

diff --git a/website/docs/reference/api-tokens-and-client-keys.mdx b/website/docs/reference/api-tokens-and-client-keys.mdx
@@ -43,12 +43,13 @@ Personal access tokens follow their own special format, and only contain an opti
 
 ### API token visibility
 
-:::info project-level visibility
+:::note Availability
 
-Project-level visibility and access to API tokens was introduced in Unleash 4.22.
+**Version**: `4.22+`
 
 :::
 
+
 By default, only admin users can create API tokens, and only admins can see their values.
 
 However, any [client](#client-tokens client tokens) and [front-end tokens](#front-end-tokens) that are applicable to a project, will also be visible to any members of that project that have the `READ_PROJECT_API_TOKEN` permission (all project members by default).

diff --git a/website/docs/reference/api/legacy/unleash/admin/segments.mdx b/website/docs/reference/api/legacy/unleash/admin/segments.mdx
@@ -4,9 +4,9 @@ title: /api/admin/segments
 
 import ApiRequest from '@site/src/components/ApiRequest'; export const basePath = "api/admin/segments"; export const path = (p) => `${basePath}/${p}`;
 
-:::info Availability
+:::note Availability
 
-Segments are available to Unleash Pro and Unleash Enterprise users since **Unleash 4.13**.
+**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.13+`
 
 :::
 

diff --git a/website/docs/reference/api/legacy/unleash/client/features.md b/website/docs/reference/api/legacy/unleash/client/features.md
@@ -114,9 +114,9 @@ Used to fetch details about a specific feature flag. This is mainly provided to
 
 ### Strategy Constraints {#strategy-constraints}
 
-:::info Availability
+:::note Availability
 
-Before Unleash 4.16, strategy constraints were only available to Unleash Pro and Enterprise users. From 4.16 onwards, they're **available to everyone**.
+**Version**: `4.16+`
 
 :::
 

diff --git a/website/docs/reference/applications.mdx b/website/docs/reference/applications.mdx
@@ -4,23 +4,15 @@ title: Applications
 
 import Figure from '@site/src/components/Figure/Figure.tsx'
 
-An **application** is defined as anything that sends requests to the [Unleash client API](/reference/api/unleash/client), the [Unleash front-end API](front-end-api.md),  the Unleash admin API, or any other API that Unleash exposes. This includes [Unleash SDKs](./sdks/index.md), [Unleash Edge](/docs/generated/unleash-edge.md), the [Unleash proxy](/docs/generated/unleash-proxy.md), and even the admin UI.
+:::note Availability
 
-
-
-Applications can be accessed in the UI by going to the /applications page or manually by clicking Configure -> Applications. After clicking on your application, you will see an application overview.
-
-:::info Availability
-
-The following three sections: "Application Overview," "Connected Instances," and "Project Applications" were released in Unleash 5.11.
+**Version**: `5.11+`
 
 :::
 
+An **application** is any service that sends requests to the [Unleash Client API](/reference/api/unleash/client), the [Unleash Frontend API](front-end-api.md), the Unleash Admin API, or any other API that Unleash exposes. This includes [Unleash SDKs](./sdks/index.md), [Unleash Edge](/docs/generated/unleash-edge.md), the [Unleash proxy](/docs/generated/unleash-proxy.md), and even the Admin UI.
 
-Under the application, you have two tabs:
-
-- [Overview](#application-overview)
-- [Connected Instances](#connected-instances)
+In the Admin UI, you can access Applications in **Configure > Applications**.
 
 ## Application overview
 

diff --git a/website/docs/reference/banners.md b/website/docs/reference/banners.md
@@ -2,9 +2,9 @@
 title: Banners
 ---
 
-:::info Availability
+:::note Availability
 
-Banners were introduced in **Unleash 5.7** and are only available in Unleash Enterprise.
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.7+`
 
 :::
 

diff --git a/website/docs/reference/change-requests.md b/website/docs/reference/change-requests.md
@@ -4,10 +4,9 @@ title: Change Requests
 
 import VideoContent from '@site/src/components/VideoContent.jsx';
 
-:::info Availability
+:::note Availability
 
-The change requests feature is an enterprise-only feature that was introduced in **Unleash 4.19.0**.
-The change requests for segments was introduced in **Unleash 5.4.0**.
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.19+`
 
 :::
 
@@ -67,9 +66,9 @@ From here, if you have the correct permissions, you can approve and schedule or
 
 ### Scheduled changes
 
-:::info Availability
+:::note Availability
 
-Change request scheduling was released in Unleash 5.10.
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.10+`
 
 :::
 
@@ -144,6 +143,12 @@ Admin users will always see the change request UI so that they can test the chan
 
 ## Change Request for segments
 
+:::note Availability
+
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.4+`
+
+:::
+
 Changes to project [segments](segments.mdx) (as opposed to global segments) also go through the change request process. This is to prevent a backdoor in the change request process.
 
 Since projects segments are not environment specific and change requests are always environment specific we allow to attach segment change to any environment with change requests enabled.

diff --git a/website/docs/reference/command-menu.md b/website/docs/reference/command-menu.md
@@ -4,7 +4,7 @@ title: Command Menu
 
 :::note Availability
 
-**Version**: 6.2+.
+**Version**: `6.2+`
 
 :::
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,7 @@ title: How to Set Up User Group SSO Syncing @@
     :::note Availability
-    **Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: 4.18+
+    **Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.18+`
     :::
@@ Expand Down @@