Skip to content
Draft
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 2 additions & 3 deletions docs/FAQ/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,17 +77,16 @@ The initial steps involve installing and configuring the tool. [Installation ste

#### 8. Does the tool integrate with my existing test automation framework?

ReportPortal can be integrated with common testing frameworks and CI tools. Consult [this section](/log-data-in-reportportal/test-framework-integration) of the documentation for detailed information on test framework integration. And use following links for Integration with CI/CD: [Integration with GitLab CI](/quality-gates/IntegrationWithCICD/IntegrationWithGitLabCI/), [Integration with Jenkins](/quality-gates/IntegrationWithCICD/IntegrationWithJenkins/).
ReportPortal can be integrated with common testing frameworks and CI tools. Consult [this section](/log-data-in-reportportal/test-framework-integration) of the documentation for detailed information on test framework integration.

#### 9. What type of license does ReportPortal use?

ReportPortal is licensed under Apache v2.0, which means it’s free to use, comes with no liability and warranty, and there is no service and support included. And can be utilized even for commercial usage.

#### 10. Does ReportPortal have any paid features?

We offer two premium features:
We offer the following premium feature:

* [Quality Gates](/quality-gates/) – a set of predefined criteria that must be met for a test run to be considered successful.
* [SCIM Server](/features/SCIMServerFeature) – helps automate user management by syncing users and their access rights between your identity provider and ReportPortal.

#### 11. Does ReportPortal use AI?
Expand Down
10 changes: 1 addition & 9 deletions docs/analysis/UniqueErrorAnalysis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Thanks to the Unique Error analysis functionality, ReportPortal got the followin
1. A list of unique errors for the launch, with grouping.
2. Easier test results analysis.
3. Machine learning (ML) suggestions for groups of tests.
4. The [‘New Errors’](/quality-gates/QualityRulesConfiguration/#new-errors-in-the-run) Quality Gates rule.


## How to run Unique Error analysis

Expand Down Expand Up @@ -118,15 +118,7 @@ We have 2 errors with identical text, but the difference is numeric value in the

<MediaViewer src={require('./img/UniqueErrorAnalysis/UniqueError13.png')} alt="Example with 'Exclude numbers from analyzed logs' setting" />

## How to extend Unique Error analysis

Unique Error analysis functionality can be extended by the [ReportPortal premium feature](https://reportportal.io/pricing/saas) – [Quality Gates](/quality-gates/).

If you have Quality Gate plugin installed, you can create Quality Gate for the launch with the 'New Errors' rule. This rule helps identify any new unique errors in the current launch by comparing them to another specified launch.

If there is Quality Gate for the launch with the 'New Errors' rule, the 'ALL UNIQUE ERRORS' dropdown is visible and enabled. The available options are: All, New Errors and Known Errors.

<MediaViewer src={require('./img/UniqueErrorAnalysis/UniqueError14.png')} alt="Enabled ALL UNIQUE ERRORS dropdown" />

If there is no Quality Gate for the launch with the 'New Errors' rule, the 'ALL UNIQUE ERRORS' dropdown is visible but disabled. A tooltip appears on hover for the disabled state: 'No Quality Gate with 'New Error' rule for the launch.'

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/ProjectSettings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To go to the project settings page, click the "Project Settings" icon in the lef

The project configuration page will be opened.

The project settings are divided into following tabs: "General", "Integrations", "Notifications", "Defect Types", "Analyzer", "Pattern Analysis", "Demo Data" and "Quality Gates" (if you have our [premium feature](/quality-gates)).
The project settings are divided into following tabs: "General", "Integrations", "Notifications", "Defect Types", "Analyzer", "Pattern Analysis" and "Demo Data".

## General settings

Expand Down
2 changes: 1 addition & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ReportPortal is a TestOps service, that provides increased capabilities to speed
ReportPortal is a great addition to Continuous Integration and Continuous
Testing process.

ReportPortal is distributed under the Apache v2.0 license, and it is free to use and modify, even for commercial purposes. We offer two paid premium features – [Quality Gates](/quality-gates) and [SCIM Server feature](/features/SCIMServerFeature).
ReportPortal is distributed under the Apache v2.0 license, and it is free to use and modify, even for commercial purposes. We offer a paid premium feature – [SCIM Server feature](/features/SCIMServerFeature).

If a company is interested in our services, we can provide support hours to deploy, integrate, configure, or customize the tool, as well as [SaaS options](https://reportportal.io/pricing/saas).

Expand Down
2 changes: 0 additions & 2 deletions docs/plugins/other/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ The [Sauce Labs](/plugins/other/SauceLabs) plugin connects ReportPortal with Sau

The [Test Executions](/test-executions/) plugin introduces a refreshed approach to exploring and managing test results in ReportPortal. Instead of focusing on individual launches, it displays all test cases in a unified, easily searchable list. Users can apply multi-level filters, adjust the view to match their workflow, and analyze execution details with greater precision. This feature simplifies navigation across large datasets, enhances visibility into test progress, and supports more efficient decision-making during the testing process.

The [Quality Gates](/quality-gates/) plugin automates quality control in continuous testing pipelines, helping teams accelerate release cycles and ensure product reliability. It allows users to define customizable quality rules directly in ReportPortal and automatically evaluates each CI/CD build against them. Once a test run is completed, ReportPortal sends instant feedback to the CI/CD system, indicating whether the build meets predefined criteria or should be stopped for review.

import DocCardList from '@theme/DocCardList';

<DocCardList />
2 changes: 1 addition & 1 deletion docs/releases/archived-releases/Version23.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Please note that Features 3 and 4 are configurable, giving you the flexibility t

You can now generate as many API Keys as you need. You also have the ability to keep track of the creation date of API Keys and revoke any that are unused. Old tokens will still continue to function. Additionally, easy identification of the purpose of API Keys is facilitated through the use of prefixes.

- **[Gitlab CI integration](/quality-gates/IntegrationWithCICD/IntegrationWithGitLabCI) Workaround:**
- **Gitlab CI integration Workaround:**

## 2. Small updates:

Expand Down
1 change: 0 additions & 1 deletion docs/terms-and-conditions/PremiumFeatures.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,5 @@ Our Premium Features have been meticulously designed and developed with large-sc
We invite you to explore our Premium Features, understanding their objectives and benefits in detail on our documentation page. We are confident that you'll find the value they add to be well worth the investment. As always, we're here to answer any questions and assist you in getting the most out of your ReportPortal experience.

**Available Premium Features:**
- [**Quality Gates**](/quality-gates)
- [**SCIM Server feature**](/features/SCIMServerFeature)
- [**Test Executions**](/features/TestExecutions)
18 changes: 0 additions & 18 deletions docs/tutorial/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -204,24 +204,6 @@ In this way, you see the historical trend of the causes of falls.

<MediaViewer src={require('./img/HistoricalTrends4.png')} alt="Historical trend of the causes of falls" />

## How to make automated test results part of my pipeline

ReportPortal supports Continuous Testing with built-in functionality – [Quality Gates](/quality-gates) (premium feature). Quality Gate is a set of predefined criteria that should be met in order launch run to be considered as successful.

Firstly, navigate to Project settings and create a Quality Gate with the rules which will be applied to a specific launch that matches the conditions.

<MediaViewer src={require('./img/QualityGate1.png')} alt="Create Quality Gate" />

<MediaViewer src={require('./img/QualityGate2.png')} alt="Quality Gate parameters for our continuous testing platform" />

<MediaViewer src={require('./img/QualityGate3.png')} alt="Run Quality Gate for specific launch" />

<MediaViewer src={require('./img/QualityGate4.png')} alt="Quality Gate in progress" />

<MediaViewer src={require('./img/QualityGate5.png')} alt="Quality Gate failed" />

Finally, configure [integration with CI/CD](/quality-gates/IntegrationWithCICD) to send results to the pipeline.

## How to use nested steps and attributes in ReportPortal

Usually, you see the results of automation as a carpet of error logs, and only an automation engineer can understand what is happening inside. Adding nested steps ([Java](https://github.com/reportportal/client-java/wiki/Nested-steps), [Python](https://github.com/reportportal/client-Python/wiki/Nested-steps)) allows applying a one-time change in the test code to make a logical grouping of steps and make these error logs more readable for the whole team.
Expand Down
30 changes: 22 additions & 8 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,18 @@ const config = {
routeBasePath: '/',
sidebarPath: require.resolve('./sidebars.js'),
editUrl: 'https://github.com/reportportal/docs/blob/develop',
lastVersion: '26.2-organizations',
onlyIncludeVersions: ['26.2-organizations', '26.1'],
versions: {
'26.2-organizations': {
label: '26.2-organizations',
banner: 'none',
},
'26.1': {
label: '26.1',
banner: 'none',
},
},
},
blog: false,
theme: {
Expand Down Expand Up @@ -87,6 +99,15 @@ const config = {
to: 'https://developers.reportportal.io/api-docs/',
target: '_self',
},
{
label: 'Releases',
position: 'left',
target: '_self',
},
{
type: 'docsVersionDropdown',
position: 'right',
},
{
href: 'https://reportportal.io/',
label: 'ReportPortal.io',
Expand Down Expand Up @@ -196,11 +217,8 @@ const config = {
appId: 'CRZVCU6DFV',
apiKey: 'd8b54d5902dab4d50e4fba6321fb01a7',
indexName: 'reportportal',
replaceSearchResultPathname: {
from: '/docs/',
to: baseUrl, // To suggest URLs correctly for local and dev deployment
},
searchPagePath: 'search',
contextualSearch: false,
},
}),

Expand Down Expand Up @@ -254,10 +272,6 @@ const config = {
to: '/external-integrations',
from: '/category/external-integrations',
},
{
to: '/quality-gates',
from: '/category/quality-gates',
},
{
to: '/case-studies',
from: '/category/case-studies',
Expand Down
Loading
Loading