diff --git a/website/docs/advanced/api_access.md b/website/docs/advanced/api_access.md index e841b7cae6..2d0d674a8c 100644 --- a/website/docs/advanced/api_access.md +++ b/website/docs/advanced/api_access.md @@ -1,13 +1,13 @@ --- id: api_access -title: API Access +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. ## Step 1: Create API token {#step-1-create-api-token} -Please refer to [Create token](../user_guide/api-token) on how to create an API token. You'll need a token with `Admin` level access for this to work. +Please refer to [_how to create API tokens_](../user_guide/api-token) on how to create an API token. You'll need a token with `Admin` level access for this to work. Please note that it may take up to 60 seconds for the new key to propagate to all Unleash instances due to eager caching. diff --git a/website/docs/advanced/sso-google.md b/website/docs/advanced/sso-google.md index 7e2584d768..909dc6d0cc 100644 --- a/website/docs/advanced/sso-google.md +++ b/website/docs/advanced/sso-google.md @@ -1,6 +1,6 @@ --- id: sso-google -title: SSO - Google (deprecated) +title: How to add SSO with Google (deprecated) --- > Single Sign-on via the Google Authenticator provider is deprecated. We recommend using [OpenId Connect](./sso-open-id-connect.md) instead. diff --git a/website/docs/advanced/sso-open-id-connect.md b/website/docs/advanced/sso-open-id-connect.md index a826d7d8c7..b2cd6a4ece 100644 --- a/website/docs/advanced/sso-open-id-connect.md +++ b/website/docs/advanced/sso-open-id-connect.md @@ -1,6 +1,6 @@ --- id: sso-open-id-connect -title: SSO - OpenId Connect +title: How to add SSO with OpenId Connect --- > 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. diff --git a/website/docs/advanced/sso-saml-keycloak.md b/website/docs/advanced/sso-saml-keycloak.md index 0f4e466046..1d55381176 100644 --- a/website/docs/advanced/sso-saml-keycloak.md +++ b/website/docs/advanced/sso-saml-keycloak.md @@ -1,6 +1,6 @@ --- id: sso-saml-keycloak -title: SSO - SAML 2.0 Keycloak +title: How to add SSO with SAML 2.0 Keycloak --- > 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. diff --git a/website/docs/advanced/sso-saml.md b/website/docs/advanced/sso-saml.md index 821ed80a38..663bbcb1d6 100644 --- a/website/docs/advanced/sso-saml.md +++ b/website/docs/advanced/sso-saml.md @@ -1,6 +1,6 @@ --- id: sso-saml -title: SSO - SAML 2.0 Okta +title: How to add SSO with SAML 2.0 Okta --- > 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. diff --git a/website/docs/user_guide/create-feature-toggle.md b/website/docs/user_guide/create-feature-toggle.md index 5d46e3b808..119c851919 100644 --- a/website/docs/user_guide/create-feature-toggle.md +++ b/website/docs/user_guide/create-feature-toggle.md @@ -1,6 +1,6 @@ --- id: create_feature_toggle -title: Create a feature toggle +title: How to create a feature toggle --- In this guide you will learn how to create your first feature toggle using Unleash. diff --git a/website/docs/user_guide/token.md b/website/docs/user_guide/token.md index b6ab8586d1..29a24d1f5d 100644 --- a/website/docs/user_guide/token.md +++ b/website/docs/user_guide/token.md @@ -1,6 +1,6 @@ --- id: api-token -title: API Tokens +title: How to create API Tokens --- In order to connect to Unleash clients will need an API token to grant access. A client SDK will need to token with "client privileges", which allows them to fetch feature toggle configuration and post usage metrics back. diff --git a/website/docs/user_guide/user-management.md b/website/docs/user_guide/user-management.md index ef42be043a..04cd0686d1 100644 --- a/website/docs/user_guide/user-management.md +++ b/website/docs/user_guide/user-management.md @@ -1,23 +1,21 @@ --- id: user-management -title: User Management +title: How to add new users to your Unleash instance --- > This feature was introduced in Unleash v4 for Unleash Open-Source. -You can manage users with access to Unleash in the `Admin > Users`. +You can add new users to Unleash in `Admin > Users`. -From the top-line menu – click on the “Settings Wheel” then click on “Users”. -![Add user button](/img/user_admin_list_button.png) +1. From the top-line menu – click on the “Settings Wheel” then click on “Users”. + ![A visual representation of the current step: the Unleash Admin UI with the steps highlighted.](/img/user_admin_list_button.png) +2. To add a new user to your Unleash instance simply click the "Add user" button: + ![The Unleash users page with the 'add new user' button being pointed to.](/img/user_admin-add-user.jpg) +3. Fill out the required fields about the user in the modal. You need to choose which role the new user should have on the "root level". E.g. giving the user an Editor role will allow the user to create a new project. -To add a new user to your Unleash instance simply click the "Add user" button: -![Add user button](/img/user_admin-add-user.jpg) + ![A form titled "Add team member". It has the fields "full name", "email", and "role". The role field is a radio button set with roles called "admin", "editor", and "viewer".](/img/user_admin_add_user_modal.png) -Fill out the required fields about the user in the modal. You need to choose which role the new user should have on the "root level". E.g. giving the user an Editor role will allow the user to create a new project. - -![Add user button](/img/user_admin_add_user_modal.png) - -If you have configured an email server the user will receive the invite link in her inbox, otherwise you should share the magic invite link to Unleash presented in the confirmation dialogue. + If you have configured an email server the user will receive the invite link in her inbox, otherwise you should share the magic invite link to Unleash presented in the confirmation dialogue.