diff --git a/docs/admin-panel/AllProjectsPage.mdx b/docs/admin-panel/AllProjectsPage.mdx index 89ec5f4d40..f70739a48d 100644 --- a/docs/admin-panel/AllProjectsPage.mdx +++ b/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. diff --git a/docs/admin-panel/AllUsersPage.mdx b/docs/admin-panel/AllUsersPage.mdx index b77fa3e731..15eb20f81c 100644 --- a/docs/admin-panel/AllUsersPage.mdx +++ b/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. +::: @@ -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: +:::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. diff --git a/docs/admin-panel/EventMonitoring.mdx b/docs/admin-panel/EventMonitoring.mdx index 4c10a914af..b2bfe0b449 100644 --- a/docs/admin-panel/EventMonitoring.mdx +++ b/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. diff --git a/docs/configuration/CreationOfProjectAndAddingUsers.md b/docs/configuration/CreationOfProjectAndAddingUsers.md deleted file mode 100644 index 99343f8143..0000000000 --- a/docs/configuration/CreationOfProjectAndAddingUsers.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -sidebar_position: 2 -sidebar_label: Creation of project and adding users ---- - -# Creation of project and adding users - -The main question of how you can organize your working space in ReportPortal. -Let's see two use cases which can help you to make a decision. - -**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. - -If you choose a strategy, it is time to create your first project. - -**Permission:** -Via "Administrate" section `ADMINISTRATOR` can create, configure, delete projects and add/invite/assign/unassign users on/to the projects. - -## Create a project - -To create a project for a team: -* Login to the ReportPortal as an ADMIN user -* Open menu at the bottom. -* Click the 'Administrate' link -* Select 'Projects' from the left-hand sidebar -* Click the 'Add New Project' button in the right top corner -* Then enter a name of the project -* 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 [ProjectConfiguration](/configuration/ProjectConfiguration) section. - -To know more about the project's management, go to "Administrate" section > "All Projects" page. - -You have a project, now add your team members to it. You can create a new user and send credentials for them - **Add user** or you can send them an invite link - **Invite user**. - -## Add users to project - -**Permission:** -Via "Administrate" section, only `ADMINISTRATOR` can add users. - -To add a user, perform the following steps: - -1. Login into ReportPortal instance as Administrator. -2. Navigate to the "Administrate" section -\> "All users" page. -3. Click "Add User" button. -4. Fill all fields with valid data in the "Add user" form and click on the "Add" button. - -```javascript -'login': -'Full Name': -'Email': -'Account role': USER (by default) -'Project Role': MEMBER (by default) -'Password': could be entered manually (at least 6 symbols required) or generated via the link under the field. -``` - -Example of user creation: - -```javascript -Enter the user's login: Demo -Enter the user's full name: Demo user -Enter the user's email: demo_user@example.com -'Account role': USER (by default) -'Project Role': MEMBER (by default) -Add password: 1q2w3e -``` - -:::note -This is the only place in the system where an Administrator can be created -from. "Project role" is disabled, if "Administrator" value has been selected in the "Account role" field. The "ProjectRole" parameter is not specified for -Administrator, the Administrator has full privileges on the project. -::: -Submit the form. - -A confirmation message in the status bar should appear. - -The notification email letter is sent to the email address of the new user. - -:::note -Please, do not forget to review project roles on regular basis. We recommend to do it at least quarterly. -::: -By default, the system creates a personal project for new users. All new users which have been added to the ReportPortal will have a personal project along with the project where they have been assigned on. The user will be assigned to "Personal Project" with the `PROJECT MANAGER` project role. - -:::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. -::: -If you wish to know more about adding user options, go to "Administrate" section > "All Users" page. - -## Invite a user to a project -**Permission:** -Via Administrate section, only `ADMINISTRATOR` can invite users. -Via Project Space, `ADMINISTRATOR` and `PROJECT MANAGER` can invite users. - -To invite a user on the "All Users" page, perform the following steps: - -1. Login into ReportPortal instance as Administrator. -2. Navigate to the "Administrate" section -\> "All users" page. -3. Click on the "Invite User" button. -4. Fill all fields with valid data in the "Invite user" form and click on the "Invite" button. - The invitation - has been sent. You can copy the link to the invitation from the "Link to - invitation" field. -5. The user will receive an email with the link to the invitation. Registration - link will be active until the user registers in the system by this reference, - but not more than 24 hours. When the user clicks the link, he/she will see a registration form. -6. The user needs to fill in the registration form and click the "Register" button to complete the registration. - The user will be assigned to the project that was specified by you during the invitation, - and to "Personal Project" with the `PROJECT MANAGER` project role. - -## Assign user to the project - -**Permission:** -Via "Administrate" section, only `ADMINISTRATOR` can assign users. -Via Project Space `ADMINISTRATOR` and `PROJECT MANAGER` can assign users. - -Perform the following steps: - -1. Login into ReportPortal instance as Administrator. -2. Navigate to the "Administrate" section -\> "All Users" page. -3. Find a user and click "+ Assign to project" button. -4. Fill the name of project. -5. Select a project role. -6. Click on the "Tick" button. - The user will be assigned to the project. - -## Edit project role - -**Permission:** -Via "Administrate" section, only `ADMINISTRATOR` can edit the project role. -Via Project Space `ADMINISTRATOR` and `PROJECT MANAGER` can edit the project role. - -To edit the project role, perform the following steps: - -1. Login into ReportPortal instance as Administrator. -2. Navigate to the "Administrate" section -\> "All Users" page. -3. Find a user and their project in the "Projects and roles" column. -4. Click on the name of project. -5. Select a new value from the "Project Role" drop-down. -6. Click on the "Tick" icon. - -## Unassign user from the project - -**Permission:** -Via "Administrate" section, only `ADMINISTRATOR` can unassign users. -Via Project Space `ADMINISTRATOR` and `PROJECT MANAGER` can unassign users. - -:::note -Please, do not forget to review project roles on regular basis. We recommend to do it at least quarterly. -::: -Depending on the project needs the assignment could be removed. -To unassign the assignment for the user on the project, perform the following steps: - -1. Navigate to the "Administrate" section -\> "All Users" page. -2. Find a user and their project in the "Projects and roles" column. -3. Click on the name of project. -4. Click on "Cross" icon near the needed project. -5. Confirm the action. - The user will be unassigned from the current project but will stay in the system. - -:::note -Users can not be unassign from their own personal projects. -::: diff --git a/docs/configuration/IntegrationViaPlugin.mdx b/docs/configuration/IntegrationViaPlugin.mdx index fffb7c2f36..fc8e0b6342 100644 --- a/docs/configuration/IntegrationViaPlugin.mdx +++ b/docs/configuration/IntegrationViaPlugin.mdx @@ -6,8 +6,8 @@ sidebar_label: Integration via plugin # Integration via plugin Users can enhance ReportPortal by adding additional integrations with: -* [Atlassian Jira Server](/plugins/AtlassianJiraServer) -* [Atlassian Jira Cloud](/plugins/AtlassianJiraCloud) +* [Jira Server](/plugins/AtlassianJiraServer) +* [Jira Cloud](/plugins/AtlassianJiraCloud) * [Rally](/plugins/Rally) * [Azure DevOps](/plugins/AzureDevOps) * [GitLab](/plugins/GitLab) @@ -20,13 +20,13 @@ Users can enhance ReportPortal by adding additional integrations with: -If you're keen on incorporating ReportPortal with other external systems, and can't find the necessary tab in the Project Settings, please refer to the Plugins section in our documentation for guidance. Our test reporting tool integrates seamlessly, allowing for a streamlined connection with external systems. +If you're keen on incorporating ReportPortal with other external systems, and can't find the necessary tab in the Project Settings, please refer to the [Plugins section](/plugins/) in our documentation for guidance. Our test reporting tool integrates seamlessly, allowing for a streamlined connection with external systems. -The integrations can be added at a global level, applicable for all projects on an instance, in the Administrate section. Alternatively, they can be specific to a project and can be configured in the Project Settings. +The integrations can be added at a global level, applicable for all projects on an instance, in the "Administrate" section. Alternatively, they can be specific to a project and can be configured in the Project Settings. For those who require a different configuration to other projects, or want to integrate only their specific project with an external system, the following steps could be followed: -1. Log into ReportPortal as a PROJECT MANAGER or ADMINISTRATOR +1. Log into ReportPortal as a `PROJECT MANAGER` or `ADMINISTRATOR` 2. Navigate to Project settings > Integrations diff --git a/docs/configuration/ProjectConfiguration.mdx b/docs/configuration/ProjectSettings.mdx similarity index 73% rename from docs/configuration/ProjectConfiguration.mdx rename to docs/configuration/ProjectSettings.mdx index 5a672de9ec..a230f78c6c 100644 --- a/docs/configuration/ProjectConfiguration.mdx +++ b/docs/configuration/ProjectSettings.mdx @@ -1,16 +1,16 @@ --- sidebar_position: 3 -sidebar_label: Project configuration +sidebar_label: Project settings --- -# Project configuration +# Project settings To see the list of available projects and open a project, click the drop-down list in the top of the left menu. ReportPortal supports customization of the default settings. **Permission:** -Users with the Administrator role can edit project settings on the project "Settings" page in Administrate section and on the Project space. +Users with the `Administrator` role can edit project settings on the project "Settings" page in Administrate section and on the Project space. Users with the `PROJECT_MANAGER` role can edit the settings on the project space only. `MEMBER`/ `OPERATOR`/ `CUSTOMER` can only view applied project settings. @@ -166,79 +166,3 @@ The generated data could demonstrate how the launches, filter, and dashboard wil modified or removed without any effect of your real objects. - -## Management of users on the project - -On the "Project Members" page users with the appropriate roles can invite new members. - -Permissions: - -User with `ADMINISTRATOR` role and users with project role `PROJECT_MANAGER`. - -### Invite user on a project - -To invite a user on the "Project Members" page, perform the following steps: - -1. Login into ReportPortal instance as with the PROJECT_MANAGER project role. -2. Navigate to the "Project Members" page on the left menu. -3. Click the "Invite User" tab. -4. Enter the email address of the user in case he/she is not present in the ReportPortal database or enter his/her login name. -5. In case the user is already available in the ReportPortal, his/her name will appear in the suggestion list. -If not, the Admin should enter the correct email address. -6. Select an appropriate role. -7. Then click 'Invite'. -8. In case the user is already available in ReportPortal s/he will be assigned to the project -If not, the letter with an invitation link will be sent to the user email address. -9. The user will receive an email with the link to the registration. -When the user clicks the link, he/she will see a registration form. -10. The user needs to fill in the registration form and click the "Register" -button to complete the registration. -11. The user will be assigned to the project that the invitation was sent from, and to "Personal Project" with the PROJECT - MANAGER project role. - - - -### Project role - -Every user is given a specific Project role within a specific project. - -Depends on the role, the user is able or not able to perform some actions. For more details, please see the "Permissions map". - -There are 4 possible Project roles in ReportPortal: - -- `PROJECT MANAGER` -- `MEMBER` -- `OPERATOR` -- `CUSTOMER` - -:::note -The `ADMINISTRATOR` has all privileges on the project. -::: - -### Edit project role - -To edit the project role, perform the following steps: - -1. Login into the ReportPortal as a user with `PROJECT_MANAGER` project role. -2. Navigate to the "Project Members" page on the left menu. -3. Select a new value from the "Project Role" drop-down for the user. - The new project role will be automatically saved. - - - -### Unassign user from the project - -Depending on the project needs the assignment could be removed. -To unassign the assignment for the user on the project, perform the following steps: - -1. Login into the ReportPortal as a user with `PROJECT_MANAGER` project role. -2. Navigate to the "Project Members" page on the left menu. -3. Find the required member. -4. Click the 'Unassign' button for the user. -5. Confirm the action in the popup. -6. The user will be unassigned from the current project but will stay in the system. - - -:::note -Invite user, Assign/Unassign internal user to/from the project, change user's role on a project action can be done for a user -with a similar and lower role only. -::: diff --git a/docs/configuration/UserManagement.mdx b/docs/configuration/UserManagement.mdx new file mode 100644 index 0000000000..6957addb78 --- /dev/null +++ b/docs/configuration/UserManagement.mdx @@ -0,0 +1,83 @@ +--- +sidebar_position: 3 +sidebar_label: User management +--- + +# User management + +After [you have created a project](/admin-panel/AllProjectsPage#create-projects), you can invite new members to it. + +**Permissions:**
+User with `ADMINISTRATOR` role and users with project role `PROJECT_MANAGER`. + +### Invite user on a project + +To invite a user on the "Project Members" page, perform the following steps: + +1. Login into ReportPortal instance as with the `PROJECT_MANAGER` project role. +2. Navigate to the "Project Members" page on the left menu. +3. Click the "Invite User" tab. +4. Enter the email address of the user in case he/she is not present in the ReportPortal database or enter his/her login name. +5. In case the user is already available in the ReportPortal, his/her name will appear in the suggestion list. +If not, the Admin should enter the correct email address. +6. Select an appropriate role. +7. Then click 'Invite'. +8. In case the user is already available in ReportPortal s/he will be assigned to the project +If not, the letter with an invitation link will be sent to the user email address. +9. The user will receive an email with the link to the registration. +When the user clicks the link, he/she will see a registration form. +10. The user needs to fill in the registration form and click the "Register" +button to complete the registration. +11. The user will be assigned to the project that the invitation was sent from, and to "Personal Project" with the PROJECT + MANAGER project role. + + + +### Project role + +Every user is given a specific Project role within a specific project. + +Depends on the role, the user is able or not able to perform some actions. For more details, please see the "Permissions map". + +There are 4 possible Project roles in ReportPortal: + +- `PROJECT MANAGER` +- `MEMBER` +- `OPERATOR` +- `CUSTOMER` + +:::note +The `ADMINISTRATOR` has all privileges on the project. +::: + +### Edit project role + +To edit the project role, perform the following steps: + +1. Login into the ReportPortal as a user with `PROJECT_MANAGER` project role. +2. Navigate to the "Project Members" page on the left menu. +3. Select a new value from the "Project Role" drop-down for the user. - The new project role will be automatically saved. + + + +### Unassign user from the project + +Depending on the project needs the assignment could be removed. +To unassign the assignment for the user on the project, perform the following steps: + +1. Login into the ReportPortal as a user with `PROJECT_MANAGER` project role. +2. Navigate to the "Project Members" page on the left menu. +3. Find the required member. +4. Click the 'Unassign' button for the user. +5. Confirm the action in the popup. +6. The user will be unassigned from the current project but will stay in the system. + + +:::note +Invite user, Assign/Unassign internal user to/from the project, change user's role on a project action can be done for a user +with a similar and lower role only. +::: + +:::important +Administrator can also [add users to the project](/admin-panel/AllUsersPage). +::: diff --git a/docs/configuration/img/Integrations.png b/docs/configuration/img/Integrations.png index 1730544bb2..72d003557e 100644 Binary files a/docs/configuration/img/Integrations.png and b/docs/configuration/img/Integrations.png differ diff --git a/docs/tutorial/index.mdx b/docs/tutorial/index.mdx index 9db73f14ed..66c726592d 100644 --- a/docs/tutorial/index.mdx +++ b/docs/tutorial/index.mdx @@ -42,7 +42,7 @@ Finally, you logged into ReportPortal. And you see just empty tabs... Looks conf Let’s start by inviting your team members. You can also do it as a final step, but it would be nice to investigate ReportPortal together. -In order to add other users to ReportPortal you can send invitations via email. To make sure that the Email service is configured, please follow the next steps (as an admin user): [E-mail server configuration](/plugins/EmailServer). Once emailing is configured, you can either [invite new users](/configuration/CreationOfProjectAndAddingUsers#invite-a-user-to-a-project) or [create a new user](/configuration/CreationOfProjectAndAddingUsers#add-users-to-project) in the project. +In order to add other users to ReportPortal you can send invitations via email. To make sure that the Email service is configured, please follow the next steps (as an admin user): [E-mail server configuration](/plugins/EmailServer). Once emailing is configured, you can either [invite new users](/admin-panel/AllUsersPage#invite-user-on-the-all-users-page) or [create a new user](/admin-panel/AllUsersPage#add-user) in the project. After this step you will have emailing capabilities enabled, and several more users invited to ReportPortal. @@ -52,7 +52,7 @@ After this step you will have emailing capabilities enabled, and several more us The main section for work with ReportPortal is Launches tab in the left menu. But Launches table is empty and it’s hard to understand what ReportPortal can do and what to do next. -[Generate demo data](/configuration/ProjectConfiguration#demo-data) feature can help you with this, by generating a set of demo launches (test executions), filters and dashboards. +[Generate demo data](/configuration/ProjectSettings#demo-data) feature can help you with this, by generating a set of demo launches (test executions), filters and dashboards. diff --git a/docs/user-role-guides/index.md b/docs/user-role-guides/index.md index b32e4e54cb..d0927acb91 100644 --- a/docs/user-role-guides/index.md +++ b/docs/user-role-guides/index.md @@ -40,7 +40,7 @@ Here are the links to User Guide sections divided by ReportPortal User roles. [Saved searches (Filters)](/saved-searches-filters) [Dashboards and Widgets](/dashboards-and-widgets) [User account](/user-account) -[See list of project members](/configuration/ProjectConfiguration#management-of-users-on-the-project) +[See list of project members](/configuration/UserManagement) ## Customer [Work with reports](/work-with-reports) diff --git a/docusaurus.config.js b/docusaurus.config.js index 9afa5af918..bcfebaaf46 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -568,14 +568,18 @@ const config = { to: '/plugins/authorization/SamlProviders/Overview', from: '/reportportal-configuration/authorization/SamlProviders/Overview', }, - { - to: '/configuration/CreationOfProjectAndAddingUsers', - from: ['/reportportal-configuration/CreationOfProjectAndAddingUsers', '/reportportal-configuration/ProjectConfiguration'], - }, { to: '/configuration/IntegrationViaPlugin', from: '/reportportal-configuration/IntegrationViaPlugin', }, + { + to: '/configuration/ProjectSettings', + from: '/configuration/ProjectConfiguration', + }, + { + to: '/admin-panel/AllProjectsPage', + from: '/configuration/CreationOfProjectAndAddingUsers', + }, ], }, ],