docs: spelling and grammar (#6007)

<!-- Thanks for creating a PR! To make it easier for reviewers and
everyone else to understand what your changes relate to, please add some
relevant content to the headings below. Feel free to ignore or delete
sections that you don't think are relevant. Thank you! ❤️ -->

## About the changes
<!-- Describe the changes introduced. What are they and why are they
being introduced? Feel free to also add screenshots or steps to view the
changes if they're visual. -->
This is a demo that uses [Floe](https://www.floe.dev/) to review the
`how-to` directory using the `spelling-and-grammar` rule.

You can read more about the tool here: https://www.floe.dev/docs
pull/6014/head
Nicholas Haley 4 months ago committed by GitHub
parent e9d49d68fd
commit ab24264df9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 15
      .floe/config.json
  2. 1
      .floe/rules/spelling-and-grammar.md
  3. 2
      website/docs/how-to/how-to-add-feature-flag-naming-patterns.mdx
  4. 4
      website/docs/how-to/how-to-add-sso-open-id-connect.md
  5. 4
      website/docs/how-to/how-to-create-and-assign-custom-project-roles.md
  6. 2
      website/docs/how-to/how-to-define-custom-context-fields.md
  7. 4
      website/docs/how-to/how-to-environment-import-export.mdx
  8. 6
      website/docs/how-to/how-to-import-export.md
  9. 4
      website/docs/how-to/how-to-schedule-feature-releases.mdx
  10. 4
      website/docs/how-to/how-to-send-feature-updates-to-slack-deprecated.md
  11. 4
      website/docs/how-to/how-to-set-up-group-sso-sync.md
  12. 2
      website/docs/how-to/how-to-synchronize-unleash-instances.md

@ -0,0 +1,15 @@
{
"$schema": "https://unpkg.com/@floe/config@0.1.0-beta.13/schema.json",
"reviews": {
"maxFileEvaluations": 33,
"maxDiffEvaluations": 20
},
"rulesets": {
"docs": {
"include": ["**/*.md", "**/*.mdx"],
"rules": {
"spelling-and-grammar": "warn"
}
}
}
}

@ -0,0 +1 @@
Make sure to use proper spelling and grammar.

@ -23,6 +23,6 @@ Navigate to the project settings page for the project you want to add feature fl
Use the "feature flag naming pattern" section of the project settings form to add a feature flag naming pattern, plus the optional example and/or description.
When you've entered you're data, save the changes.
When you've entered your data, save the changes.
![The "feature flag naming pattern" part of the form. Input fields for pattern, example, and description](/img/naming-pattern-forms.png)

@ -59,9 +59,9 @@ Save your new application and you will get the required details you need to conf
**c) Configure OpenID Connect provider in Unleash**
Navigate to Unleash and insert the details (Discover URL, Client Id and Client Secret) in to Unleash.
Navigate to Unleash and insert the details (Discover URL, Client Id and Client Secret) into Unleash.
> Pleas note that the `Discover URL` must be a valid URL and must include the `https://` prefix. For example: **https://dev-example-okta.com** is a valid discovery URL.
> Please note that the `Discover URL` must be a valid URL and must include the `https://` prefix. For example: **https://dev-example-okta.com** is a valid discovery URL.
You may also choose to “Auto-create users”. This will make Unleash automatically create new users on the fly the first time they sign-in to Unleash with the given SSO provider (JIT). If you decide to automatically create users in Unleash you must also provide a list of valid email domains. You must also decide which root Unleash role they will be assigned (Editor role will be the default).

@ -46,7 +46,7 @@ To assign a custom project role to a user:
2. Navigate to the project's _access_ tab.
![A project overview with the 'access' tab highlighted.](/img/assign-cpr-step-2.png)
3. This step depends on whether the user has already been added to the project or not:
- If the user has already been added to the project, click on the edit icon coresponding with its line and from the overlay that will show up select the new role you want to assign it from the dropdown and save the changes.
- If the user has already been added to the project, click on the edit icon corresponding with its line and from the overlay that will show up select the new role you want to assign it from the dropdown and save the changes.
![A list of users with access to the current project. To the right of each user is a dropdown input labeled role.](/img/assign-cpr-step-3a.png)
- If the user _hasn't_ been added to the project, add them using the button 'Assing user/group'. From the overlay that will show up select the user, assign it a role and save the changes. Now you should be able to see the new user in the table.
- If the user _hasn't_ been added to the project, add them using the button 'Assign user/group'. From the overlay that will show up select the user, assign it a role and save the changes. Now you should be able to see the new user in the table.
![Adding a user to a project. The add user form is filled out with data for an "Alexis". The Role input is open and the custom "Developer" role is highlighted.](/img/assign-cpr-step-3b.png)

@ -25,7 +25,7 @@ In the Unleash Admin UI, navigate to the _context fields_ page:
## Step 2: Define the new context field {#step-2-define-new-context-field}
Define the custom context field by filling out the form. You must at least the field a unique _name_. Everything else is optional. Refer to the [custom context field reference guide](../reference/unleash-context.md#custom-context-fields) for a full overview of the parameters and their functions and requirements.
Define the custom context field by filling out the form. You must at least give the field a unique _name_. Everything else is optional. Refer to the [custom context field reference guide](../reference/unleash-context.md#custom-context-fields) for a full overview of the parameters and their functions and requirements.
When you are satisfied with the context field's values, use the "create" button to submit the form and save the context field.

@ -16,7 +16,7 @@ Environment export and import lets you copy feature configurations from one envi
When exporting, you select a set of features and **one** environment to export the configuration from. The environment must be the same for all features.
Then, when you import, you must select **one** environment and **one** project to import into. All features are imported into that project in that environment. If Unleash is unable to import the configuration safely, it will tell you why the import failed and what you need to do fix it (read more about [import requirements](#import-requirements).
Then, when you import, you must select **one** environment and **one** project to import into. All features are imported into that project in that environment. If Unleash is unable to import the configuration safely, it will tell you why the import failed and what you need to fix it (read more about [import requirements](#import-requirements).
## Import & Export items
@ -53,7 +53,7 @@ Import is a 3 stage process designed to be efficient and error-resistant.
### Import stages
* **upload** - you can upload previously exported JSON file or copy-paste export data from the exported JSON file into the code editor
* **validation** - you will get feedback on any errors or warnings before you do the actual import. This makes sure your feature flags configurations. You will not be able to finish the import if you have errors. Warnings don't stop you from importing.
* **validation** - you will get feedback on any errors or warnings before you do the actual import. This ensures your feature flags configurations are correct. You will not be able to finish the import if you have errors. Warnings don't stop you from importing.
* **import** - the actual import that creates a new configuration in the target environment or creates a [change request]/reference/change-requests.md) when the environment has change requests enabled
![The import UI. It has three stages: import, file, validate configuration, finish import.](/img/import.png)

@ -15,7 +15,7 @@ Api admin state is deprecated from version 5. We recommend using the new [Enviro
:::
Unleash supports import and export of feature toggles and strategies at startup and during runtime. The main purpose of the import/export feature is to bootstrap new Unleash instances with feature toggles and their configuration. If you are looking for a granular way to keep seperate Unleash instances in sync we strongly recommend that you take a look at the Unleash Admin APIs.
Unleash supports import and export of feature toggles and strategies at startup and during runtime. The main purpose of the import/export feature is to bootstrap new Unleash instances with feature toggles and their configuration. If you are looking for a granular way to keep separate Unleash instances in sync we strongly recommend that you take a look at the Unleash Admin APIs.
The import mechanism guarantees that:
- all imported features will be non-archived
@ -86,7 +86,7 @@ You can customize the import with query parameters:
| Parameter | Default | Description |
| --- | --- | --- |
| drop | `false` | If the database should be cleaned before import (see comment below) |
| keep | `true` | If true, the existing feature toggles and strategies will not be override |
| keep | `true` | If true, the existing feature toggles and strategies will not be overridden |
If you want the database to be cleaned before import (**all strategies and features will be removed**), specify a `drop` query parameter.
@ -114,7 +114,7 @@ Unleash lets you do this both via configuration parameters and environment varia
### Importing files
To import strategies and toggles from a file (called `configuration.yml` in the examples below), either
- use the `importFile` parameter to point to the file (you can also passed this into the `unleash.start()` entry point)
- use the `importFile` parameter to point to the file (you can also pass this into the `unleash.start()` entry point)
``` shell
unleash-server --databaseUrl [...] \
--importFile configuration.yml

@ -12,7 +12,7 @@ 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's two distinct ways to do this, depending on which version of Unleash you are running:
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)
@ -27,7 +27,7 @@ This guide assumes that you've got the following:
## Schedule feature releases with strategy constraints {#strategy-constraints}
[Strategy contstraints](../reference/strategy-constraints.md#date-and-time-operators) are the easiest way to schedule feature releases ([as long as your SDKs are up to date](../reference/strategy-constraints.md#incompatibilities)). You can use this approach with _any_ strategy you want. The strategies will work just as they normally do, they just won't become active until the specified time. For example: with the standard strategy, the feature would become available to all your users at the specified time; with a gradual rollout, the rollout would start at the specified time.
[Strategy constraints](../reference/strategy-constraints.md#date-and-time-operators) are the easiest way to schedule feature releases ([as long as your SDKs are up to date](../reference/strategy-constraints.md#incompatibilities)). You can use this approach with _any_ strategy you want. The strategies will work just as they normally do, they just won't become active until the specified time. For example: with the standard strategy, the feature would become available to all your users at the specified time; with a gradual rollout, the rollout would start at the specified time.
### Step 1: Add an activation strategy with a date-based constraint

@ -1,5 +1,5 @@
---
title: Feature Updates To slack
title: Feature Updates To Slack
---
:::caution
@ -10,7 +10,7 @@ Event hook option is removed in Unleash v5
:::
## Create a custom Slack WebHook url: {#create-a-custom-slack-webhook-url}
## Create a custom Slack WebHook URL: {#create-a-custom-slack-webhook-url}
1. Go to [https://slack.com/apps/manage/custom-integrations](https://slack.com/apps/manage/custom-integrations)
1. Click Incoming WebHooks

@ -1,5 +1,5 @@
---
title: How set up user group SSO syncing
title: How to Set Up User Group SSO Syncing
---
:::info availability
@ -18,7 +18,7 @@ Navigate to the "Single sign-on" configuration page.
## Step 2: Enable Group Syncing {#step-2}
Turn on "Enable Group Syncing" and enter a value a for "Group Field JSON Path". Refer to the [User group SSO integration documentation](../reference/rbac.md#user-group-sso-integration) for more information or to the [how-to guide for integrating with Keycloak](how-to-setup-sso-keycloak-group-sync.md) for a practical example.
Turn on "Enable Group Syncing" and enter a value for "Group Field JSON Path". Refer to the [User group SSO integration documentation](../reference/rbac.md#user-group-sso-integration) for more information or to the [how-to guide for integrating with Keycloak](how-to-setup-sso-keycloak-group-sync.md) for a practical example.
The value is the JSON path in the token response where your group properties are located, this is up to your SSO provider, a full example for Keycloak can be [found here](../../how-to/how-to-setup-sso-keycloak-group-sync). Once you're happy, save your configuration.

@ -4,7 +4,7 @@ title: 'How to synchronize Unleash instances'
:::note
This is experimental feature
This is an experimental feature
:::

Loading…
Cancel
Save