EPMRPP-91773 || Reorganize Configuration section (#767)

docs/admin-panel/AllProjectsPage.mdx

@@ -5,7 +5,7 @@ sidebar_label: All Projects page
 
 # All Projects page
 
-Users with the Administrator role have access to the ReportPortal "Administrate" section.
+Users with the `Administrator` role have access to the ReportPortal "Administrate" section.
 
 In "Administrate" section you can:
 
@@ -60,19 +60,38 @@ All Projects page allows:
 
 ## Create projects
 
-To create a project, please refer to [Creation of project and adding users](/configuration/CreationOfProjectAndAddingUsers)
+To create a project:
+
+1. Login into the ReportPortal instance as an `Administrator`.
+2. Open menu at the bottom.
+3. Click the 'Administrate' link.
+4. Select 'Projects' from the left-hand sidebar.
+5. Click the 'Add New Project' button in the right top corner.
+6. Then enter a name of the project.
+7. Click the 'Add' button.
+
+A confirmation message in the status bar should appear.
+
+:::note
+The name of the project should contain between 3-256 symbols.
+It can include Latin and numeric characters, as well as underscores and dashes.
+The name should be unique and cannot be changed after saving.
+:::
+An Admin can configure the project settings or leave them as the default.
+Project members with PROJECT_MANAGER roles are able to set up the project settings.
+To know how project settings could be updated, go to the [Project Settings](/configuration/ProjectSettings) section.
 
 ## Modify project settings
 
-To modify project settings please refer to [Project Configuration](/configuration/ProjectConfiguration)
+To modify project settings please refer to [Project Settings](/configuration/ProjectSettings)
 
 ## Invite user on "All Projects" page
 
 To invite a user to a project on "All Projects" page, perform the following steps:
 
-1. Login into the ReportPortal instance as an Administrator.
+1. Login into the ReportPortal instance as an `Administrator`.
 
-2. Navigate to the "Administrate" section -\> "All Projects" page
+2. Navigate to the "Administrate" section -> "All Projects" page
 
 3. Click on ellipsis button on the project preview.
 
@@ -109,7 +128,7 @@ but not exceeding 24 hours.
 
 ## Detailed project info
 
-1. Login into ReportPortal instance as Administrator.
+1. Login into ReportPortal instance as `Administrator`.
 
 2. Navigate to the "Administrate" section -\> "All Projects" page.
 
@@ -124,9 +143,9 @@ but not exceeding 24 hours.
 
 To delete a project, perform the following steps:
 
-1. Login into ReportPortal instance as Administrator.
+1. Login into ReportPortal instance as `Administrator`.
 
-2. Navigate to the "Administrate" section -\> "All Projects" page.
+2. Navigate to the "Administrate" section -> "All Projects" page.
 
 3. Click on ellipsis button on the project preview.
 
@@ -139,3 +158,22 @@ To delete a project, perform the following steps:
 :::note
 PERSONAL PROJECTS cannot be deleted from the system.
 :::
+## Use Case 1
+
+**Situation:** We have a small team. Everybody can see everything. We need one dashboard which shows information about the whole project.
+
+**Solution:** Create one project. Assign all users on the created project. View all types of test cases (UI, API, Unit and so on) on this project. Divide executions by custom filters. Create a dashboard with a widget based on filters.
+
+**Pros:** You have a dashboard that can combine all results needed for your team. You need to configure only one project.
+
+**Cons:** All team members can see all results, you can not configure permissions rules.
+
+## Use Case 2
+
+**Situation:** We have a big team with a difficult permission structure and nested streams. Only persons with granted permissions can see results of a certain stream.
+
+**Solution:** Create separate projects for different streams. Assign users to appropriate projects. Create a dashboard with a widget based on filters for each project.
+
+**Pros:** Security, only users with granted permission will have access to the data.
+
+**Cons:** You can not see a single dashboard for several dashboards.

docs/admin-panel/AllUsersPage.mdx

@@ -26,15 +26,20 @@ ReportPortal allows to create a new user account on the "All Users" page in the
 
 To add a user on the "All Users" page, perform the following steps:
 
-1. Login into ReportPortal instance as Administrator.
+1. Login into ReportPortal instance as `Administrator`.
 
-2. Navigate to the "Administrate" section -\> "All users" page.
+2. Navigate to the "Administrate" section -> "All users" page.
 
 3. Click on the "Add User" button.
 
-4. Fill all fields with valid data in the "Add user" form and click on the "Add" button. A new user will be added to
-  the system and assigned to the selected project, and to "Personal Project" with the
-  PROJECT MANAGER project role. Message with authorization data will be sent to the user's email.
+4. Fill all fields with valid data in the "Add user" form and click on the "Add" button.
+
+A new user will be added to the system and assigned to the selected project, and to "Personal Project" with the
+PROJECT MANAGER project role. Message with authorization data will be sent to the user's email.
+
+:::note
+If you do not need a personal project, `ADMINISTRATOR` can delete it. This project will be removed from the instance. But if the user is unassigned from all projects in the system, and he/she will log in to the ReportPortal after that - the deleted personal project will be created once more time.
+:::
 
 <MediaViewer src="https://youtu.be/LBLeaIbYIKc" alt="Add User From All Users Page in our test report dashboard" type="video" />
 
@@ -45,11 +50,15 @@ from. "Project role" is disabled, if Administrator has been selected in the
 Administrator, the Administrator has full privileges on the project.
 :::
 
+:::important
+Please, do not forget to review project roles on regular basis. We recommend to do it at least quarterly.
+:::
+
 ## Invite user on the "All Users" page
 
 To invite a user on the "All Users" page, perform the following steps:
 
-1. Login into ReportPortal instance as Administrator.
+1. Login into ReportPortal instance as `Administrator`.
 
 2. Navigate to the "Administrate" section -\> "All users" page.
 
@@ -74,9 +83,9 @@ and to "Personal Project" with the PROJECT MANAGER project role.
 To assign user on the "All Users" page, perform the following
 steps:
 
-1. Login into ReportPortal instance as Administrator.
+1. Login into ReportPortal instance as `Administrator`.
 
-2. Navigate to the "Administrate" section -\> "All Users" page.
+2. Navigate to the "Administrate" section -> "All Users" page.
 
 3. Find a user and their projects in the "Projects and roles" column.
 
@@ -94,7 +103,7 @@ steps:
 
 To unassign a user from the project, perform the following steps:
 
-1. Navigate to the "Administrate" section -\> "All Users" page.
+1. Navigate to the "Administrate" section -> "All Users" page.
 
 2. Find a user and their project in the "Projects and roles" column.
 
@@ -106,12 +115,16 @@ To unassign a user from the project, perform the following steps:
 
 <MediaViewer src="https://youtu.be/AMETdsGPg1g" alt="Assign and Unassign User From All Users page" type="video" />
 
+:::note
+Users can not be unassigned from their own personal projects.
+:::
+
 ## Edit user's project role
 
 To edit a user project role on the "All Users" page, perform the following
 steps:
 
-1. Login into ReportPortal instance as Administrator.
+1. Login into ReportPortal instance as `Administrator`.
 
 2. Navigate to the "Administrate" section -\> "All Users" page.
 
@@ -129,9 +142,9 @@ steps:
 
 To delete a user from ReportPortal, perform the following steps:
 
-1. Login into ReportPortal instance as Administrator.
+1. Login into ReportPortal instance as `Administrator`.
 
-2. Navigate to the "Administrate" section -\> "All Users" page.
+2. Navigate to the "Administrate" section -> "All Users" page.
 
 3. Select a user and click the "Delete" button.
 
@@ -150,9 +163,9 @@ The only space in ReportPortal where user can get the Administrator rights is Al
 
 To give Administrator role for any user, perform the following steps:
 
-1. Login into the ReportPortal instance as Administrator.
+1. Login into the ReportPortal instance as `Administrator`.
 
-2. Navigate to the "Administrate" section -\> "All Users" page.
+2. Navigate to the "Administrate" section -> "All Users" page.
 
 3. Hover over user's name. - "Make admin" button will be displayed.
 
@@ -167,9 +180,9 @@ To give Administrator role for any user, perform the following steps:
 
 To take away Administrator account role, perform the following steps:
 
-1. Login into ReportPortal instance as Administrator.
+1. Login into ReportPortal instance as `Administrator`.
 
-2. Navigate to the "Administrate" section -\> "All Users" page.
+2. Navigate to the "Administrate" section -> "All Users" page.
 
 3. Click on the "Admin" button near the user's name.
 

docs/admin-panel/EventMonitoring.mdx

@@ -9,7 +9,7 @@ Starting from version 23.2, ReportPortal can monitor all activities (events) at
 
 ## Project level event monitoring
 
-To view the list of all activities within your project, open the menu at the bottom of the page as an Administrator and select the "Administrate" option. All existing projects are listed on the "All Projects" page. Click on the ellipsis button next to the project and choose the "Monitoring" option from the dropdown.
+To view the list of all activities within your project, open the menu at the bottom of the page as an `Administrator` and select the "Administrate" option. All existing projects are listed on the "All Projects" page. Click on the ellipsis button next to the project and choose the "Monitoring" option from the dropdown.
 
 Here, you will find a table with the following columns: Time, User, Action, Object Type, Object Name, Old Value, and New Value.