Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align availability information in the docs #8177

Merged
merged 8 commits into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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)

:::

Expand Down
4 changes: 2 additions & 2 deletions website/docs/how-to/how-to-add-sso-azure-saml.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: How to add SSO with SAML 2.0 Azure

import Figure from '@site/src/components/Figure/Figure.tsx'

:::info Availability
:::note Availability

The **Single-Sign-On 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)

:::

Expand Down
4 changes: 2 additions & 2 deletions website/docs/how-to/how-to-add-strategy-constraints.md
Original file line number Diff line number Diff line change
Expand Up @@ -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+`

:::

Expand Down
7 changes: 6 additions & 1 deletion website/docs/how-to/how-to-add-users-to-unleash.md
Original file line number Diff line number Diff line change
Expand Up @@ -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+`
melindafekete marked this conversation as resolved.
Show resolved Hide resolved

:::


You can add new users to Unleash in `Admin > Users`.

Expand Down
4 changes: 2 additions & 2 deletions website/docs/how-to/how-to-clone-environments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: How to clone environments
---

:::info availability
:::note Availability

Environment cloning was made available in Unleash 4.19.
**Version**: `4.19+`

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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+`

:::

Expand All @@ -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+`.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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+`

:::

Expand Down
4 changes: 2 additions & 2 deletions website/docs/how-to/how-to-create-and-display-banners.md
Original file line number Diff line number Diff line change
Expand Up @@ -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+`

:::

Expand Down
4 changes: 2 additions & 2 deletions website/docs/how-to/how-to-create-and-manage-user-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -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+`

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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+`

:::

Expand Down
4 changes: 2 additions & 2 deletions website/docs/how-to/how-to-create-service-accounts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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+`

:::

Expand Down
5 changes: 2 additions & 3 deletions website/docs/how-to/how-to-define-custom-context-fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -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+`

:::

Expand Down
4 changes: 2 additions & 2 deletions website/docs/how-to/how-to-download-login-history.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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+`

:::

Expand Down
5 changes: 2 additions & 3 deletions website/docs/how-to/how-to-enable-openapi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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+` | **Proxy version**: `0.10+`
melindafekete marked this conversation as resolved.
Show resolved Hide resolved

:::

Expand Down
4 changes: 2 additions & 2 deletions website/docs/how-to/how-to-environment-import-export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
**Unleash version**: `4.22+`
melindafekete marked this conversation as resolved.
Show resolved Hide resolved

:::

Expand Down
4 changes: 2 additions & 2 deletions website/docs/how-to/how-to-import-export.md
Original file line number Diff line number Diff line change
Expand Up @@ -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+`

:::

Expand Down
4 changes: 2 additions & 2 deletions website/docs/how-to/how-to-set-up-group-sso-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: How to Set Up User Group SSO Syncing
---

:::info availability
:::note Availability

User group syncing was released in Unleash 4.18 and is available for enterprise customers.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.18+`

:::

Expand Down
4 changes: 2 additions & 2 deletions website/docs/how-to/how-to-setup-provisioning-with-entra.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
melindafekete marked this conversation as resolved.
Show resolved Hide resolved

:::

Expand Down
4 changes: 2 additions & 2 deletions website/docs/how-to/how-to-setup-provisioning-with-okta.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
melindafekete marked this conversation as resolved.
Show resolved Hide resolved

:::

Expand Down
4 changes: 2 additions & 2 deletions website/docs/how-to/how-to-setup-sso-keycloak-group-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: 'How to set up Keycloak and Unleash to sync user groups'
---

:::info availability
:::note Availability

User group syncing was released in Unleash 4.18 and is available to enterprise customers.
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.18+`

:::

Expand Down
6 changes: 4 additions & 2 deletions website/docs/reference/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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+`
melindafekete marked this conversation as resolved.
Show resolved Hide resolved

:::

## Overview

Actions allow you to configure automated actions to be executed based on signals received from an external system.
Expand Down
5 changes: 3 additions & 2 deletions website/docs/reference/api-tokens-and-client-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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+`
melindafekete marked this conversation as resolved.
Show resolved Hide resolved

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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+`

:::

Expand Down
27 changes: 18 additions & 9 deletions website/docs/reference/applications.mdx
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the notes in this file appear to use the same version number; shouldn't we then just use one availability note?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you know if there is any reason why the current docs specifically say:

The following three sections: "Application Overview," "Connected Instances," and "Project Applications" were released in Unleash 5.11.

I think that's what got me confused

Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,21 @@ 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.



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.

:::


Under the application, you have two tabs:

- [Overview](#application-overview)
- [Connected Instances](#connected-instances)

## Application overview

:::note Availability

**Version**: `5.11+`

:::

The application overview displays a list of projects that the application is accessing (accessing those projects' flags) and highlights any potential issues detected in your applications.

For detected issues, there are three different possible issues:
Expand All @@ -39,12 +36,24 @@ The application is also illustrated as a diagram, showing the application node,

## Connected instances

:::note Availability

**Version**: `5.11+`

:::

Connected instances display a list of instances that the application has in a selected environment. It shows the instance name, SDK version, last seen, and the IP address from which the instance connected.

<Figure caption="Connected instances currently show that in the development environment, there is one connected instance that was last seen 19 hours ago." img="/img/application-connected-instances.png"/>

## Project applications

:::note Availability

**Version**: `5.11+`

:::

In the project view, there is a tab named "Applications." In this view, it is possible to see all the applications that are consuming the project's features. The applications are displayed in a list, showing the application name, environments the application is consuming in the current project, instances, and SDKs.

<Figure caption="Currently, there is one application connected named auth-app, with 2 environments and 28 instances." img="/img/project-applications.png"/>
4 changes: 2 additions & 2 deletions website/docs/reference/banners.md
Original file line number Diff line number Diff line change
Expand Up @@ -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+`

:::

Expand Down
Loading
Loading