mirror of
https://github.com/Unleash/unleash.git
synced 2025-11-24 20:06:55 +01:00
Update contributing and support
This commit is contained in:
melindafekete
parent
d43c620a3a
commit
3b8e72bd3b
@ -12,7 +12,7 @@ title: Set up Entra provisioning
|
||||
|
||||
:::info
|
||||
|
||||
Before you begin, ensure that you have a strategy in place to prevent being [locked out of all admin accounts](/troubleshooting#got-locked-out-of-an-admin-account-after-configuring-scim).
|
||||
Before you begin, ensure that you have a strategy in place to prevent being [locked out of all admin accounts](/support/troubleshooting#got-locked-out-of-an-admin-account-after-configuring-scim).
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ pagination_next: provisioning/how-to-setup-provisioning-with-entra
|
||||
|
||||
:::info
|
||||
|
||||
Before you begin, ensure that you have a strategy in place to prevent [being locked out of all admin accounts](/troubleshooting#got-locked-out-of-an-admin-account-after-configuring-scim).
|
||||
Before you begin, ensure that you have a strategy in place to prevent [being locked out of all admin accounts](/support/troubleshooting#got-locked-out-of-an-admin-account-after-configuring-scim).
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ Service account tokens provide API access to integration and automation tools. T
|
||||
:::warning
|
||||
|
||||
Admin tokens are deprecated. Use other token types:
|
||||
- With [Open Source](https://www.getunleash.io/pricing) and [Pro](../availability#plans); use [personal access tokens](#personal-access-tokens).
|
||||
- With [Open Source](https://www.getunleash.io/pricing) and [Pro](../support/availability#plans); use [personal access tokens](#personal-access-tokens).
|
||||
- With [Enterprise](https://www.getunleash.io/pricing); use [service accounts](./service-accounts).
|
||||
|
||||
:::
|
||||
|
||||
@ -10,7 +10,7 @@ import ApiRequest from '@site/src/components/ApiRequest'; export const basePath
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.13+`
|
||||
**Plan**: [Pro](/support/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.13+`
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@ -28,7 +28,7 @@ Some things in Unleash are configured and defined on the root level. These optio
|
||||
|
||||
All Unleash instances must have at least one project at any given time. New instances get a project called “Default”.
|
||||
|
||||
[Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) customers can create, rename, and delete projects. [Open Source](https://www.getunleash.io/pricing) users have a single project called 'Default'.
|
||||
[Pro](/support/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) customers can create, rename, and delete projects. [Open Source](https://www.getunleash.io/pricing) users have a single project called 'Default'.
|
||||
|
||||
|
||||
|
||||
@ -42,7 +42,7 @@ Environments exist on two different levels within Unleash. The set of **all avai
|
||||
|
||||
Each project must always have **at least one** active environment.
|
||||
|
||||
[Enterprise](https://www.getunleash.io/pricing) users can create and remove environments. [Open Source](https://www.getunleash.io/pricing) and [Pro](/availability#plans) customers get access to two environments: **development** and **production.**
|
||||
[Enterprise](https://www.getunleash.io/pricing) users can create and remove environments. [Open Source](https://www.getunleash.io/pricing) and [Pro](/support/availability#plans) customers get access to two environments: **development** and **production.**
|
||||
|
||||
Environments are adjacent to [feature flags](../reference/feature-toggles) in Unleash: neither one contains the other, but they come together to let you define activation strategies.
|
||||
|
||||
@ -118,7 +118,7 @@ Segments let you apply a set of constraints to multiple strategies **and** keep
|
||||
|
||||
You can apply multiple segments to a strategy. Much like with constraints, **every segment** needs **every constraint** to be satisfied for the strategy to be evaluated. If you also have other constraints on the strategy, then those must also be satisfied.
|
||||
|
||||
Segments are only available to [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) users.
|
||||
Segments are only available to [Pro](/support/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) users.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -130,7 +130,7 @@ If an archived feature is revived, it starts a new lifecycle with a new [Define]
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing)
|
||||
**Plan**: [Pro](/support/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#feature-compatibility-in-backend-sdks) for variants.
|
||||
:::
|
||||
@ -156,7 +156,7 @@ Note that metrics are affected only by child feature flag evaluations.
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.12+`
|
||||
**Plan**: [Pro](/support/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.12+`
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `6.0+`
|
||||
**Plan**: [Pro](/support/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `6.0+`
|
||||
|
||||
:::
|
||||
|
||||
@ -29,7 +29,7 @@ The dashboard shows:
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `7.2+`
|
||||
**Plan**: [Pro](/support/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `7.2+`
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.0+`
|
||||
**Plan**: [Pro](/support/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.0+`
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.21+`
|
||||
**Plan**: [Pro](/support/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.21+`
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ By default, projects have an open [collaboration mode](./project-collaboration-m
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
|
||||
**Plan**: [Pro](/support/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
|
||||
|
||||
:::
|
||||
|
||||
@ -36,7 +36,7 @@ To create a new project:
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
|
||||
**Plan**: [Pro](/support/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
|
||||
|
||||
:::
|
||||
|
||||
@ -50,7 +50,7 @@ The available project settings depend on a user's [root and project roles](./rba
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing). | **Version**: `6.3+`
|
||||
**Plan**: [Pro](/support/availability#plans) and [Enterprise](https://www.getunleash.io/pricing). | **Version**: `6.3+`
|
||||
|
||||
:::
|
||||
|
||||
@ -73,7 +73,7 @@ To revive an archived project, go to **Projects > Archived projects** and click
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
|
||||
**Plan**: [Pro](/support/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ Unleash implements role-based access control on two levels:
|
||||
## Predefined roles
|
||||
|
||||
Unleash comes with a set of predefined roles. Root roles are available to all Unleash
|
||||
users, while the Project roles are only available to [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) users. The following 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
|
||||
users, while the Project roles are only available to [Pro](/support/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) users. The following 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).
|
||||
|
||||
| Role | Scope | Description | Availability |
|
||||
@ -31,8 +31,8 @@ own [custom root roles](#custom-root-roles) and [custom project roles](#custom-p
|
||||
| **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 they cannot 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](/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) |
|
||||
| **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](/support/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](/support/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) |
|
||||
|
||||
## Custom root roles
|
||||
|
||||
|
||||
@ -18,7 +18,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 | [Open Source](https://www.getunleash.io/pricing) limit | [Pro](/availability#plans) limit | [Enterprise](https://www.getunleash.io/pricing) limit | Environment variable |
|
||||
| Resource | [Open Source](https://www.getunleash.io/pricing) limit | [Pro](/support/availability#plans) limit | [Enterprise](https://www.getunleash.io/pricing) limit | Environment variable |
|
||||
|--------------------------------------------------------------------------------------|--------------------------------------------------------|----------------------------------|-------------------------------------------------------|------------------------------------------------|
|
||||
| Active [feature flags](./feature-toggles) | 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` |
|
||||
@ -55,4 +55,4 @@ 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 projects and environments for [Open Source](https://www.getunleash.io/pricing) and [Pro](/availability#plans) instances.
|
||||
The only limits that can't be changed, are projects and environments for [Open Source](https://www.getunleash.io/pricing) and [Pro](/support/availability#plans) instances.
|
||||
@ -25,4 +25,4 @@ See our how-to guides on setting up provisioning for [Okta](/provisioning/how-to
|
||||
|
||||
## Retain admin access
|
||||
|
||||
When setting up a SCIM integration with Unleash, you must configure a method for role management to avoid being locked out of admin accounts. To do this, either assign the admin role to an IdP group that is synced with Unleash or create a dedicated, non-SCIM managed recovery admin account for emergency use. For full instructions, including what to do if you're already locked out, see our complete [troubleshooting guide](/troubleshooting#got-locked-out-of-an-admin-account-after-configuring-scim).
|
||||
When setting up a SCIM integration with Unleash, you must configure a method for role management to avoid being locked out of admin accounts. To do this, either assign the admin role to an IdP group that is synced with Unleash or create a dedicated, non-SCIM managed recovery admin account for emergency use. For full instructions, including what to do if you're already locked out, see our complete [troubleshooting guide](/support/troubleshooting#got-locked-out-of-an-admin-account-after-configuring-scim).
|
||||
|
||||
@ -161,8 +161,8 @@ If you need a language or framework not covered officially, explore our communit
|
||||
|
||||
If you can't find an SDK that fits your requirements, you can also develop your own SDK. To make implementation easier, check out these resources:
|
||||
|
||||
- [Unleash Client Specifications](https://github.com/Unleash/client-specification) - Used by all official SDKs to make sure they behave correctly across different language implementations. This lets us verify that a gradual rollout to 10% of the users would affect the same users regardless of which SDK you're using.
|
||||
- [Backend SDK overview](/client-specification) - A brief guide of the _Unleash Architecture_ and important aspects of the SDK role in it all.
|
||||
- [Unleash Client Specifications](https://github.com/Unleash/contributing/client-specification) - Used by all official SDKs to make sure they behave correctly across different language implementations. This lets us verify that a gradual rollout to 10% of the users would affect the same users regardless of which SDK you're using.
|
||||
- [Backend SDK overview](/contributing/client-specification) - A brief guide of the _Unleash Architecture_ and important aspects of the SDK role in it all.
|
||||
|
||||
## Offline behavior
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Version**: `4.13+` for [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
|
||||
**Version**: `4.13+` for [Pro](/support/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
|
||||
**Version**: `5.5+` for [Open Source](https://www.getunleash.io/pricing).
|
||||
|
||||
:::
|
||||
@ -87,8 +87,8 @@ Keeping segments a manageable size ensures that evaluations stay lightweight and
|
||||
|
||||
The combined number of values across all constraints in a single segment is limited by your plan:
|
||||
|
||||
- [Pro](/availability#plans) and [OSS](/availability#plans): up to 250 total values per instance.
|
||||
- [Enterprise](/availability#plans): up to 1,000 total values per instance.
|
||||
- [Pro](/support/availability#plans) and [OSS](/support/availability#plans): up to 250 total values per instance.
|
||||
- [Enterprise](/support/availability#plans): up to 1,000 total values per instance.
|
||||
|
||||
You can attach up to five segments to a single activation strategy. This limit applies per strategy, not per feature flag.
|
||||
If a flag includes two strategies, each one can have up to five segments.
|
||||
|
||||
@ -26,7 +26,7 @@ For more examples of specific resources and data sources, visit the [Terraform r
|
||||
## Manage Terraform access
|
||||
|
||||
The permissions of the API token you use with Terraform and your Unleash [plan](https://www.getunleash.io/pricing) determine which objects Terraform can manage:
|
||||
- For [Open Source](https://www.getunleash.io/pricing) and [Pro](../availability#plans), use [personal access tokens](/reference/api-tokens-and-client-keys#personal-access-tokens).
|
||||
- For [Open Source](https://www.getunleash.io/pricing) and [Pro](../support/availability#plans), use [personal access tokens](/reference/api-tokens-and-client-keys#personal-access-tokens).
|
||||
- For [Enterprise](https://www.getunleash.io/pricing), use [service accounts](/reference/service-accounts). For larger teams, we recommend multiple service accounts with different permissions and separate Terraform repositories for each team under their respective projects.
|
||||
|
||||
## Resources
|
||||
|
||||
@ -132,7 +132,7 @@ You can use the `curl` command-line tool to inspect the response headers from yo
|
||||
|
||||
If a documented Unleash feature isn't showing up in your Admin UI, check the following:
|
||||
|
||||
- Is the feature included in your [Unleash plan and version](/availability)?
|
||||
- Is the feature included in your [Unleash plan and version](/support/availability)?
|
||||
- Is the feature in beta? If so, reach out to us to get early access.
|
||||
|
||||
## Got locked out of an Admin account after configuring SCIM
|
||||
@ -18,7 +18,7 @@ import Banner from '@site/src/components/unleash-academy/Banner.jsx'
|
||||
|
||||
Whether you are new to feature flags or a seasoned feature management user and whatever your organizational role, our materials will help onboard you to the full suite of capabilities the Unleash platform has to offer, refresh your existing knowledge, broaden your knowledge to new use cases, and much more!
|
||||
|
||||
Any Unleash user is welcomed - from [Open Source](https://www.getunleash.io/pricing), [Pro](/availability#plans) to [Enterprise](https://www.getunleash.io/pricing).
|
||||
Any Unleash user is welcomed - from [Open Source](https://www.getunleash.io/pricing), [Pro](/support/availability#plans) to [Enterprise](https://www.getunleash.io/pricing).
|
||||
|
||||
Content is carefully curated to ensure the best, most relevant targeted learning experience. Review the next section on how to use the content to get started today!
|
||||
|
||||
|
||||
@ -747,17 +747,17 @@ const sidebars: SidebarsConfig = {
|
||||
items: [
|
||||
{
|
||||
type: 'doc',
|
||||
id: 'troubleshooting',
|
||||
id: 'support/troubleshooting',
|
||||
label: 'Troubleshooting',
|
||||
},
|
||||
{
|
||||
type: 'doc',
|
||||
id: 'availability',
|
||||
id: 'support/availability',
|
||||
label: 'Feature availability and versioning',
|
||||
},
|
||||
{
|
||||
type: 'doc',
|
||||
id: 'oss-comparison',
|
||||
id: 'support/oss-comparison',
|
||||
label: 'Compare Unleash OSS and Unleash Enterprise',
|
||||
},
|
||||
{
|
||||
@ -770,6 +770,7 @@ const sidebars: SidebarsConfig = {
|
||||
},
|
||||
items: [
|
||||
'contributing/developer-guide',
|
||||
'contributing/client-specification',
|
||||
'contributing/frontend/overview',
|
||||
'contributing/backend/overview',
|
||||
{
|
||||
|
||||
@ -741,6 +741,11 @@
|
||||
"destination": "/contributing/developer-guide",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/client-specification",
|
||||
"destination": "/contributing/client-specification",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/how-to-capture-impression-data",
|
||||
"destination": "/feature-flag-tutorials/use-cases/how-to-capture-impression-data",
|
||||
@ -918,22 +923,22 @@
|
||||
},
|
||||
{
|
||||
"source": "/using-unleash/troubleshooting/cors",
|
||||
"destination": "troubleshooting",
|
||||
"destination": "/support/troubleshooting",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/using-unleash/troubleshooting/flag-abn-unexpected-results",
|
||||
"destination": "troubleshooting",
|
||||
"destination": "/support/troubleshooting",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/using-unleash/troubleshooting/flag-exposure",
|
||||
"destination": "troubleshooting",
|
||||
"destination": "/support/troubleshooting",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/using-unleash/troubleshooting/flag-not-returned",
|
||||
"destination": "troubleshooting",
|
||||
"destination": "/support/troubleshooting",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
@ -943,7 +948,7 @@
|
||||
},
|
||||
{
|
||||
"source": "/using-unleash/troubleshooting/feature-not-available",
|
||||
"destination": "/availability",
|
||||
"destination": "/support/availability",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
@ -1043,7 +1048,7 @@
|
||||
},
|
||||
{
|
||||
"source": "/using-unleash/troubleshooting",
|
||||
"destination": "/using-unleash/troubleshooting/cors",
|
||||
"destination": "/support/troubleshooting",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
@ -1051,6 +1056,21 @@
|
||||
"destination": "/contributing/developer-guide",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/availability",
|
||||
"destination": "/support/availability",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/troubleshooting",
|
||||
"destination": "/support/troubleshooting",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/oss-comparison",
|
||||
"destination": "/support/oss-comparison",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/sso",
|
||||
"destination": "/single-sign-on/how-to-add-sso-open-id-connect",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user