Skip to content

Commit

Permalink
Rename all how-to guides to start with 'how to'.
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasheartman committed Jan 25, 2022
1 parent 286edba commit 5e556bc
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 19 deletions.
4 changes: 2 additions & 2 deletions website/docs/advanced/api_access.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/advanced/sso-google.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/advanced/sso-open-id-connect.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/advanced/sso-saml-keycloak.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/advanced/sso-saml.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/user_guide/create-feature-toggle.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/user_guide/token.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
20 changes: 9 additions & 11 deletions website/docs/user_guide/user-management.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 5e556bc

Please sign in to comment.