Introduce availability page in the docs (#8644)

Unleash · Nov 6, 2024 · f016a3e · f016a3e
1 parent 3d10887
commit f016a3e
Show file tree

Hide file tree

Showing 17 changed files with 66 additions and 55 deletions.
diff --git a/website/docs/availability.md b/website/docs/availability.md
@@ -0,0 +1,25 @@
+---
+title: Unleash Availability
+---
+
+Your Unleash [plan](#plans) and [version](#versioning) determine what features you have access to. Our documentation displays the availability for each feature using the following annotation:
+
+:::note Availability
+
+**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.7+`
+
+:::
+
+This is an example of a feature that is only available to Enterprise customers who are on version `5.7` or later.
+
+## Plans
+
+- [Open Source](https://www.getunleash.io/pricing) - Available on [GitHub](https://github.com/Unleash/unleash) under an Apache 2.0 license.
+- Pro - Currently not offered.
+- [Enterprise](https://www.getunleash.io/pricing) - Available as Pay-as-you-go or as an annual contract.
+
+## Versioning
+
+Unleash uses [semantic versioning](https://semver.org/) with release notes available on [GitHub](https://github.com/Unleash/unleash/releases). For detailed instructions on upgrading your version, see [Upgrading Unleash](../using-unleash/deploy/upgrading-unleash).
+
+[Unleash Edge](https://github.com/Unleash/unleash-edge) and our [SDKs](/reference/sdks) are versioned and released independently of Unleash. We recommend upgrading your SDKs and Unleash Edge to the latest versions to ensure compatibility, optimal performance, and access to the latest features and security updates.
diff --git a/website/docs/how-to/how-to-schedule-feature-releases.mdx b/website/docs/how-to/how-to-schedule-feature-releases.mdx
@@ -12,9 +12,8 @@ There's a whole host of reasons why you may want to schedule the release of a fe
 - **to make a feature available only up until a specific moment** (for a contest cutoff, for instance)
 - **to make a feature available during a limited period** (for a 24 hour flash sale, for instance)
 
-There are two distinct ways to do this, depending on which version of Unleash you are running:
-- If you're using version 4.9 or later of Unleash Pro or Enterprise, you can (and should) [use strategy constraints](#strategy-constraints)
-- Otherwise, [use custom activation strategies](#custom-activation-strategies)
+Depending on which version of Unleash you are using, there are two ways to schedule a feature release. If you are using [Pro](/availability#plans) or [Enterprise](https://www.getunleash.io/pricing) version 4.9 or later, you can use [strategy constraints](#schedule-feature-releases-with-strategy-constraints).
+Otherwise, you can use [custom activation strategies](#schedule-feature-releases-with-custom-activation-strategies).
 
 In this guide we'll schedule a feature for release at some point in time. The exact same logic applies if you want to make a feature available until some point in the future. Finally, if you want to only make a feature available during a limited time period, you can easily combine the two options.
 
@@ -81,4 +80,4 @@ To schedule feature releases without using strategy constraints, you can use cus
 
 ### Step 2: Implement the custom activation strategy in your clients
 
-In each of the client SDKs that will interact with your feature, implement the strategy ([the implementation how-to guide](../how-to/how-to-use-custom-strategies#step-3) has steps for all SDK types).
+In each of the client SDKs that will interact with your feature, implement the strategy ([the implementation how-to guide](../how-to/how-to-use-custom-strategies#step-3) has steps for all SDK types).
diff --git a/website/docs/quickstart.mdx b/website/docs/quickstart.mdx
@@ -132,11 +132,11 @@ For other ways to get started locally, see the steps for [starting an Unleash se
 
 #### Hosted by Unleash 
 
-With our [Pro and Enterprise plans](https://www.getunleash.io/pricing), you can run Unleash in the cloud by using our hosted offerings.
+With our [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) plans, you can run Unleash in the cloud by using our hosted offerings.
 
 #### Self-hosted
 
-Self-hosting Unleash is available for [Open-Source](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) customers. Visit [Self-hosting Unleash](/using-unleash/deploy) to learn more.
+Self-hosting Unleash is available for [Open Source](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) customers. Visit [Self-hosting Unleash](/using-unleash/deploy) to learn more.
 
 ## Next steps
 

diff --git a/website/docs/reference/api-tokens-and-client-keys.mdx b/website/docs/reference/api-tokens-and-client-keys.mdx
@@ -55,27 +55,18 @@ By default, only admin users can create API tokens, and only admins can see thei
 However, any [client](#client-tokens client tokens) and [front-end tokens](#front-end-tokens) that are applicable to a project, will also be visible to any members of that project that have the `READ_PROJECT_API_TOKEN` permission (all project members by default).
 
 Similarly, any project members with the `CREATE_PROJECT_API_TOKEN` permission can also create client and front-end tokens for that specific project ([how to create project API tokens](../how-to/how-to-create-project-api-tokens)).
-### Admin tokens
-
-**Admin tokens** grant _full read and write access_ to all resources in the Unleash server API. Admin tokens have access to all projects, all environments, and all root resources (find out more about [resources in the RBAC document](../reference/rbac#core-principles)).
-
-Use admin tokens to:
-
--   Automate Unleash behavior such as creating feature flags, projects, etc.
--   Write custom Unleash UIs to replace the default Unleash admin UI.
-Do **not** use admin tokens for:
 
--   [Client SDKs](../reference/sdks): You will _not_ be able to read flag data from multiple environments. Use [client tokens](#client-tokens) instead.
-
-Support for scoped admin tokens with more fine-grained permissions is currently in the planning stage.
+### Admin tokens
 
-**Deprecation Notice**
-We do not recommend using admin tokens anymore, they are not connected to any user, and as such is a lot harder to track.
-* For OSS and Pro users, we recommend using [Personal Access Tokens](#personal-access-tokens) instead.
-* Enterprise users have the option to use [Service accounts](./service-accounts).
+:::warning
 
+Admin tokens are deprecated. Use other tokens types:
+- With [Open Source](https://www.getunleash.io/pricing) and [Pro](../availability#plans), use [personal access tokens](#personal-access-tokens).
+- With [Enterprise](https://www.getunleash.io/pricing), use [service accounts](./service-accounts).
 
+:::
 
+**Admin tokens** grant _full read and write access_ to all resources in the Unleash server API. Admin tokens have access to all projects, all environments, and all root resources (find out more about [resources in the RBAC document](../reference/rbac#core-principles)).
 
 
 ### Personal access tokens

diff --git a/website/docs/reference/api/legacy/unleash/admin/segments.mdx b/website/docs/reference/api/legacy/unleash/admin/segments.mdx
@@ -6,7 +6,7 @@ import ApiRequest from '@site/src/components/ApiRequest'; export const basePath
 
 :::note Availability
 
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.13+`
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.13+`
 
 :::
 

diff --git a/website/docs/reference/feature-toggles.mdx b/website/docs/reference/feature-toggles.mdx
@@ -125,7 +125,7 @@ If an archived feature is revived, it starts a new lifecycle with a new [initial
 
 :::note Availability
 
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing)
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing)
 
 **Unleash version**: `5.7+` | **Unleash Edge version**: `13.1+` | **Unleash Proxy version**: `0.18+`. Requires [SDK compatibility](../reference/sdks#server-side-sdk-compatibility-table) for variants.
 :::
@@ -151,7 +151,7 @@ Note that metrics are affected only by child feature flag evaluations.
 
 :::note Availability
 
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.12+`
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.12+`
 
 :::
 

diff --git a/website/docs/reference/insights.mdx b/website/docs/reference/insights.mdx
@@ -6,7 +6,7 @@ import Figure from '@site/src/components/Figure/Figure.tsx'
 
 :::note Availability
 
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `6.0+`
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `6.0+`
 
 :::
 

diff --git a/website/docs/reference/integrations/jira-cloud-plugin-installation.mdx b/website/docs/reference/integrations/jira-cloud-plugin-installation.mdx
@@ -5,7 +5,7 @@ import Figure from '@site/src/components/Figure/Figure.tsx'
 
 :::note Availability
 
-**Version**: `4.0+`
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.0+`
 
 :::
 
@@ -24,8 +24,6 @@ For Jira Data Center, check out the [Jira Server plugin](jira-server-plugin-inst
 
 You will need an Unleash admin user to configure the access tokens needed to connect the plugin to Unleash.
 
-This plugin requires an Unleash Pro or an Unleash Enterprise instance.
-
 We recommend using a [service account](../service-accounts.md) token for communicating with Unleash. Service accounts are also required to integrate with [change requests](../change-requests)
 
 ### Jira

diff --git a/website/docs/reference/network-view.mdx b/website/docs/reference/network-view.mdx
@@ -6,7 +6,7 @@ import Figure from '@site/src/components/Figure/Figure.tsx'
 
 :::note Availability
 
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.21+`
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.21+`
 
 :::
 

diff --git a/website/docs/reference/notifications.md b/website/docs/reference/notifications.md
@@ -4,7 +4,7 @@ title: Notifications
 
 :::note Availability
 
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.22+`
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.22+`
 
 :::
 

diff --git a/website/docs/reference/projects.mdx b/website/docs/reference/projects.mdx
@@ -17,7 +17,7 @@ By default, projects have an open [collaboration mode](./project-collaboration-m
 
 :::note Availability
 
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
 
 :::
 
@@ -31,7 +31,7 @@ To create a new project:
 
 :::note Availability
 
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
 
 :::
 
@@ -45,7 +45,7 @@ The available project settings depend on a user's [root and project roles](./rba
 
 :::note Availability
 
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing). | **Version**: `6.3+`
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing). | **Version**: `6.3+`
 
 :::
 
@@ -67,7 +67,7 @@ To revive an archived project, go to **Projects > Archived projects** and click
 
 :::note Availability
 
-**Plan**: [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
+**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
 
 :::
 

diff --git a/website/docs/reference/rbac.md b/website/docs/reference/rbac.md
@@ -29,8 +29,8 @@ Unleash has two levels in its hierarchy of resources:
 ## Predefined roles
 
 Unleash comes with a set of built-in predefined roles that you can use. The _root roles_ are available to all Unleash
-users, while the _project-based roles_ are only available to Pro and Enterprise users. The below table lists the roles,
-what they do, and what plans they are available in. Additionally, Enterprise users can create their
+users, while the _project-based roles_ are only available to [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) users. The below table lists the roles,
+what they do, and what plans they are available in. Additionally, [Enterprise](https://www.getunleash.io/pricing) users can create their
 own [custom root roles](#custom-root-roles) and [custom project roles](#custom-project-roles).
 
 When you add a new user, you can assign them one of the root roles listed below.
@@ -40,8 +40,8 @@ When you add a new user, you can assign them one of the root roles listed below.
 | **Admin**  | Root    | Users with the root admin role have superuser access to Unleash and can perform any operation within the Unleash platform.                                                                                                                                                                                                                                          | All versions       |
 | **Editor** | Root    | Users with the root editor role have access to most features in Unleash, but can not manage users and roles in the root scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default. | All versions       |
 | **Viewer** | Root    | Users with the root viewer role can only read root resources in Unleash. Viewers can be added to specific projects as project members. Users with the viewer role may not view API tokens.                                                                                                                                                                          | All versions       |
-| **Owner**  | Project | Users with the project owner role have full control over the project, and can add and manage other users within the project context, manage feature flags within the project, and control advanced project features like archiving and deleting the project.                                                                                                      | Pro and Enterprise |
-| **Member** | Project | Users with the project member role are allowed to view, create, and update feature flags within a project, but have limited permissions in regards to managing the project's user access and can not archive or delete the project.                                                                                                                               | Pro and Enterprise |
+| **Owner**  | Project | Users with the project owner role have full control over the project, and can add and manage other users within the project context, manage feature flags within the project, and control advanced project features like archiving and deleting the project.                                                                                                      | [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) |
+| **Member** | Project | Users with the project member role are allowed to view, create, and update feature flags within a project, but have limited permissions in regards to managing the project's user access and can not archive or delete the project.                                                                                                                               | [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) |
 
 ## Custom Root Roles
 

diff --git a/website/docs/reference/resource-limits.mdx b/website/docs/reference/resource-limits.mdx
@@ -15,7 +15,7 @@ To ensure that Unleash operates smoothly, it includes resource limits for some o
 
 The resources and their respective limits and environment variables are:
 
-| Resource                                                       | OSS limit | Pro limit | Enterprise limit | Environment variable                           |
+| Resource                                                       | [Open Source](https://www.getunleash.io/pricing) limit | [Pro](/availability#plans) limit | [Enterprise](https://www.getunleash.io/pricing) limit | Environment variable                           |
 |----------------------------------------------------------------|----------:|----------:|-----------------:|------------------------------------------------|
 | [Feature flags](./feature-toggles)[^1]                         |     5,000 |     5,000 |           50,000 | `UNLEASH_FEATURE_FLAGS_LIMIT`                  |
 | [Strategies](./activation-strategies) per flag per environment |        30 |        30 |               30 | `UNLEASH_FEATURE_ENVIRONMENT_STRATEGIES_LIMIT` |
@@ -51,8 +51,6 @@ If you try to set their limits lower than that, Unleash will automatically adjus
 
 If you operate a self-hosted Unleash instance, you can adjust the limit yourself. For hosted users of Unleash, you'll need to reach out and talk to your Unleash contact.
 
-The only limits that can't be changed, are
-- the limits for projects and environments for OSS instances
-- the limits for projects and environments for Pro instances
+The only limits that can't be changed, are projects and environments for [Open Source](https://www.getunleash.io/pricing) and [Pro](/availability#plans) instances.
 
 [^1]: Archived feature flags do not count towards your feature flag total. The limit only applies to active (i.e. not archived) feature flags.
diff --git a/website/docs/reference/segments.mdx b/website/docs/reference/segments.mdx
@@ -7,7 +7,7 @@ import VideoContent from '@site/src/components/VideoContent.jsx'
 
 :::note Availability
 
-**Version**: `4.13+` for [Pro](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
+**Version**: `4.13+` for [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
 **Version**: `5.5+` for [Open Source](https://www.getunleash.io/pricing).
 
 :::
@@ -42,11 +42,11 @@ If an activation strategy has a segment _and_ additional constraints applied, th
 
 In theory, you could create segments with a thousand constraints, each with a million values. But this wouldn't scale well, so there are limitations in place to stop you from doing this. Unleash enforces the following limits on use of segments:
 
-- If you're on a Pro plan
+- If you're on a [Pro](/availability#plans) plan:
 
     A segment can have **at most 250 values** specified across all of its constraints. That means that if you add a constraint that uses 10 values, you will have 240 more values to use for any other constraints you add to the same segment.
 
-- If you're on an Enterprise plan
+- If you're on an [Enterprise](https://www.getunleash.io/pricing) plan:
 
     A segment can have **at most 1000 values** specified across all of its constraints. That means that if you add a constraint that uses 70 values, you will have 930 more values to use for any other constraints you add to the same segment.