Account settings/project management (#74)

* Account-settings user-guide, Project management concept + user guide

Signed-off-by: Vansh Bhatia <vansh@chaosnative.com>

* Flow chart for privilege levels added

Signed-off-by: Vansh Bhatia <vansh@chaosnative.com>

* Flow chart resolution improved

Signed-off-by: Vansh Bhatia <vansh@chaosnative.com>

* Added Introduction, Prerequisites, Summary for concepts + Introduction & Before you begin section for user-guides

Signed-off-by: Vansh Bhatia <vansh@chaosnative.com>
This commit is contained in:
Vansh Bhatia 2021-08-06 11:28:23 +05:30 committed by GitHub
parent 799206c7d6
commit 2e066a6581
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
19 changed files with 138 additions and 33 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 130 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 131 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 131 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 119 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 110 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 109 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

View File

@ -1,7 +0,0 @@
---
id: project
title: Project
sidebar_label: Project
---
## Coming soon

View File

@ -0,0 +1,35 @@
---
id: projects
title: Projects
sidebar_label: Projects
---
## Introduction
The ChaosCenter comes with a project management system which can be used for working on chaos workflows with multiple different projects across different agents.
## Prerequisites
Before learning abpout the concept of `projects`, it is important to note that a `project` signifies a separation between [Agents](agent), [Schedules](chaos-schedule), [Observability](observe-workflow), and Teams (discussed in the next section) configurations, and prior knowledge of these will prove fruitful in understanding the concept of `projects` in-depth.
## Projects
The project management feature is the second level of privilege layer delivered by the ChaosCenter and a breakdown can be observed in the below diagram:
<img src={require('../assets/concepts/projects/flow-chart.png').default} width="1000" height="500" />
The specifics of project management with respect to different first layer privilege levels (Admin/non-admin users) are discussed below:
The **Admin** user of the portal has a default project (named as `admins project`) created on the initial login, and by default has the `owner` privileges in this project.
The Admin can [create a user](../user-guides/create-user) (these users will be treated as **non-admin** users), and each of these users will have their own projects created on completion of their initial login. The `Owner` of a project can invite multiple users to their project, and a user can be a part of multiple projects, these features are covered under the [teaming](teaming) section.
## Summary
Projects can be imagined as separations between multiple different configurations for your chaos and help you manage collaborations between multiple teams.
## Learn More
- [More about project management](../user-guides/change-project-name)
- [More about Teaming](teaming)
- [Invite a member to your project](../user-guides/invite-team-member)

View File

@ -12,7 +12,7 @@ Each user has a default project created on user creation by the admin for which
Teaming is based on the following principles and each user can have one of the 3 project roles:
- **Owner:** One who created the project and owns it. Only the owner has permission to manage(invite or remove) the members in his/her project. The owner can schedule workflows, update workflows, delete workflows and view the analytics.
- **Editor:** Members invited with the editor role can do everything an owner can except for managing the members in the project.
- **Editor:** Members invited with the editor role can do everything an owner can except for managing the project.
- **Viewer:** Members having a viewer role can only view the analytics related to the workflows and the workflows themselves, but are not given the permission to schedule workflows in the project.
### Role privileges

View File

@ -1,7 +0,0 @@
---
id: account-settings
title: Changing Account Settings
sidebar_label: Account Settings
---
## Coming soon

View File

@ -4,4 +4,35 @@ title: Changing Project Name
sidebar_label: Change Project Name
---
## Coming soon
## Introduction
Owners have the ability to change the name of their project if they wish to do so.
## Before you begin
The concept of `Projects` is discussed [here](../concepts/projects) and will help you build a foundational understanding of what projects mean in the ChaosCenter.
## Steps
### 1. Go to `My Project`
Go to the `Team` section of settings and scroll to the `My project` section:
<img src={require('../assets/user-guides/managing-projects/change-project-name/step-1.png').default} width="1000" height="500" />
### 2. Enter edit mode
Click on either the text (demonstrated in this example as `admins project`) or on the edit icon next to it to enter the edit mode:
<img src={require('../assets/user-guides/managing-projects/change-project-name/step-2.png').default} width="1000" height="500" />
### 3. Replace name
Once in the editing mode, type out the name you want to replace the current name with, and click away anywhere in the screen. You will notice that the name of the project has been changed in the `My Project` section as well as the header of the portal.
<img src={require('../assets/user-guides/managing-projects/change-project-name/step-3.png').default} width="1000" height="500" />
## Learn More
- [Invite a member to your project](invite-team-member)
- [Remove a member from your project](remove-team-member)

View File

@ -1,7 +0,0 @@
---
id: get-added-to-projects
title: Getting Added to a Project
sidebar_label: Get Added to Projects
---
## Coming soon

View File

@ -4,4 +4,23 @@ title: Leave a Project
sidebar_label: Leave Project
---
## Coming soon
## Introduction
You can leave a project that you no longer wish to be a part of.
## Steps
### 1. Identify the project you want to leave
In the settings page, scroll to the very bottom of the `Team` tab. Here you will see a list of all the projects you are a part of, identify the project youd like to leave and click on the `Leave Project` button:
<img src={require('../assets/user-guides/managing-projects/leave-project/step-1.png').default} width="1000" height="500" />
> Note: Having left the project, the number of active projects will change and the project you left can no longer be observed as a currently active project in the `Team` tab
<img src={require('../assets/user-guides/managing-projects/leave-project/step-2.png').default} width="1000" height="500" />
### Learn more
- [Invite a member to your project](invite-team-member)
- [Remove a member from your project](remove-team-member)

View File

@ -0,0 +1,42 @@
---
id: my-account
title: My Account
sidebar_label: My Account
---
## Introduction
Under the `My Account` tab, you can change your personal details such as the email, full name, and password.
> Note: The username cant be changed as it is unique.
## Edit Personal Details
### 1. Enter details
Enter your name and your email address in the following text fields and click on the `Save Changes` button.
<img src={require('../assets/user-guides/my-account/step-1.png').default} width="1000" height="500" />
Once done successfully, youll be getting a modal indicating a successful completion of the operation.
<img src={require('../assets/user-guides/my-account/step-2.png').default} width="1000" height="500" />
## Change Password
### 1. Enter new password
On the same page, you can change your password by providing your current as well as your new password and then click on the `Change Password` button.
<img src={require('../assets/user-guides/my-account/step-3.png').default} width="1000" height="500" />
> Note: If you have forgotten your password, please contact your admin to reset your password
On successful completion, youll be getting a modal indicating that the password has been changed.
<img src={require('../assets/user-guides/my-account/step-4.png').default} width="1000" height="500" />
## Learn more
- [Create a new user](create-user)
- [View users and their details](view-user)

View File

@ -33,7 +33,6 @@ module.exports = {
'concepts/chaos-schedule',
'concepts/chaoshub',
'concepts/chaos-center',
'concepts/project',
'concepts/agent',
{
Workflow: ['concepts/chaos-workflow', 'concepts/observe-workflow']
@ -42,6 +41,7 @@ module.exports = {
Observability: ['concepts/workflow-statistics', 'concepts/app-infra-monitoring', 'concepts/datasource']
},
'concepts/user-management',
'concepts/projects',
'concepts/teaming',
'concepts/gitops'
]
@ -100,14 +100,7 @@ module.exports = {
]
},
'user-guides/byoc',
'user-guides/account-settings',
{
'Managing Projects': [
'user-guides/change-project-name',
'user-guides/get-added-to-projects',
'user-guides/leave-project'
]
},
'user-guides/my-account',
{
'User Management': [
'user-guides/view-user',
@ -116,6 +109,12 @@ module.exports = {
'user-guides/deactivate-user'
]
},
{
'Managing Projects': [
'user-guides/change-project-name',
'user-guides/leave-project'
]
},
{
Teaming: [
'user-guides/invite-team-member',