Skip to content
Open
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
4 changes: 2 additions & 2 deletions docs/FAQ/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ ReportPortal is containerized and can be orchestrated using either docker-compos

#### 5. Is there any training available to use ReportPortal effectively?

Check our [Tutorial](/tutorial/) and read [blog post](https://reportportal.io/blog/Tips-to-get-ReportPortal-benefits) with tips to get ReportPortal benefits. We also recommend investigate [our documentation](https://reportportal.io/docs/) where you can find screenshots and video instructions on ReportPortal functionality.
Check our [Tutorial](/tutorial/) and read [blog post](https://reportportal.io/blog/Tips-to-get-ReportPortal-benefits) with tips to get ReportPortal benefits. We also recommend investigating [our documentation](https://reportportal.io/docs/) where you can find screenshots and video instructions on ReportPortal functionality.

#### 6. Is there a demo available?

Expand Down Expand Up @@ -164,7 +164,7 @@ ReportPortal has defined application limits to maintain stable performance and c
- **User avatars:**
- Accepted formats: **JPEG, PNG, GIF**
- Maximum size: **1 MB**
- Maximum dimensions: **300×500 px**
- Maximum dimensions: **300x500 px**
- **RabbitMQ message size:** infrastructure-dependent; it’s recommended to keep log payloads reasonably sized, as very large logs may be rejected to process.

**5. API Behavior & Miscellaneous**
Expand Down
10 changes: 5 additions & 5 deletions docs/admin-panel/AllProjectsPage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ All Projects page allows:

To create a project:

1. Login into the ReportPortal instance as an `Administrator`.
1. Log in to 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.
Expand Down Expand Up @@ -94,7 +94,7 @@ Depending on the toggle state in [Server Settings](/admin-panel/ServerSettings),

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. Log in to the ReportPortal instance as an `Administrator`.

2. Navigate to the "Administrate" section -> "All Projects" page

Expand Down Expand Up @@ -133,7 +133,7 @@ but not exceeding 24 hours.

## Detailed project info

1. Login into ReportPortal instance as `Administrator`.
1. Log in to ReportPortal instance as `Administrator`.

2. Navigate to the "Administrate" section -\> "All Projects" page.

Expand All @@ -148,7 +148,7 @@ but not exceeding 24 hours.

To delete a project, perform the following steps:

1. Login into ReportPortal instance as `Administrator`.
1. Log in to ReportPortal instance as `Administrator`.

2. Navigate to the "Administrate" section -> "All Projects" page.

Expand Down Expand Up @@ -181,4 +181,4 @@ PERSONAL PROJECTS cannot be deleted from the system.

**Pros:** Security, only users with granted permission will have access to the data.

**Cons:** You can not see a single dashboard for several dashboards.
**Cons:** You cannot view a single dashboard aggregating data from multiple projects.
28 changes: 14 additions & 14 deletions docs/admin-panel/AllUsersPage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Depending on the toggle state in [Server Settings](/admin-panel/ServerSettings),

To add a user on the "All Users" page, perform the following steps:

1. Login into ReportPortal instance as `Administrator`.
1. Log in to ReportPortal instance as `Administrator`.

2. Navigate to the "Administrate" section -> "All users" page.

Expand All @@ -43,7 +43,7 @@ A new user will be added to the system and assigned to the selected project, and
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.
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.
:::

<MediaViewer src="https://youtu.be/LBLeaIbYIKc" alt="Add User From All Users Page in our test report dashboard" type="video" />
Expand All @@ -67,7 +67,7 @@ Depending on the toggle state in [Server Settings](/admin-panel/ServerSettings),

To invite a user on the "All Users" page, perform the following steps:

1. Login into ReportPortal instance as `Administrator`.
1. Log in to ReportPortal instance as `Administrator`.

2. Navigate to the "Administrate" section -\> "All users" page.

Expand All @@ -87,12 +87,12 @@ and to "Personal Project" with the PROJECT MANAGER project role.

<MediaViewer src="https://youtu.be/228C6lLEpDE" alt="Invite User From All Users page" type="video" />

## Assign user on project
## Assign user to project

To assign user on the "All Users" page, perform the following
To assign a user to the project on the "All Users" page, perform the following
steps:

1. Login into ReportPortal instance as `Administrator`.
1. Log in to ReportPortal instance as `Administrator`.

2. Navigate to the "Administrate" section -> "All Users" page.

Expand Down Expand Up @@ -122,7 +122,7 @@ To unassign a user from the project, perform the following steps:

5. Confirm the action. - The user will be unassigned from the project.

<MediaViewer src="https://youtu.be/AMETdsGPg1g" alt="Assign and Unassign User From All Users page" type="video" />
<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.
Expand All @@ -133,7 +133,7 @@ Users can not be unassigned from their own personal projects.
To edit a user project role on the "All Users" page, perform the following
steps:

1. Login into ReportPortal instance as `Administrator`.
1. Log in to ReportPortal instance as `Administrator`.

2. Navigate to the "Administrate" section -\> "All Users" page.

Expand All @@ -151,7 +151,7 @@ steps:

To delete a user from ReportPortal, perform the following steps:

1. Login into ReportPortal instance as `Administrator`.
1. Log in to ReportPortal instance as `Administrator`.

2. Navigate to the "Administrate" section -> "All Users" page.

Expand All @@ -171,7 +171,7 @@ 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. Log in to the ReportPortal instance as `Administrator`.

2. Navigate to the "Administrate" section -> "All Users" page.

Expand All @@ -184,11 +184,11 @@ To give Administrator role for any user, perform the following steps:

<MediaViewer src="https://youtu.be/ZkACZLc1wAk" alt="Change Account Role to Administrator" type="video" />

**Take away ADMINISTRATOR role**
**Revoke ADMINISTRATOR role**

To take away Administrator account role, perform the following steps:
To revoke Administrator account role, perform the following steps:

1. Login into ReportPortal instance as `Administrator`.
1. Log in to ReportPortal instance as `Administrator`.

2. Navigate to the "Administrate" section -> "All Users" page.

Expand All @@ -199,4 +199,4 @@ To take away Administrator account role, perform the following steps:
5. Click "Change" button. Account role "Administrator" will be changed to
"User".

<MediaViewer src="https://youtu.be/pJbbmuXK2ZQ" alt="Take away Administrator role" type="video" />
<MediaViewer src="https://youtu.be/pJbbmuXK2ZQ" alt="Revoke Administrator role" type="video" />
10 changes: 5 additions & 5 deletions docs/admin-panel/ServerSettings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ To enable [GitHub authorization](/plugins/authorization/GitHub/):

1. Log in as ADMIN.
2. Go to Administrate > Server Settings.
3. Switch ON the "GitHub authorisation" toggle.
3. Switch ON the "GitHub authorization" toggle.
4. Fill in required [parameters for authorization](/plugins/authorization/GitHub#reportportal-configuration).
5. Click "Submit".

Expand Down Expand Up @@ -103,14 +103,14 @@ When toggle is ON, manual invitation of external is disabled:

<MediaViewer src={require('./img/server-settings/ServerSettings6.png')} alt="Project Members page when toggle is ON" />

To assign user on the project:
To assign a user to the project:

1. Log in as Project Manager or ADMIN.
2. Go to the "Project Members" page.
3. Click the "Assign User" button.
4. Start type the name > suggestions will be provided in the dropdown.

<MediaViewer src={require('./img/server-settings/ServerSettings7.png')} alt="Assign user on the project on the Project Members page" />
<MediaViewer src={require('./img/server-settings/ServerSettings7.png')} alt="Assign user to the project on the Project Members page" />

or

Expand All @@ -121,7 +121,7 @@ or
5. Click on the "Assign User" button.
6. Start type the name > suggestions will be provided in the dropdown.

<MediaViewer src={require('./img/server-settings/ServerSettings8.png')} alt="Assign user on the project on the Members page" />
<MediaViewer src={require('./img/server-settings/ServerSettings8.png')} alt="Assign user to the project on the Members page" />

## Features

Expand Down Expand Up @@ -208,7 +208,7 @@ To **change the links order**:

<MediaViewer src={require('./img/server-settings/FooterLinks4.png')} alt="Change footer links order" />

All added/updated links immediately displayed across all application pages after saving changes.
All added/updated links are immediately displayed across all application pages after saving changes.

:::note
Footer links visibly differ on Project Settings Page compared to other pages.
Expand Down
10 changes: 5 additions & 5 deletions docs/analysis/AutoAnalysisOfLaunches.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The Analyzer preprocesses log messages from the request for test failure analysi
Each log entry along with its defect type is saved to OpenSearch in the form of a separate document. All documents created compose an Index. The more test results index has, the more accurate results will be generated by the end of the analysis process.

:::tip
If you do not sure how many documents(logs) are contained in the Index at that moment, you can check it.
If you are not sure how many documents(logs) are contained in the Index at that moment, you can check it.
For that, perform the following actions:
* Uncommented Service OpenSearch ports in a docker-compose file or add them: 9200:9200;
* Restart-Service OpenSearch with new docker-compose;
Expand Down Expand Up @@ -159,7 +159,7 @@ So this is how Auto-Analysis works and defines the most relevant defect type on

All settings and configurations of Analyzer and OpenSearch are situated on a separate tab on Project settings.

1. Login into ReportPortal instance as Administrator or project member with PROJECT MANAGER role on the project;
1. Log in to ReportPortal instance as Administrator or project member with PROJECT MANAGER role on the project;

2. Come on Project Settings, choose Auto-Analysis section;

Expand All @@ -179,7 +179,7 @@ In this section user can perform the following actions:

To activate the "Auto-Analysis" functionality in a project, perform the following steps:

1. Login ReportPortal instance as Administrator or project member with PROJECT MANAGER role on the project.
1. Log in to the ReportPortal instance as Administrator or project member with PROJECT MANAGER role on the project.

2. Select ON in the "Auto-Analysis" selector on the Project settings / Auto-analysis section.

Expand Down Expand Up @@ -269,7 +269,7 @@ Your investigations in ReportPortal will not be changed. The operation concerns

Another option, you can **generate the Index in OpenSearch**. In the case of generation, all data will be removed from OpenSearch and the new one will be generated based on all previous investigations on the project following current analysis settings.

At the end of the process, you will receive a letter with info about the end of the process and with several items that will be appeared in OpenSearch.
At the end of the process, you will receive a letter with info about the end of the process and with several items that will appear in OpenSearch.

You can use index generation for several goals. For example, assume two hypothetical situations when index generation can be used:

Expand Down Expand Up @@ -317,7 +317,7 @@ In case the user chooses **Items analyzed automatically (by AA)** - the system i

In case the user chooses **Items analyzed manually** - the system is analyzing only items that have been already analyzed by the user manually. The results of the previous run of analysis will be set to zero and items will be analyzed once again.

In the case of multi-combination - the system is analyzing results dependence on chosen options.
In the case of multi-combination - the system is analyzing results depending on chosen options.

:::note
The Ignore flag is saved. If the item has flag **Ignore in AA**, it will not be re-analyzed.
Expand Down
2 changes: 1 addition & 1 deletion docs/analysis/ImmediatePatternAnalysis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The “system” parameter determines whether the “immediatePatternAnalysis”

<MediaViewer src={require('./img/ImmediatePA2.png')} alt="immediatePatternAnalysis attribute with system parameter set to false" />

You can provide this attribute at the start of the step or at the finish. You can also set one value at the start and another at the finish, in which case the last value will take.
You can provide this attribute at the start of the step or at the finish. You can also set one value at the start and another at the finish, in which case the last value will take effect.

:::note
Immediate PA will work in any case if this attribute is present, regardless Auto Pattern Analysis is enabled or disabled. In this case, Auto Pattern Analysis and Manual Pattern Analysis on Launch finish will skip previously analyzed items by Immediate Pattern Analysis.
Expand Down
4 changes: 2 additions & 2 deletions docs/analysis/MLSuggestions.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This analysis hints what are the most similar analyzed items to the current test

ML Suggestions searches for similar previously analyzed items to the current test item, so it requires an analytical base saved in OpenSearch. ML suggestions takes into account all user-investigated, auto-analyzed items or items chosen from ML suggestions. While the analytical base is growing ML suggestions functionality will have more examples to search by and suggest you the best options.

ML suggestions analysis is run everytime you enter "Make decision" editor. ML suggestions are run for all test items no matter what defect type they have now. This functionality is processing only test items with logs (log level >= 40000).
ML suggestions analysis is run every time you enter "Make decision" editor. ML suggestions are run for all test items no matter what defect type they currently have. This functionality is processing only test items with logs (log level >= 40000).

The request for the suggestions part looks like this:
* testItemId;
Expand All @@ -44,7 +44,7 @@ The OpenSearch returns to the service Analyzer 10 logs with the highest score fo
* cosine similarity between vectors, representing error message/stacktrace/the whole message/urls/paths and other text fields
* the probability for being of a specific defect type given by the Random Forest Classifier trained on Tf-Idf vectors

The model gives a probability for each candidate, we filter out test items with the probability less or equal 40%. We sort the test items by this probability, after that we deduplicate test items inside this ranked list. If two test items are similar with >= 98% by their messages, then we will leave the test item with the highest probability. After deduplication we take maximimum 5 items with the highest score to show in the ML Suggestions section.
The model gives a probability for each candidate, we filter out test items with the probability less or equal 40%. We sort the test items by this probability, after that we deduplicate test items inside this ranked list. If two test items are similar with >= 98% by their messages, then we will leave the test item with the highest probability. After deduplication we take maximum 5 items with the highest score to show in the ML Suggestions section.

ML suggestions section contains at maximum 5 suggested items, they are shown together with the scores given by the model and we divide them into 3 groups:
* the group "SAME", test items with the score = 100%
Expand Down
2 changes: 1 addition & 1 deletion docs/analysis/ManualAnalysis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The “Make decision” modal can be opened in three ways:

## “Execution to change” section

**“Execution to change”** section is displayed at the top left of the “Make decision” modal. It includes Step name, current defect type. Also it can have a log, a comment, a link to a Bug Tracking System (BTS), a label (AA, PA, Ignore AA) if exist. You can expand logs to understand why this step was failed.
**“Execution to change”** section is displayed at the top left of the “Make decision” modal. It includes Step name, current defect type. Also it can have a log, a comment, a link to a Bug Tracking System (BTS), a label (AA, PA, Ignore AA) if exist. You can expand logs to understand why this step failed.

<MediaViewer src={require('./img/ManualAnalysis/MakeDecision4.png')} alt="Make Decision Execution to change section" />

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/ProjectSettings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ ReportPortal allows the use of existing default defect types (Product Bug, Autom

To create custom defect types, perform the following steps:

1. Login into the ReportPortal.
1. Log in to ReportPortal.
2. Navigate to Projects -\> Project "Settings" page.
3. Open "Defect Types" tab
4. Click "Add Defect Type" button under any default defect type
Expand Down
6 changes: 3 additions & 3 deletions docs/configuration/UserManagement.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Depending on the toggle state in [Server Settings](/admin-panel/ServerSettings),

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.
1. Log in to 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.
Expand Down Expand Up @@ -59,7 +59,7 @@ The `ADMINISTRATOR` has all privileges on the project.

To edit the project role, perform the following steps:

1. Login into the ReportPortal as a user with `PROJECT_MANAGER` project role.
1. Log in to 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.

Expand All @@ -70,7 +70,7 @@ To edit the project role, perform the following steps:
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.
1. Log in to 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.
Expand Down
2 changes: 1 addition & 1 deletion docs/dashboards-and-widgets/FlakyTestCasesTableTop50.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For the Flaky Test Cases Table Top 50 widget, only the status of the last retry

- Launches count: 2-100. The default meaning is 30.

- Launch name: required filed.
- Launch name: required field.

- Include Before and After methods: optional.

Expand Down
2 changes: 1 addition & 1 deletion docs/dashboards-and-widgets/LaunchesDurationChart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Tooltip on mouse hover over chart area shows launch details: launch name, number

The Widget has clickable sections when you click on a specified section in a widget, the system forwards you to launch view for appropriate selection.

The Widget has two states: All launches and Latest lunches. If you chose *All launches* mode, the widget will show statistics about all launches in the filter. To view only the latest executions of each launch, you should choose *Latest launches*.
The Widget has two states: All launches and Latest launches. If you chose *All launches* mode, the widget will show statistics about all launches in the filter. To view only the latest executions of each launch, you should choose *Latest launches*.

<MediaViewer src={require('./img/widget-types/LaunchesDurationChart.png')} alt="Dashboard for QA automation: Launches duration chart" />

Expand Down
Loading