Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added user management user guide #224

Merged
merged 1 commit into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 9 additions & 9 deletions website/versioned_docs/version-3.0.0/user-guides/create-user.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,25 @@ sidebar_label: Create User

This feature enables the admin to create a new user by assigning a unique username and password for the user. In addition to this, the admin can also provide the name and email address of the new user which is optional.

## 1. Create a new user
## 1. Navigate to User Management

Click the `Create new user` button as observed below:
Go to the `User Management` tab of the account settings page:

<img src={require('../assets/user-guides/user-management/create-user/step-1.png').default} width="1000" height="500" />
<img src={require('../assets/user-guides/user-management/create-user/step-1.png').default} />

## 2. Add the details of the new user
## 2. Create a new user

Add all the details of the user to be created and hit the `Create` button.
Click on the `New User` button to bring up the `Create New User` modal and enter the details of the new user to be created.

<img src={require('../assets/user-guides/user-management/create-user/step-2.png').default} width="1000" height="500" />
<img src={require('../assets/user-guides/user-management/create-user/step-2.png').default} />

## 3. Confirmation of creation

The user is created and you will receive a confirmation modal.
After you have added the details of the new user to be created, click the `Confirm` button to create the new user.

<img src={require('../assets/user-guides/user-management/create-user/step-3.png').default} width="1000" height="500" />
<img src={require('../assets/user-guides/user-management/create-user/step-3.png').default} />

You will now be able to view the new user in the table in the user management tab.
You will now be able to view the new user in the table in the `User Management` tab.

## Learn more

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ The Account of a created user can be deactivated if required. Once the user is d

In the user management tab, locate the user account that you'd like to deactivate and click on the horizontal options icon.

<img src={require('../assets/user-guides/user-management/deactivate-user/step-1.png').default} width="1000" height="500" />
<img src={require('../assets/user-guides/user-management/deactivate-user/step-1.png').default} />

## 2. Confirm the user is deactivated
## 2. Confirm the deactivation

Once deactivated, the indicator next to the user's username in the usermanagement table will turn gray.
On clicking on the `Disable User` option, a confirmation prompt will pop up, click on the `Confirm` button in order to disable the user.

<img src={require('../assets/user-guides/user-management/deactivate-user/step-2.png').default} width="1000" height="500" />
<img src={require('../assets/user-guides/user-management/deactivate-user/step-2.png').default} />

## 3. Re-activate a user (Optional step)

Similarly, the admin can re-activate the user from the same drop-down menu as shown:

<img src={require('../assets/user-guides/user-management/deactivate-user/step-3.png').default} width="1000" height="500" />
<img src={require('../assets/user-guides/user-management/deactivate-user/step-3.png').default} />

## Learn more

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ The admin has the ability to reset the login password for any user in the portal

## 1. Locate the user

Under the `User management` tab find the user who's password needs to be updated and click on the options icon to open a drop-down and select `Edit Profile` option
Under the `User Management` tab find the user who's password needs to be updated and click on the options icon to open a drop-down and select `Reset Password` option

<img src={require('../assets/user-guides/user-management/reset-password/step-1.png').default} width="1000" height="500" />
<img src={require('../assets/user-guides/user-management/reset-password/step-1.png').default} />

## 2. Change the password

In the `Login Details` section select the `New password` input field and type in the new password. Once done hit the `Save` button to update the password.
In the `Reset Password` modal type in the new password in the `New Password` & `Re-enter new password` fields. Once done hit the `Confirm` button to update the password.

<img src={require('../assets/user-guides/user-management/reset-password/step-2.png').default} width="1000" height="500" />
<img src={require('../assets/user-guides/user-management/reset-password/step-2.png').default} />

## Learn more

Expand Down
4 changes: 2 additions & 2 deletions website/versioned_docs/version-3.0.0/user-guides/view-user.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ sidebar_label: View users

---

> In the `/settings` route (settings on the sidebar) the `User Management` tab can be used to access the user management feature by the admin. We recommend learning about the concept of [user management](../concepts/user-management.md) before proceeding with the following user guides.
> In the `settings` page the `User Management` tab can be used to access the user management feature by the admin. We recommend learning about the concept of [user management](../concepts/user-management.md) before proceeding with the following user guides.

## View users

The admin can access the user management tab to check the list of all users present in the portal.
The admin can access the `User Management` tab to check the list of all users present in the portal.

<img src={require('../assets/user-guides/user-management/view-user/step-1.png').default} width="1000" height="500" />

Expand Down
Loading