Skip to content

Commit 8fd9002

Browse files
Yuliya_PrihodkoYuliya_Prihodko
authored andcommitted
Prepare docs for release 26.0.3
1 parent b0efb70 commit 8fd9002

28 files changed

Lines changed: 102 additions & 26 deletions

docs/dashboards-and-widgets/CumulativeTrendChart.mdx

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ A widget does not require an edit or new filter creation. If a new version (buil
2222
<MediaViewer src={require('./img/widget-types/CumulativeCreation.png')} alt="Cumulative Creation" />
2323

2424
**Widget view**
25+
2526
A widget has two levels.
2627

2728
**For the first level** the system uses the last 600 launches from the chosen filter.
@@ -47,35 +48,39 @@ Statistics for bars BUILD: 3.20.8.0 is calculated as - a summary of latest launc
4748

4849
<MediaViewer src={require('./img/widget-types/CumulativeTrendChart.png')} alt="Dashboard to manage test results: Cumulative trend chart First Level View" />
4950

50-
A user can drill down to the second level of the widget. For that, he should click on the bar. And the system shows two buttons: Drill Down and Show filter.
51-
And a user should click on **"Drill down"**.
51+
Users can drill down to the second level of the widget by clicking a bar in the chart. The system displays the **Drill down** and **Show Filter** options. To open the second-level view, the user should select **Show Filter**.
52+
53+
The system opens a filtered list of tests corresponding to the selected segment.
54+
55+
* Clicking **Passed** displays only Passed tests.
56+
* Clicking **Failed** displays Failed and Interrupted tests.
57+
* Clicking **Skipped** displays only Skipped tests.
58+
* Clicking a defect type displays tests with the corresponding defect type.
5259

5360
**For the second level** the system again analyzes the 600 launches from the filter.
5461
Then it leaves only launches that have an attribute, that has been clicked by the user (f.e. BUILD: 3.20.8.0 ).
5562
From these launches, systems choose ones with attributes that have key attribute from the section Level 2 (detailed view) on widget wizard.
5663
After the system groups launch with the same attribute and leaves for each selection only the “latest” launches (launches with unique launch name and with the biggest launch number in ReportPortal).
5764
Others should be removed from a group. Each unique group should be reflected in the graph on the second widget level.
5865

59-
60-
For each group there is shown a set of bars: Passed, Failed, Skipped, group Product Bug, group Auto Bug, group System Issue, group No defect, group To investigated.
66+
Status and defect statistics bars are displayed for each group. The status statistics bar includes Passed, Failed, and Skipped statuses. The defect statistics bar includes the following groups: Product Bug, Automation Bug, System Issue, No Defect, and To Investigate.
6167

6268
On the hover on the bar, a user can see detailed information about the sample. Also, the user can see a list of attributes with attribute key from the first and from the second level which has launches, which have been used for a hovered bar.
6369

64-
6570
**Visual options**
6671

67-
**Focus on defect types**
72+
**Defect types**<br />
6873
If the option is enabled, a user can see only information about defect types for each sample.
6974
If an option is disabled, a user can see information about statuses and defect types.
7075

71-
**Totals**
76+
**Totals**<br />
7277
If the option is enabled, a user can see info about several test cases in each sample.
7378

74-
**Staked area / Separate bars**
79+
**Staked area / Separate bars**<br />
7580
Staked area chart - is shown one bar for statuses, and one bar for defect types for each sample.
7681
Separate bars - is shown a separate bar for each status, and each defect type group.
7782

78-
**Tests / Per cent**
83+
**Tests / Percent test mode**<br />
7984
Test mode - OY axis is calculated in test cases.
8085
Percent mode - OY axis is calculated in percent. OY = 100%.
8186

docs/dashboards-and-widgets/FlakyTestCasesTableTop50.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,8 @@ The number of switches from one state to another of the test case with the same
4747
On mouse hover, tooltip appears “N status changes from M possible times”.
4848
:::
4949

50+
**Drill-down behavior**
51+
52+
When a user clicks a test case in the Flaky Test Cases widget, ReportPortal redirects the user to the most recent available execution of the selected test case and displays its execution details.
53+
5054
<MediaViewer src={require('./img/widget-types/FlakyTestCasesTableWidget.png')} alt="Data visualization in test automation: Flaky Test Cases Table Widget" />

docs/dashboards-and-widgets/OverallStatistics.mdx

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,23 @@ The panel shows a summary of test cases with each status for each selected launc
1515
- Widget Criteria: All criteria are selected by default.
1616
- Type of view: Panel view/ Donut view
1717
- Mode All launches/ Latest launches
18+
- 'Show the "Interrupted" status independently from "Failed" items' checkbox (unselected by default)
1819

1920

2021
**Widget view**
2122

2223
The widget shows statistics of the All launches/or Latest launches for the chosen filter. Statistics are divided into the following sections:
23-
- Skipped, Passed, Failed
24-
- Product Bug, System Issue, Automation Bug, No Defect and To Investigate.
24+
- Skipped, Passed, Failed, Interrupted (*)
25+
- Product Bug, System Issue, Automation Bug, No Defect and To Investigate.
26+
27+
\* The widget view depends on the state of the 'Show the "Interrupted" status independently from "Failed" items' checkbox:
28+
29+
- If the **checkbox is unselected**, Interrupted tests are included in the Failed count.
30+
- If the **checkbox is selected**, failed tests are divided into Failed and Interrupted categories independently, regardless of the selected view type (Panel view or Donut view).
31+
32+
<MediaViewer src={require('./img/widget-types/OverallStatisticsInterrupted1.png')} alt="Show the Interrupted status checkbox" />
33+
34+
<MediaViewer src={require('./img/widget-types/OverallStatisticsInterrupted2.png')} alt="Included Interrupted tests" />
2535

2636
The statistics for every type are shown in percentages. On hover, the exact number is shown for each type.
2737
The Widget has clickable sections when you click on a specified section in the widget, the system forwards you to launch view for appropriate selection.

docs/dashboards-and-widgets/TestCaseSearch.mdx

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Allows finding a test case by name or attribute throughout all launch executions
1717

1818
### Refine section:
1919

20-
- "Test name" text field. Condition dropdown is disabled. By default – cnt (contains)
20+
- "Test name" text field. Condition dropdown is disabled. By default – starts with
2121
- "Attribute" text field – key and value options
2222
- "Display launches" toggle – default state: OFF
2323
- "Edit" icon
@@ -84,40 +84,34 @@ If more than one page exists for the specified search criteria, a "Load more" bu
8484

8585
<MediaViewer src={require('./img/widget-types/TestCaseSearch7.png')} alt="Load more button" />
8686

87-
By clicking "Load more", additional 10 results (or less if available) appear. Previously loaded results remain visible and are supplemented with new data. If at least one more page is available, the "Load more" button continues to appear at the bottom of the widget.
87+
By clicking Load more,” up to 10 additional results appear, depending on how many results are available. Previously loaded results remain visible and are supplemented with new data. The maximum number of search results is 20 items.
8888

89-
If more than 30 pages exist for the specified search criteria, the "Load more" button becomes disabled after loading the 30th page. The limit for the widget is 300 latest test cases.
90-
91-
<MediaViewer src={require('./img/widget-types/TestCaseSearch8.png')} alt="Load more button becomes disabled" />
89+
If you need more flexible search options, advanced filtering, sorting, or access to a larger result set, try our premium feature: [Test Executions](/features/TestExecutions/). Learn which [plan](https://reportportal.io/pricing/saas/) best fits your testing needs.
9290

9391
When the "Display launches" toggle is ON, the displayed results are grouped by launch execution and parent items (Launch/suite/test).
9492

95-
<MediaViewer src={require('./img/widget-types/TestCaseSearch9.png')} alt="Display launches toggle is ON" />
93+
<MediaViewer src={require('./img/widget-types/TestCaseSearch8.png')} alt="Display launches toggle is ON" />
9694

9795
By clicking on the "Update" icon the page is refreshed a new request with specified in the widget parameters is sent. Only the first page is displayed.
9896

99-
<MediaViewer src={require('./img/widget-types/TestCaseSearch10.png')} alt="Update icon" />
97+
<MediaViewer src={require('./img/widget-types/TestCaseSearch9.png')} alt="Update icon" />
10098

10199
By clicking on the test name, the user is redirected to the test's log level in a new tab (the same action occurs when clicking the icon next to the test name).
102100

103-
<MediaViewer src={require('./img/widget-types/TestCaseSearch11.png')} alt="Test's log level" />
101+
<MediaViewer src={require('./img/widget-types/TestCaseSearch10.png')} alt="Test's log level" />
104102

105103
If a test item has a long description, an arrow appears to expand it.
106104

107-
<MediaViewer src={require('./img/widget-types/TestCaseSearch12.png')} alt="An arrow to expand description" />
108-
109-
<MediaViewer src={require('./img/widget-types/TestCaseSearch13.png')} alt="A long description" />
105+
<MediaViewer src={require('./img/widget-types/TestCaseSearch11.png')} alt="An arrow to expand description" />
110106

111107
When hovering over the Start Time field, the format changes while hovering; clicking changes it per application settings.
112108

113-
<MediaViewer src={require('./img/widget-types/TestCaseSearch14.png')} alt="Start Time field" />
109+
<MediaViewer src={require('./img/widget-types/TestCaseSearch12.png')} alt="Start Time field" />
114110

115111
Sorting is available by the Start Time field, with descending order set by default. Users can switch between ascending and descending order.
116112

117113
By clicking the link to the bug tracking system, the ticket in the BTS opens.
118114

119-
<MediaViewer src={require('./img/widget-types/TestCaseSearch15.png')} alt="The link to the bug tracking system" />
120-
121-
<MediaViewer src={require('./img/widget-types/TestCaseSearch16.png')} alt="The ticket in the bug tracking system" />
115+
<MediaViewer src={require('./img/widget-types/TestCaseSearch13.png')} alt="The link to the bug tracking system" />
122116

123117
<MediaViewer src="https://youtu.be/HxHCJTNqGaY" alt="Test Case Widget" type="video" />
90.3 KB
Loading
45.6 KB
Loading
29 KB
Loading
-31.1 KB
Loading
12.8 KB
Loading
-56.8 KB
Loading

0 commit comments

Comments
 (0)