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

Docs fixes #7845

Merged
merged 8 commits into from
Oct 1, 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
2 changes: 1 addition & 1 deletion website/docs/how-to/how-to-add-strategy-constraints.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Before Unleash 4.16, strategy constraints were only available to Unleash Pro and

:::

This guide shows you how to add [strategy constraints](../reference/strategy-constraints.md) to your feature flags via the admin UI. For information on how to interact with strategy constraints from an [Unleash client SDK](../reference/sdks/index.md), visit the specific SDKs documentation or see [the relevant section in the strategy constraints documentation](../reference/strategy-constraints.md#sdks 'strategy constraints documentation, section on interacting with constraints from client SDKs').
This guide shows you how to add [strategy constraints](../reference/strategy-constraints.md) to your feature flags using the Admin UI. For information on how to interact with strategy constraints from an [Unleash client SDK](../reference/sdks/index.md), visit the specific SDK's documentation or see [the relevant section in the strategy constraints documentation](../reference/strategy-constraints.md#sdks 'strategy constraints documentation, section on interacting with constraints from client SDKs').

## Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion website/docs/how-to/how-to-create-api-tokens.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ All users can see tokens with `CLIENT` level access, but only instance admins ca

:::

Unleash SDKs use API tokens to authenticate to the Unleash API. Unleash supports different types of API tokens, each with different levels of access and privileges. Refer to the [API tokens and client keys](../reference/api-tokens-and-client-keys.mdx) article for complete overview of the different token types.
Unleash SDKs use API tokens to authenticate to the Unleash API. Unleash supports different types of API tokens, each with different levels of access and privileges. Refer to the [API tokens and client keys](../reference/api-tokens-and-client-keys.mdx) documentation for a complete overview of the different token types.
melindafekete marked this conversation as resolved.
Show resolved Hide resolved

## Step 1: Navigate to the API token creation form {#step-1}

Expand Down
2 changes: 1 addition & 1 deletion website/docs/how-to/how-to-create-project-api-tokens.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Creating Project API tokens requires you to have the `CREATE_PROJECT_API_TOKEN`

:::

Unleash SDKs use API tokens to authenticate to the Unleash API. Unleash supports different types of API tokens, each with different levels of access and privileges. Refer to the [API tokens and client keys](../reference/api-tokens-and-client-keys.mdx) article for complete overview of the different token types.
Unleash SDKs use API tokens to authenticate to the Unleash API. Unleash supports different types of API tokens, each with different levels of access and privileges. Refer to the [API tokens and client keys](../reference/api-tokens-and-client-keys.mdx) documentation for a complete overview of the different token types.
melindafekete marked this conversation as resolved.
Show resolved Hide resolved

## Step 1: Navigate to the API token creation form {#step-1}

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 @@ -8,7 +8,7 @@ Service accounts is an enterprise feature available from Unleash 4.21 onwards.

:::

[Service accounts](../reference/service-accounts.md) enable Unleash admins to create accounts that act as users and respect the same set of permissions, however they do not have a password and cannot log in to the Unleash UI. Instead, they are intended to be used to access the Unleash API programatically.
[Service accounts](../reference/service-accounts.md) enable Unleash admins to create accounts that act as users and adhere to the same set of permissions. However, these accounts do not have a password and cannot log in to the Unleash Admin UI. Instead, they are intended to be used to access the Unleash API programmatically.

## Step 1: Navigate to the service accounts page {#step-1}

Expand All @@ -30,7 +30,7 @@ Select a [root role](https://docs.getunleash.io/reference/rbac#predefined-roles)

![The service account form filled with some example data, and the "add service account" button highlighted at the bottom.](/img/service-account-3.png)

You can optionally generate a token for the new service account right away. Give your token a description and optionally set an expiry date. By default the expiry date is set to 30 days. The token will be generated when you submit the form.
You can optionally generate a token for the new service account right away. Give your token a description and optionally set an expiry date. By default, the expiry date is set to 30 days. The token will be generated when you submit the form.

![The service account form with the token section highlighted and the "generate a token now" option selected](/img/service-account-4.png)

Expand Down
6 changes: 3 additions & 3 deletions website/docs/how-to/how-to-enable-openapi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Since v5.2.0 Unleash has OpenAPI enabled by default.

:::

Both Unleash and the Unleash proxy have included OpenAPI schemas and Swagger UIs for their APIs. The schemas can be used to get an overview over all API operations and to generate API clients using OpenAPI client generators. The Swagger UI lets you see and try out all the available API operations directly in your browser.
Both Unleash and the Unleash proxy have included OpenAPI schemas and Swagger UIs for their APIs. The schemas can be used to get an overview of all API operations and to generate API clients using OpenAPI client generators. The Swagger UI lets you see and try out all the available API operations directly in your browser.

To enable the OpenAPI documentation and the Swagger UI, you must start Unleash or the proxy with the correct configuration option. The following section shows you how. The methods are the same for both Unleash and the Unleash proxy, so the steps described in the next section will work for either.

Expand Down Expand Up @@ -79,7 +79,7 @@ docker run \

The configuration option for enabling OpenAPI and the swagger UI is `enableOAS`. Set this option to `true`.

The following examples have been shortened to show the only the relevant configuration options. For more detailed instructions on how to run Unleash or the proxy, refer to [how to run the Unleash proxy](how-to-run-the-unleash-proxy.mdx) or the [section on running Unleash via Node.js from the deployment section](/using-unleash/deploy/getting-started.md#option-three---from-nodejs) of the documentation.
The following examples have been shortened to show only the relevant configuration options. For more detailed instructions on how to run Unleash or the proxy, refer to [how to run the Unleash proxy](how-to-run-the-unleash-proxy.mdx) or the [section on running Unleash via Node.js from the deployment section](/using-unleash/deploy/getting-started.md#option-three---from-nodejs) of the documentation.
melindafekete marked this conversation as resolved.
Show resolved Hide resolved

<Tabs groupId="openapi-configuration">

Expand All @@ -90,7 +90,7 @@ const unleash = require('unleash-server');

unleash
.start({
// ... Other options elided for brevity
// ... Other options emitted for brevity
// highlight-next-line
enableOAS: true,
})
Expand Down
2 changes: 1 addition & 1 deletion website/docs/how-to/how-to-use-the-admin-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: How to use the Admin API
---

It is possible to integrate directly with the Admin API. In this guide we will explain all the steps to set it up.
You can integrate with Unleash directly using the Admin API. This guide explains the steps required to getting access to and using the Admin API.
melindafekete marked this conversation as resolved.
Show resolved Hide resolved

## Step 1: Create API token {#step-1-create-api-token}

Expand Down
4 changes: 2 additions & 2 deletions website/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ There are lots of options to get started with Unleash. If you're comfortable wit

## 1. Set up Unleash with Docker {#setup-unleash-docker}

The easiest way to run unleash locally is using git and [docker](https://www.docker.com/).
The easiest way to run Unleash locally is using Git and [Docker](https://www.docker.com/).

```sh
git clone [email protected]:Unleash/unleash.git
Expand Down Expand Up @@ -87,7 +87,7 @@ unleash.on("synchronized", () => {

### Unleash Demo Instance {#unleash-demo-instance}

For testing purposes we have set up a demo instance that you can use in order to test out different use-cases before setting up your own instance. You can find the demo instance here: https://app.unleash-hosted.com/demo/
For testing purposes, we have set up a demo instance that you can use to test out different use cases before setting up your own instance. You can find the demo instance here: https://app.unleash-hosted.com/demo/

NOTE: This is a demo instance set up with the Pro version. [More information on our different versions](https://www.getunleash.io/pricing).

Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/api-tokens-and-client-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Do **not** use client tokens in:

**Front-end tokens** are used with [front-end SDKs](../reference/sdks/index.md#front-end-sdks) when used with the [Unleash front-end API](./front-end-api.md). They grant the user permission to:

- Read the enabled flagd for a given context
- Read the enabled flags for a given context
- Register applications with the Unleash server
- Send usage metrics

Expand Down
11 changes: 6 additions & 5 deletions website/docs/reference/sdks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import VideoContent from '@site/src/components/VideoContent.jsx'

In order to connect your application to Unleash you will need a client SDK (software developer kit) for your programming language and an [API token](../how-to/how-to-create-api-tokens). The SDK will handle connecting to the Unleash server instance and retrieving feature flags based on your configuration. All versions of Unleash (OSS, Pro, and Enterprise) use the same client SDKs.

Unleash provides official client SDKs for a number of programming language. Additionally, our community have developed and contributed SDKs for other languages. So if you can't find your favorite language in the list of official SDKs, check out the [list of clients written by our fantastic community](#community-sdks).
Unleash provides official client SDKs for a number of programming languages. Additionally, our community has developed and contributed SDKs for other languages. So if you can't find your favorite language in the list of official SDKs, check out the [list of clients written by our fantastic community](#community-sdks).

## Official SDKs

Expand All @@ -33,6 +33,7 @@ Client-side SDKs can connect to [Unleash Edge](/reference/unleash-edge) or to th
- [Flutter Proxy SDK](/docs/generated/sdks/client-side/flutter.md)
- [iOS Proxy SDK](/docs/generated/sdks/client-side/ios-proxy.md)
- [Javascript SDK](/docs/generated/sdks/client-side/javascript-browser.md)
- [Next.js](/docs/generated/sdks/client-side/next-js.md)
- [React Proxy SDK](/docs/generated/sdks/client-side/react.md)
- [Svelte Proxy SDK](/docs/generated/sdks/client-side/svelte.md)
- [Vue Proxy SDK](/docs/generated/sdks/client-side/vue.md)
Expand Down Expand Up @@ -83,7 +84,7 @@ If you see an item marked with a ❌ that you would find useful, feel free to re
| Basic support | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| <span id="strategy-constraints">**Category: [Strategy constraints](../strategy-constraints.md)**</span> | | | | | | | | |
| Basic support (`IN`, `NOT_IN` operators) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| <span id="strategy-constraints-advanced-support">Advanced support (Semver, date, numeric and extended string operators)</span> (introduced in) | ✅ (5.1) | ✅ (3.12) | ✅ (3.3) | ✅ (5.1) | ✅ (4.2) | ✅ (2.1) | ✅ (1.3.1) | ⭕ |
| <span id="strategy-constraints-advanced-support">Advanced support (Semver, date, numeric, and extended string operators)</span> (introduced in) | ✅ (5.1) | ✅ (3.12) | ✅ (3.3) | ✅ (5.1) | ✅ (4.2) | ✅ (2.1) | ✅ (1.3.1) | ⭕ |
| **Category: [Unleash Context](../reference/unleash-context)** | | | | | | | | |
| Static fields (`environment`, `appName`) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Defined fields | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Expand All @@ -99,7 +100,7 @@ If you see an item marked with a ❌ that you would find useful, feel free to re
| [Custom stickiness](../stickiness.md#custom-stickiness-beta) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ |
| [Strategy Variants](./strategy-variants)| ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ |
| **Category: Local backup** | | | | | | | | |
| File based backup | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ |
| File-based backup | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ |
| **Category: Usage metrics** | | | | | | | | |
| Can disable metrics | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Client registration | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Expand Down Expand Up @@ -134,7 +135,7 @@ Here's some of the fantastic work our community has done to make Unleash work in

### Implement your own SDK {#implement-your-own-sdk}

If you can't find an SDK that fits your need, you can also develop your own SDK. To make implementation easier, check out these resources:
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.
- [Client SDK overview](../client-specification) - A brief, overall guide of the _Unleash Architecture_ and important aspects of the SDK role in it all.
Expand All @@ -143,7 +144,7 @@ If you can't find an SDK that fits your need, you can also develop your own SDK.

The following section details the behavior of frontend / client-side SDKs when initializing and fetching flags with respect to network connectivity.

When the SDK is initialized in the application, an in memory repository is setup and synchronized against the frontend API using the configured token and context. Note that the frontend API is hosted by either the Unleash Proxy/Edge or the upstream Unleash instance directly.
When the SDK is initialized in the application, an in-memory repository is set up and synchronized against the frontend API using the configured token and context. Note that the frontend API is hosted by either the Unleash Proxy/Edge or the upstream Unleash instance directly.

1. All feature flag evaluation is performed by the Proxy/Edge or Unleash instance. A payload of all enabled flags and their variants (if applicable) is returned as a single request. Disabled flags are not included.

Expand Down
20 changes: 10 additions & 10 deletions website/docs/understanding-unleash/data-collection.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
---
title: Data collection
---
:::info

At Unleash, we prioritize the privacy and security of our users' data. This document provides an overview of the data collected when running Unleash. We explain the purpose of data collection and provide instructions on managing data collection settings.

:::

## What data is collected {#what-data-is-collected}
## What data is collected
When running Unleash, we collect the following data:

**Version and Instance ID**: A unique identifier and version for your Unleash instance. This ID allows us to track usage statistics and measure the adoption of Unleash across different installations and helps us ensure that you're using the latest version with the most up-to-date features and security enhancements.
Expand All @@ -26,16 +22,20 @@ This includes the following data points:
- The number of custom strategies defined and in use
- The number of feature exports/imports made

Please note that all collected data is anonymous, and we only collect usage counts. This data helps us understand how features are used in Unleash, enabling us to prioritize important features and make informed decisions about deprecating features that are no longer relevant to our users.
All collected data is anonymous, and we only collect usage counts. This data helps us understand how features are used in Unleash, enabling us to prioritize important features and make informed decisions about deprecating features that are no longer relevant to our users.

Please note that we do not collect personally identifiable information (PII) through Unleash.
:::info

Unleash does not collect personally identifiable information (PII).

:::

## Managing data collection settings {#managing-data-collection-settings}
## Managing data collection settings
We understand that privacy preferences may vary among our users. While the data collected by Unleash is limited and anonymous, we provide options to manage data collection settings:

**Disabling All Telemetry**: If you have previously disabled the version telemetry by setting the environment variable `CHECK_VERSION` to anything other than "true", "t" or "1" both the version telemetry and the feature telemetry will be disabled. This respects your choice to opt out of all telemetry data if you had previously disabled it.
**Disabling All Telemetry**: If you have previously disabled the version telemetry by setting the environment variable `CHECK_VERSION` to anything other than `true`, `t`, or `1`, then both the version telemetry and the feature telemetry will be disabled. This respects your choice to opt out of all telemetry data if you had previously disabled it.

**Turning Off Feature Telemetry**: To disable the collection of the new telemetry data while still allowing the version telemetry, set the environment variable `SEND_TELEMETRY` to anything other than "true", "t" or "1" before starting Unleash. This will ensure that the new telemetry data is not sent, but the version information is still sent.
**Turning Off Feature Telemetry**: To disable the collection of the new telemetry data while still allowing the version telemetry, set the environment variable `SEND_TELEMETRY` to anything other than `true`, `t`, or `1` before starting Unleash. This will ensure that the new telemetry data is not sent, but the version information is still sent.

We respect your privacy choices, and we will continue to honor your decision regarding telemetry. If you have any questions or concerns about managing data collection settings or privacy, please reach out to our support team for assistance.

Loading
Loading