1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-25 00:07:47 +01:00

Rename all how-to guides to start with 'how to'.

This commit is contained in:
Thomas Heartman 2022-01-14 13:08:04 +01:00 committed by Thomas Heartman
parent 286edba290
commit 5e556bc87d
8 changed files with 17 additions and 19 deletions

View File

@ -1,13 +1,13 @@
--- ---
id: api_access 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. 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} ## 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. Please note that it may take up to 60 seconds for the new key to propagate to all Unleash instances due to eager caching.

View File

@ -1,6 +1,6 @@
--- ---
id: sso-google 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. > Single Sign-on via the Google Authenticator provider is deprecated. We recommend using [OpenId Connect](./sso-open-id-connect.md) instead.

View File

@ -1,6 +1,6 @@
--- ---
id: sso-open-id-connect 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. > 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.

View File

@ -1,6 +1,6 @@
--- ---
id: sso-saml-keycloak 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. > 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.

View File

@ -1,6 +1,6 @@
--- ---
id: sso-saml 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. > 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.

View File

@ -1,6 +1,6 @@
--- ---
id: create_feature_toggle 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. In this guide you will learn how to create your first feature toggle using Unleash.

View File

@ -1,6 +1,6 @@
--- ---
id: api-token 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. 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.

View File

@ -1,23 +1,21 @@
--- ---
id: user-management 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. > 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”. 1. From the top-line menu click on the “Settings Wheel” then click on “Users”.
![Add user button](/img/user_admin_list_button.png) ![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: ![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)
![Add user button](/img/user_admin-add-user.jpg)
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. 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.
![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.