Skip to content

Commit

Permalink
More typos
Browse files Browse the repository at this point in the history
  • Loading branch information
melindafekete committed Aug 21, 2024
1 parent 494277d commit 4c27839
Show file tree
Hide file tree
Showing 13 changed files with 23 additions and 28 deletions.
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 SDK 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 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 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 a 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.

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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: How to create personal API tokens
title: How to create Personal Access Tokens
---

:::info availability
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 a 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.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The **Provisioning capability** is only available for customers on the Enterpris

### Step 1: Navigate to Provisioning configuration {#unleash-setup-step-1}

First you'll need to log in to Unleash as an admin user. Navigate to the Single sign-on section and select the "SCIM" tab. The SCIM API URL will be shown in this section, you'll need this to configure Entra later.
First you'll need to log in to Unleash as an admin user. Go to **Admin > Single sign-on** and select the **SCIM** tab. The SCIM API URL will be shown in this section, you'll need this to configure Entra later.

![Navigate to the SCIM Config](/img/scim-config-1.png)

Expand Down
2 changes: 1 addition & 1 deletion website/docs/how-to/how-to-setup-provisioning-with-okta.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The **Provisioning capability** is only available for customers on the Enterpris

### Step 1: Navigate to Provisioning configuration {#unleash-setup-step-1}

First you'll need to log in to Unleash as an admin user. Navigate to the Single Sign-On section and select the "SCIM" tab. The SCIM API URL will be shown in this section, you'll need this to configure Okta later.
First you'll need to log in to Unleash as an admin user. Go to **Admin > Single sign-on** and select the **SCIM** tab. The SCIM API URL will be shown in this section, you'll need this to configure Okta later.

![Navigate to the SCIM Config](/img/scim-config-1.png)

Expand Down
2 changes: 1 addition & 1 deletion 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
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 @@ -43,7 +43,7 @@ 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 were introduced in Unleash 4.22.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Unleash Enterprise supports SAML 2.0, OpenID Connect and Google Authentication.

### Before you start

In order to configure single sign-on you will need to log in to the Unleash instance with a user that have Admin role. If you are self-hosting Unleash then a default user will be automatically created the first time you start unleash:
To configure single sign-on, log in to the Unleash instance with a user that has an Admin role. If you are self-hosting, then a default user will be automatically created the first time you start Unleash:

- username: `admin`
- password: `unleash4all` _(or `admin` if you started with Unleash v3)._
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,11 @@ This guide outlines Best Practices for feature flag migrations. Approaching the

Based on our work with organizations having millions of flags and thousands of users, there are five phases of a feature flag migration:

