diff --git a/docs/FAQ/index.md b/docs/FAQ/index.md index f20c32dafd..a27f4a5433 100644 --- a/docs/FAQ/index.md +++ b/docs/FAQ/index.md @@ -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? @@ -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** diff --git a/docs/admin-panel/AllProjectsPage.mdx b/docs/admin-panel/AllProjectsPage.mdx index 11dd2f2b9b..45481c4588 100644 --- a/docs/admin-panel/AllProjectsPage.mdx +++ b/docs/admin-panel/AllProjectsPage.mdx @@ -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. @@ -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 @@ -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. @@ -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. @@ -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. diff --git a/docs/admin-panel/AllUsersPage.mdx b/docs/admin-panel/AllUsersPage.mdx index 7e303f90d1..ab4929f183 100644 --- a/docs/admin-panel/AllUsersPage.mdx +++ b/docs/admin-panel/AllUsersPage.mdx @@ -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. @@ -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. ::: @@ -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. @@ -87,12 +87,12 @@ and to "Personal Project" with the PROJECT MANAGER project role. -## 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. @@ -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. - + :::note Users can not be unassigned from their own personal projects. @@ -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. @@ -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. @@ -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. @@ -184,11 +184,11 @@ To give Administrator role for any user, perform the following steps: -**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. @@ -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". - + diff --git a/docs/admin-panel/ServerSettings.mdx b/docs/admin-panel/ServerSettings.mdx index e0ac24b068..c403949764 100644 --- a/docs/admin-panel/ServerSettings.mdx +++ b/docs/admin-panel/ServerSettings.mdx @@ -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". @@ -103,14 +103,14 @@ When toggle is ON, manual invitation of external is disabled: -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. - + or @@ -121,7 +121,7 @@ or 5. Click on the "Assign User" button. 6. Start type the name > suggestions will be provided in the dropdown. - + ## Features @@ -208,7 +208,7 @@ To **change the 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. diff --git a/docs/analysis/AutoAnalysisOfLaunches.mdx b/docs/analysis/AutoAnalysisOfLaunches.mdx index 53b3ee0a25..e71120ee55 100644 --- a/docs/analysis/AutoAnalysisOfLaunches.mdx +++ b/docs/analysis/AutoAnalysisOfLaunches.mdx @@ -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; @@ -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; @@ -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. @@ -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: @@ -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. diff --git a/docs/analysis/ImmediatePatternAnalysis.mdx b/docs/analysis/ImmediatePatternAnalysis.mdx index 1238eb7977..271eaabe0d 100644 --- a/docs/analysis/ImmediatePatternAnalysis.mdx +++ b/docs/analysis/ImmediatePatternAnalysis.mdx @@ -28,7 +28,7 @@ The “system” parameter determines whether the “immediatePatternAnalysis” -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. diff --git a/docs/analysis/MLSuggestions.md b/docs/analysis/MLSuggestions.md index a4513596a0..2f456b30eb 100644 --- a/docs/analysis/MLSuggestions.md +++ b/docs/analysis/MLSuggestions.md @@ -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; @@ -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% diff --git a/docs/analysis/ManualAnalysis.mdx b/docs/analysis/ManualAnalysis.mdx index 6631245e9b..2d202b9237 100644 --- a/docs/analysis/ManualAnalysis.mdx +++ b/docs/analysis/ManualAnalysis.mdx @@ -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. diff --git a/docs/configuration/ProjectSettings.mdx b/docs/configuration/ProjectSettings.mdx index 21f6bb2f21..1d714fa0b9 100644 --- a/docs/configuration/ProjectSettings.mdx +++ b/docs/configuration/ProjectSettings.mdx @@ -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 diff --git a/docs/configuration/UserManagement.mdx b/docs/configuration/UserManagement.mdx index 9e6818fdf8..96b79eecbf 100644 --- a/docs/configuration/UserManagement.mdx +++ b/docs/configuration/UserManagement.mdx @@ -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. @@ -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. @@ -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. diff --git a/docs/dashboards-and-widgets/FlakyTestCasesTableTop50.mdx b/docs/dashboards-and-widgets/FlakyTestCasesTableTop50.mdx index 1fc01dc505..7662f15813 100644 --- a/docs/dashboards-and-widgets/FlakyTestCasesTableTop50.mdx +++ b/docs/dashboards-and-widgets/FlakyTestCasesTableTop50.mdx @@ -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. diff --git a/docs/dashboards-and-widgets/LaunchesDurationChart.mdx b/docs/dashboards-and-widgets/LaunchesDurationChart.mdx index aeff210962..02338a26a9 100644 --- a/docs/dashboards-and-widgets/LaunchesDurationChart.mdx +++ b/docs/dashboards-and-widgets/LaunchesDurationChart.mdx @@ -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*. diff --git a/docs/dashboards-and-widgets/WidgetCreation.mdx b/docs/dashboards-and-widgets/WidgetCreation.mdx index b136a102e2..1b02df6b59 100644 --- a/docs/dashboards-and-widgets/WidgetCreation.mdx +++ b/docs/dashboards-and-widgets/WidgetCreation.mdx @@ -59,10 +59,10 @@ There are 15 widget templates in ReportPortal for tracking different KPI: | Compare two launches together | [Different launches comparison chart](/dashboards-and-widgets/DifferentLaunchesComparisonChart) | | Track passing rate for one launch | [Passing rate per launch](/dashboards-and-widgets/PassingRatePerLaunch) | | Track passing rate for the build | [Passing rate summary](/dashboards-and-widgets/PassingRateSummary) | -| Find the most flakiest test in the build | [Flaky test cases table (TOP-50)](/dashboards-and-widgets/FlakyTestCasesTableTop50) | +| Find the flakiest test in the build | [Flaky test cases table (TOP-50)](/dashboards-and-widgets/FlakyTestCasesTableTop50) | | Compare statistics for different builds on one graph | [Cumulative trend chart](/dashboards-and-widgets/CumulativeTrendChart) | | Track the most popular failure reasons in the build | [Most popular pattern table (TOP-20)](/dashboards-and-widgets/MostPopularPatternTableTop20) | | Track the passing rate of different components of your application | [Component health check](/dashboards-and-widgets/ComponentHealthCheck) | | Track the statistics of different components of your application | [Component health check (table)](/dashboards-and-widgets/TableComponentHealthCheck) | | Track the top-20 tests with longest execution time | [Most time-consuming test cases widget (TOP-20)](/dashboards-and-widgets/MostTimeConsumingTestCasesWidgetTop20) | -| Find test case by name and/or attribute through out all launches executions | [Test case search](/dashboards-and-widgets/TestCaseSearch) | +| Find test case by name and/or attribute throughout all launches executions | [Test case search](/dashboards-and-widgets/TestCaseSearch) | diff --git a/docs/developers-guides/APIDifferencesBetweenV4AndV5.md b/docs/developers-guides/APIDifferencesBetweenV4AndV5.md index 5defb09949..556f896af6 100644 --- a/docs/developers-guides/APIDifferencesBetweenV4AndV5.md +++ b/docs/developers-guides/APIDifferencesBetweenV4AndV5.md @@ -24,7 +24,7 @@ DELETE `/v1/{projectName}/dashboard/{dashboardId}/{widgetId}` - Delete specified ### Launch controller :::note -Tags from v4 was replaced by attributes in v5. +Tags from v4 were replaced by attributes in v5. Attribute contains key and value. It may have null key, but non-null value. Attribute with null value is analog for v4 tag. ::: @@ -104,7 +104,7 @@ DELETE `/v1/{projectName}/settings/pattern/{id}` - Delete specified pattern temp ### Test item controller :::note -Tags from v4 was replaced by attributes in v5.
+Tags from v4 were replaced by attributes in v5.
Attribute contains key and value. It may have null key, but non-null value.
Attribute with null value is analog for v4 tag. ::: @@ -115,7 +115,7 @@ GET `/v1/{projectName}/item/attribute/keys/all` - Retrieve all unique attributes GET `/v1/{projectName}/item/attribute/values` - Retrieve all unique attributes values of specified launch. -GET `/v1/{projectName}/item/ticket/ids` - Get tickets that contains a term as a part inside for specified launch. +GET `/v1/{projectName}/item/ticket/ids` - Get tickets that contain a term as a part inside for specified launch. GET `/v1/{projectName}/item/uuid/{itemId}` - Get test item by uuid. diff --git a/docs/developers-guides/ReportingDevelopersGuide.md b/docs/developers-guides/ReportingDevelopersGuide.md index 18d8b12cd2..2f63bb37be 100644 --- a/docs/developers-guides/ReportingDevelopersGuide.md +++ b/docs/developers-guides/ReportingDevelopersGuide.md @@ -92,11 +92,11 @@ Start launch request model contains the following attributes: | name | Yes | Name of launch | - | AutomationRun | | startTime | Yes | Launch start time | - | 2019-11-22T11:47:01+00:00 (ISO 8601); Fri, 22 Nov 2019 11:47:01 +0000 (RFC 822, 1036, 1123, 2822); 2019-11-22T11:47:01+00:00 (RFC 3339); 1574423221000 (Unix Timestamp) | | description | No | Description of launch | empty | Services tests | -| uuid | No | Launch uuid (string identificator) | auto generated(if not present in request) | 69dc75cd-4522-44b9-9015-7685ec0e1abb | +| uuid | No | Launch uuid (string identifier) | auto generated(if not present in request) | 69dc75cd-4522-44b9-9015-7685ec0e1abb | | attributes | No | Launch attributes. Pairs of key and value | empty | build:3.0.1, os:bionic | | mode | No | Launch mode. Allowable values 'default' or 'debug' | default | DEFAULT | | rerun | No | Rerun mode. Allowable values 'true' of 'false' | false | false | -| rerunOf | No | Rerun mode. Specifies launch to be reruned. Uses with 'rerun' attribute. | empty | 694e1549-b8ab-4f20-b7d8-8550c92431b0 | +| rerunOf | No | Rerun mode. Specifies launch to be rerun. Used with 'rerun' attribute. | empty | 694e1549-b8ab-4f20-b7d8-8550c92431b0 | Start launch response contains the following attributes: diff --git a/docs/external-integrations/index.md b/docs/external-integrations/index.md index 28c0352241..3822c11e86 100644 --- a/docs/external-integrations/index.md +++ b/docs/external-integrations/index.md @@ -7,7 +7,7 @@ description: Enhance collaboration with our External Integrations section. Integ The **External Integrations** section of ReportPortal is designed to help you extend the capabilities of your test automation processes and enhance overall efficiency. By integrating external tools and identity management systems, you can streamline workflows, improve data synchronization, and better manage both testing activities and user access. This section provides essential information on how to connect and configure external systems. -Thу integration with **testRigor** enables seamless data synchronization between the two systems, allowing for better test management and more efficient collaboration across teams. By linking ReportPortal with testRigor, you can automatically import test results, track performance, and manage test data in one centralized location. This ensures that your team can focus on improving software quality without the manually handling test information. +The integration with **testRigor** enables seamless data synchronization between the two systems, allowing for better test management and more efficient collaboration across teams. By linking ReportPortal with testRigor, you can automatically import test results, track performance, and manage test data in one centralized location. This ensures that your team can focus on improving software quality without manually handling test information. Beyond test automation, ReportPortal also offers identity and access management integrations, including **user provisioning via SAML and SCIM**, to help teams efficiently manage user provisioning and authentication. diff --git a/docs/installation-steps/DeployOnUbuntuOS.md b/docs/installation-steps/DeployOnUbuntuOS.md index eca411eab5..25ceb93b1c 100644 --- a/docs/installation-steps/DeployOnUbuntuOS.md +++ b/docs/installation-steps/DeployOnUbuntuOS.md @@ -92,11 +92,11 @@ After download is completed and containers started open another terminal and run `docker ps` to check that all containers from previous step are up and running. 9. Check that ReportPortal is running -In the VM opten browser to `0.0.0.0:8080` --> ReportPortal login page will open. +In the VM open browser to `0.0.0.0:8080` --> ReportPortal login page will open. :::note If you are behind a proxy you need to add `0.0.0.0` to the `NO_PROXY` (no_proxy) ENV.
-After setting the port forwarding like explained in video PART 2 (link below) open browser on your host machine to `localhost:8080` or `127.0.0.1:8080` --> ReportPortal loginpage will open +After setting the port forwarding like explained in video PART 2 (link below) open browser on your host machine to `localhost:8080` or `127.0.0.1:8080` --> ReportPortal login page will open ::: OPTIONAL diff --git a/docs/issues-troubleshooting/HowToResolveIssuesWithMigrationToTheNewVersion.md b/docs/issues-troubleshooting/HowToResolveIssuesWithMigrationToTheNewVersion.md index db2e98c685..6d72531bb9 100644 --- a/docs/issues-troubleshooting/HowToResolveIssuesWithMigrationToTheNewVersion.md +++ b/docs/issues-troubleshooting/HowToResolveIssuesWithMigrationToTheNewVersion.md @@ -9,7 +9,7 @@ description: Learn how to resolve migration issues when upgrading ReportPortal t ## Error: Dirty database version XX. Fix and force version. That means, migration process has been interrupted during XX migration (migration has been started but not finished) -1. At first, you need to check the logs of migration (service itselft and database), it can be helpful, if yes, make some actions based on logs, if not then move next. +1. At first, you need to check the logs of migration (service itself and database), it can be helpful, if yes, make some actions based on logs, if not then move next. 2. You need to rollback all applied (if any) migration XX parts. The format for url is the next: @@ -24,7 +24,7 @@ https://github.com/reportportal/migrations/blob/develop/migrations/XX_some_name. 4. Restart migration. For instance, if you have "Error: Dirty database version 10. Fix and force version." -1. Check the logs(service itselft and database), in case we've found nothing, move next. +1. Check the logs (service itself and database), in case we've found nothing, move next. 2. You need to check 10 migration (https://github.com/reportportal/migrations/blob/develop/migrations/10_attachment_size.up.sql) and rollback if you have some partly migration. 3. Then execute #update schema_migrations set version=9, dirty=f 4. Redeploy RP based on docker-composer for example (migration should be started automatically, if you followed by instructions of installation for this way.) diff --git a/docs/issues-troubleshooting/ResolveAnalyzerKnownIssues.mdx b/docs/issues-troubleshooting/ResolveAnalyzerKnownIssues.mdx index b1584ae6e0..880bb1c5ce 100644 --- a/docs/issues-troubleshooting/ResolveAnalyzerKnownIssues.mdx +++ b/docs/issues-troubleshooting/ResolveAnalyzerKnownIssues.mdx @@ -72,7 +72,7 @@ RabbitMQ container is not running. Wait for status `running` or recreate the Rab ### Problem Description -Slowing down analysis or waiting for a long time fore responce. +Slowing down analysis or waiting for a long time for a response. Analyzer logs: diff --git a/docs/log-data-in-reportportal/test-framework-integration/Python/behave.md b/docs/log-data-in-reportportal/test-framework-integration/Python/behave.md index 716c7561d3..b09919f035 100644 --- a/docs/log-data-in-reportportal/test-framework-integration/Python/behave.md +++ b/docs/log-data-in-reportportal/test-framework-integration/Python/behave.md @@ -6,7 +6,7 @@ description: Track and visualize Behave test results automatically, view Gherkin # ReportPortal behave Integration -There is [behave](https://behave.readthedocs.io/en/stable/) extension for reporting test results of behave to the ReportalPortal. +There is [behave](https://behave.readthedocs.io/en/stable/) extension for reporting test results of behave to the ReportPortal. Behave is a popular Python-based testing framework. It can be used for testing different types of applications: web applications, APIs, desktop. Behave has a syntax which is easy to understand even for non-technical users. diff --git a/docs/log-data-in-reportportal/test-framework-integration/Python/nosetests.md b/docs/log-data-in-reportportal/test-framework-integration/Python/nosetests.md index 9d34e6d707..4a44e2d2c5 100644 --- a/docs/log-data-in-reportportal/test-framework-integration/Python/nosetests.md +++ b/docs/log-data-in-reportportal/test-framework-integration/Python/nosetests.md @@ -6,7 +6,7 @@ description: Integrate nosetests with ReportPortal to capture detailed test resu # ReportPortal nosetests Integration -There is [Nose](https://nose.readthedocs.io/en/latest/) plugin for reporting test results of Nose to the ReportalPortal. +There is [Nose](https://nose.readthedocs.io/en/latest/) plugin for reporting test results of Nose to the ReportPortal. nosetests is the command-line tool used for running tests with the Nose testing framework. It makes it simple to run all tests with a single command. diff --git a/docs/plugins/import/JUnit.mdx b/docs/plugins/import/JUnit.mdx index f28621257f..73ed20961b 100644 --- a/docs/plugins/import/JUnit.mdx +++ b/docs/plugins/import/JUnit.mdx @@ -36,7 +36,7 @@ JUnit plugin should be enabled. 4. Select ‘JUnit’ in the ‘Report type’ dropdown on the ‘Import launch’ modal window. -5. Click the drug-and-drop area to add .xml or .zip file under 32MB. +5. Click the drag-and-drop area to add .xml or .zip file under 32MB. 6. Click ‘Import’ button and then ‘OK’ button on the ‘Import launch’ modal window. diff --git a/docs/plugins/import/RobotFramework.mdx b/docs/plugins/import/RobotFramework.mdx index 45f83066ab..b6dd74b683 100644 --- a/docs/plugins/import/RobotFramework.mdx +++ b/docs/plugins/import/RobotFramework.mdx @@ -36,7 +36,7 @@ RobotFramework plugin should be enabled. 4. Select ‘RobotFramework’ in the ‘Report Type’ dropdown on the ‘Import launch’ modal window. -5. Click the drug-and-drop area to add .xml or .zip file under 32MB. +5. Click the drag-and-drop area to add .xml or .zip file under 32MB. 6. Click ‘Import’ button and then ‘OK’ button on the ‘Import launch’ modal window. diff --git a/docs/quality-gates/AssessmentOfTestResultsUsingQualityGates.mdx b/docs/quality-gates/AssessmentOfTestResultsUsingQualityGates.mdx index 2e9ada6ea8..bf26007cc7 100644 --- a/docs/quality-gates/AssessmentOfTestResultsUsingQualityGates.mdx +++ b/docs/quality-gates/AssessmentOfTestResultsUsingQualityGates.mdx @@ -74,16 +74,16 @@ How is status calculated: If you get this status, you can proceed with launch analysis (or choose another baseline) and rerun Quality Gates. For that check the section [How to recalculate Quality Gates](/quality-gates/AssessmentOfTestResultsUsingQualityGates#how-to-recalculate-quality-gates). ### Timeout -Specially for integration with CI\CD, Quality Gates has parameter ```Timeout```. If a launch whose status should be sent to a pipeline, gets UNDEFINED status, the system uses a value from ```Timeout```. Default ```Timeout``` equals to 2 hours. It means, that after 2 hours after launch finish, the system force recaluculats Quality Gate Status and defined status. +Especially for integration with CI/CD, Quality Gates has a parameter ```Timeout```. If a launch whose status should be sent to a pipeline, gets UNDEFINED status, the system uses a value from ```Timeout```. Default ```Timeout``` equals to 2 hours. It means, that after 2 hours after launch finish, the system forcibly recalculates Quality Gate Status and determines the status. | Jenkins Job Status | Quality Gate Status | Description | | :----: | :----: | :--- | -| SUCCESS | PASSED | All Rulles Passed | +| SUCCESS | PASSED | All Rules Passed | | FAILED | FAILED | At least one rule does not pass | If you want to choose other options for a timeout, you can do it: -* Login ReportPortal as Project Manager or Admin +* Log in to ReportPortal as Project Manager or Admin * Open ```Project Settings> Quality Gates``` * Click on ```the pencil``` on the Quality Gate rule * Click on ```"Edit Details."``` diff --git a/docs/quality-gates/DeleteQualityGates.md b/docs/quality-gates/DeleteQualityGates.md index af59441270..72667679c2 100644 --- a/docs/quality-gates/DeleteQualityGates.md +++ b/docs/quality-gates/DeleteQualityGates.md @@ -12,7 +12,7 @@ This feature is available in ReportPortal with a [managed services subscription] If you want to delete Quality Gate: -* Login ReportPortal as Project Manager or Admin +* Log in to ReportPortal as Project Manager or Admin * Open ```Project Settings> Quality Gates``` * Click on ```the trash``` on the Quality Gate rule * The system removes Quality Gate from the DB diff --git a/docs/quality-gates/QualityRulesConfiguration.mdx b/docs/quality-gates/QualityRulesConfiguration.mdx index 65f6679eb8..7350a7db94 100644 --- a/docs/quality-gates/QualityRulesConfiguration.mdx +++ b/docs/quality-gates/QualityRulesConfiguration.mdx @@ -278,7 +278,7 @@ If there is no fitting launch in the system, the "New failure" rule will get the If you want to choose other options for a baseline, you can do it: -* Login ReportPortal as Project Manager or Admin +* Log in to ReportPortal as Project Manager or Admin * Open ```Project Settings> Quality Gates``` * Click on ```the pencil``` on the Quality Gate rule * Click on ```"Edit Details."``` @@ -290,7 +290,7 @@ If you want to choose other options for a baseline, you can do it: | Case | Fileds configuration | | :----: | :----: | | You want to specify a static launch that should always be used | Select launch name and add launch number in the baseline section| -| You want to specify dynamic launcg| Select launch name and check a button "Latest" :question:| +| You want to specify dynamic launch| Select launch name and check a button "Latest" :question:| :question: When you use "latest", the system will use the latest launch with a specified launch name, which has been run before the analyzed launch. If you want to specify a baseline, you also can add launch attributes. In this case, the system will use the latest launch with specified launch name and attributes, which have been run before the analyzed launch. diff --git a/docs/quality-gates/UploadQualityGateToReportPortal.mdx b/docs/quality-gates/UploadQualityGateToReportPortal.mdx index 21ac49f7b9..2a2ff7923b 100644 --- a/docs/quality-gates/UploadQualityGateToReportPortal.mdx +++ b/docs/quality-gates/UploadQualityGateToReportPortal.mdx @@ -14,7 +14,7 @@ The default configuration of our continuous testing platform doesn't contain Qua Download the .jar file and upload it to ReportPortal. For that, perform following actions: -* Login ReportPortal as an Admin +* Log in to ReportPortal as an Admin * Open ```Admin Page > Plugins``` * Click on the button ```Upload``` * Add .jar file to the modal ```Upload plugin``` diff --git a/docs/releases/Version25.1.md b/docs/releases/Version25.1.md index e761e328df..190a5f75ae 100644 --- a/docs/releases/Version25.1.md +++ b/docs/releases/Version25.1.md @@ -93,7 +93,7 @@ Fixed: [#80](https://github.com/reportportal/reportportal/issues/80): Jira Cloud Plugin: Fixed URL validation preventing connections to *.jira.com domains.
[#2488](https://github.com/reportportal/reportportal/issues/2488): GitHub Authorization: Fixed organization membership validation preventing valid organization members from logging in.
-[#2454](https://github.com/reportportal/reportportal/issues/2454): JIRA Server Sub-task Creation Error: Fixed paren)t issue data formatting that prevented creating sub-tasks in JIRA Server integration. +[#2454](https://github.com/reportportal/reportportal/issues/2454): JIRA Server Sub-task Creation Error: Fixed parent issue data formatting that prevented creating sub-tasks in JIRA Server integration. ## 5. CVE addressed: diff --git a/docs/releases/archived-releases/Version5.3.1.md b/docs/releases/archived-releases/Version5.3.1.md index 600856f963..da96834881 100644 --- a/docs/releases/archived-releases/Version5.3.1.md +++ b/docs/releases/archived-releases/Version5.3.1.md @@ -8,10 +8,10 @@ description: ReportPortal v5.3.1 archived release notes with bug fixes. ## Bug fixing -[Performance]High CPU and Disk IO utilization of PostgreSQL queries +[Performance] High CPU and Disk IO utilization of PostgreSQL queries -[Performance] Responce time degradation of the History Table on Steps Level due to high cpu utilization of the DB query +[Performance] Response time degradation of the History Table on Steps Level due to high cpu utilization of the DB query -[Performance][PreProd] High responce time(up to 3 min) of the Most Failed TC Widget loading +[Performance] [PreProd] High response time(up to 3 min) of the Most Failed TC Widget loading Fix for launches purging job diff --git a/docs/work-with-reports/LogLevel.mdx b/docs/work-with-reports/LogLevel.mdx index 0bb8588ed9..86de3fe4ca 100644 --- a/docs/work-with-reports/LogLevel.mdx +++ b/docs/work-with-reports/LogLevel.mdx @@ -150,7 +150,7 @@ A user can report logs not only to the test execution but also to containers: If user want to view attached logs: -* Login ReportPortal +* Log in to ReportPortal * Click on a launch name, or a suite name * Click on Log tab