1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-05-17 01:17:29 +02:00

update the docs with the new screenshots

This commit is contained in:
Youssef Khedher 2021-09-21 16:21:48 +01:00
parent c8ec1603ff
commit d87528e7d4
38 changed files with 31 additions and 22 deletions

View File

@ -13,7 +13,7 @@ The first time you log-in to your Unleash instance you will see an empty list of
## Step 2: Create Feature toggle {#step-2-create-feature-toggle}
After clicking the “create feature toggle button you will be presented with a form for creating a new feature toggle. You will need to define a few fields before you can actually complete the new feature toggle.
After clicking the “create feature toggle button you will be presented with a form for creating a new feature toggle. You will need to define a few fields before you can actually complete the new feature toggle.
- **Name** Must be unique across all your feature toggle. The name must also follow a URL friendly format. Can not be changed.
- **Description** A good description makes it easier for other members on your team to understand why this feature toggle exists.

View File

@ -23,15 +23,11 @@ A common pattern is to organize the feature toggles according to key areas of th
When you log into Unleash for the first time, there is a Default project already created. All feature toggles are included in the Default project, unless explicitly set to a different one.
From the top-line menu click on the hamburger icon.
From the top-line menu click on “Projects”
![Project concept](/img/projects_menu.png)
![Project concept](/img/projects_button.png)
From the menu choose “Projects”
<img src="/img/projects_menu_open.png" alt="menu open" width="200"/>
The available projects will now be listed. To create a new Project choose the “+”
The available projects will now be listed. To create a new Project choose the “Add new project”
![Project concept](/img/projects_new_project.png)
@ -47,7 +43,13 @@ The configuration of a new Project is now available. the following input is avai
## Deleting an existing project {#deleting-an-existing-project}
To keep your feature toggles clean, removing deprecated projects is important. From the overview of Projects choose the Delete button for the project you want to delete.
To keep your feature toggles clean, removing deprecated projects is important. From the overview of Projects
1. In the top right of the project card, find the project menu represented by three vertical dots.
![Project concept](/img/projects_menu_button.png)
2. Click on Delete Project
![Project concept](/img/projects_delete_button.png)
@ -59,10 +61,6 @@ From the top-line menu choose the hamburger icon
![Project concept](/img/projects_menu.png)
From the menu choose “Feature toggles”
![Project concept](/img/feature_toggles_menu.png)
The list of features toggles can be filtered on the project of your choice. By default, all feature toggles are listed in the view.
![Project concept](/img/project_select.png)

View File

@ -5,9 +5,9 @@ title: Technical Debt
At Unleash we care deeply about code quality. Technical debt creeps up over time and slowly builds to the point where it really starts to hurt. At that point it's too late. Feature toggles that have outlived their feature and are not cleaned up represent technical dept that should be cleaned up and removed from your code.
In order to assist with removing unused feature toggles, Unleash provides a technical debt dashboard in the management-ui. You can find it by opening up the sidebar in the management ui and clicking on the _reporting_ menu item.
In order to assist with removing unused feature toggles, Unleash provides a technical debt dashboard in the management-ui. You can find it by clicking on “Advanced” in the top-line menu then choose _Reporting_ in the dropdown menu.
![Technical debt](/img/reporting.png)
![Technical debt](/img/reporting.png)
The dasboard includes a health report card, and a list of toggles that can be filtrated on different parameters.

View File

@ -17,15 +17,19 @@ All users are able to see tokens with CLIENT level access, but only instance adm
### Step-by-step {#step-by-step}
**1. Select `Admin` from the sidebar**
**1. Select `Advanced` from the top-line menu**
![Admin menu](/img/admin_top-line_menu.png)
![Admin menu](/img/admin_side_menu.png)
**2. Select `API Access` from the dropdown**
**2. Select `Api Access` from the tab menu**
![Tab Menu](/img/admin_advanced_dropdown.png)
**3. Select `API ACCESS` from the tab men**
![Tab Menu](/img/admin_tab_menu.png)
**3. Click `Add new API key` at the top right of the page**
**4. Click `Add new API key` at the top right of the page**
![Tab Menu](/img/admin_new_api_key_button.png)
**Client keys**

View File

@ -5,12 +5,19 @@ title: User Management
> This feature was introduced in Unleash v4 for Unleash Open-Source.
From the `Admin > Users` you can manage users with access to Unleash. To add a new user to your Unleash instance simply click the "Add user" button:
You can manage users with access to Unleash in the `Admin > Users`.
![Add user button](/img/user_admin-add-user.png)
From the top-line menu click on the “Settings Wheel” then click on “Users”.
![Add user button](/img/user_admin_list_button.png)
To add a new user to your Unleash instance simply click the "Add user" button:
![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.
![Add user button](/img/user_admin_add_user_modal.png).
![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.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 330 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 454 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 563 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.3 KiB

After

Width:  |  Height:  |  Size: 576 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 232 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 281 KiB

After

Width:  |  Height:  |  Size: 617 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 130 KiB

After

Width:  |  Height:  |  Size: 1023 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

After

Width:  |  Height:  |  Size: 1.0 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 238 KiB

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 237 KiB

After

Width:  |  Height:  |  Size: 613 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 153 KiB

After

Width:  |  Height:  |  Size: 555 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 527 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 169 KiB

After

Width:  |  Height:  |  Size: 580 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 87 KiB

After

Width:  |  Height:  |  Size: 542 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 147 KiB

After

Width:  |  Height:  |  Size: 638 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 525 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 557 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 123 KiB

After

Width:  |  Height:  |  Size: 560 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 154 KiB

After

Width:  |  Height:  |  Size: 599 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 178 KiB

After

Width:  |  Height:  |  Size: 588 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 315 KiB

After

Width:  |  Height:  |  Size: 568 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 225 KiB

After

Width:  |  Height:  |  Size: 614 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 245 KiB

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 113 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 630 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 500 KiB