- [Defining the scope of the feature flag migration](#defining-the-scope-of-the-feature-flag-migration)
- [1- Separate the migration of old flags from the existing system from new flags created in Unleash.](#1--separate-the-migration-of-old-flags-from-the-existing-system-from-new-flags-created-in-unleash)
- [2- Do not make end-to-end app modernization a dependency of your feature flag migration](#2--do-not-make-end-to-end-app-modernization-a-dependency-of-your-feature-flag-migration)
- [Make the business case for feature flag migration](#make-the-business-case-for-feature-flag-migration)
- [Planning Feature Flag Migration](#planning-feature-flag-migration)
- [Use Cases](#use-cases)
- [Key stakeholders](#key-stakeholders)
- [How is our current feature flag architecture set up?](#how-is-our-current-feature-flag-architecture-set-up)
- [Security and organizational policy requirements](#security-and-organizational-policy-requirements)
- [Migration Execution](#migration-execution)
- [Onboarding users](#onboarding-users)
1. [Defining the scope of the feature flag migration](#defining-the-scope-of-the-feature-flag-migration)
2. [Make the business case for feature flag migration](#make-the-business-case-for-feature-flag-migration)
3. [Planning Feature Flag Migration](#planning-feature-flag-migration)
4. [Migration Execution](#migration-execution)
5. [Onboarding users](#onboarding-users)

This guide provides a summary of each topic as well as a detailed [Feature Flag Migration template](https://docs.google.com/spreadsheets/d/1MKc95v7Tc-9tznWMDVSy2vvmVJTvOFLRVZpx1QrL-_U/edit#gid=996250264) that you can use to plan your migration.

Expand All @@ -42,7 +36,7 @@ In parallel, the second track:

### 2- Do not make end-to-end app modernization a dependency of your feature flag migration

Organizations that adopt feature flags see improvements in all key operational metrics for DevOps: Lead time to changes, mean-time-to-recovery, deployment frequency, and change failure rate. So it is natural as part of a feature flag migration to also improve other parts of the software development lifecycle. From the perspective of feature flag migration, this is a mistake.
Organizations that adopt feature flags see improvements in all key operational metrics for DevOps: lead time to changes, mean-time-to-recovery, deployment frequency, and change failure rate. So it is natural as part of a feature flag migration to also improve other parts of the software development lifecycle. From the perspective of feature flag migration, this is a mistake.

Making feature flag migration dependent on breaking down mission-critical monolithic applications into microservices, for example, will slow down your feature flag migration.

Expand All @@ -58,7 +52,7 @@ When building a business case, you want to be clear on what pain the feature fla

To structure your thinking, ask yourself:

- What practices related to feature deployments, debugging and rollbacks are overburdening teams today and driving down productivity?
- What practices related to feature deployments, debugging, and rollbacks are overburdening teams today and driving down productivity?
- What specific deficiencies are there in the current platform?
- What business outcomes are you looking to drive?
- After the migration, what does "better" look like?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ If feature flags are so great, why shouldn’t you use them for business logic?

#### Dependency on 3rd party services

Coming from a feature flag vendor, it might surprise you that we do not advocate making core business logic dependent on a 3rd party feature flag service. If that flag service is down, then your app could potentially cease to function in the way designed. This applies to using third-party feature flag services, as well as homegrown feature flags services.
Coming from a feature flag vendor, it might surprise you that we do not advocate making core business logic dependent on a 3rd party feature flag service. If that flag service is down, then your app could potentially cease to function in the way designed. This applies to using third-party feature flag services, as well as homegrown solutions.

#### Complexity and Maintainability

Expand Down
2 changes: 1 addition & 1 deletion website/docs/understanding-unleash/data-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Unleash does not collect personally identifiable information (PII).
## 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.

Expand Down
9 changes: 5 additions & 4 deletions website/docs/understanding-unleash/proxy-hosting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ You'll need to configure Edge and the SDKs.

### On Unleash

- Create one or more[client API tokens](https://docs.getunleash.io/reference/api-tokens-and-client-keys#client-tokens) scoped to the projects/environments you wish to use the Edge instance for. Refer to [how to create API tokens](https://docs.getunleash.io/how-to/how-to-create-api-tokens) for the steps to create one.
- Create one or more [client API tokens](https://docs.getunleash.io/reference/api-tokens-and-client-keys#client-tokens) scoped to the projects/environments you wish to use the Edge instance for. Refer to [how to create API tokens](https://docs.getunleash.io/how-to/how-to-create-api-tokens) for the steps to create one.
- Create frontend tokens for the frontend apps that will retrieve feature flags from Edge.

### On Edge
Expand All @@ -93,12 +93,13 @@ It will then accept frontend or backend tokens from application SDKs.

Make sure to use the correct token type for your use case:

- Frontend API: Use for frontend-facing apps; Edge returns application-specific context.
- Client API: Use for backend SDKs; Edge returns the entire flag payload for the scope of the token (project/environment).
- Frontend API: Use for frontend-facing apps; Edge returns application-specific context.
- Client API: Use for backend SDKs; Edge returns the entire flag payload for the scope of the token (project/environment).

:::

**Start Edge and populate flag cache**
#### Start Edge and populate flag cache

This initial command will populate the flag cache on startup using the client token specified in the environment variable:

```docker run -p 3063:3063 -e TOKENS='CLIENT_API_TOKEN' -e UPSTREAM_URL='UPSTREAM_URL' unleashorg/unleash-edge:v8.1 edge```
Expand Down

0 comments on commit 4c27839

Please sign in to comment.