Merge pull request #394 from telekom/fix/doc-improvements

Fix/doc improvements

docs/src/docs/best-practices/html-elements.adoc

@@ -11,12 +11,12 @@ Since radio buttons share the same name, as the following example shows
 ----
 
 It's not a good practice to select it `By.name`.
-Its better to select both options separately.
+It's better to select both options separately.
 
 [source,java]
 ----
 // Good practice
-PreparedLocator locator = LOCATE.prepare("//input[@name='%s' and @value='%s']").unique();
+PreparedLocator locator = LOCATE.prepare("//input[@name='%s' and @value='%s']");
 UiElement teeOption = find(locator.with("beverage", "tee"));
 UiElement coffeeOption = find(locator.with("beverage", "coffee"));
 

docs/src/docs/guielement/guielement-creation.adoc

@@ -195,13 +195,13 @@ UiElement empty = createEmpty(Locator);
 All interactive operations on this element will do nothing, all wait methods will be false and all assertions will fail.
 
 
-== Sensible Data
+== Sensitive Data
 
-Sensible data, such as passwords, can be displayed obfuscated in the logs during the actions type and sendKeys.
+Sensitive data, such as passwords, can be displayed obfuscated in the logs during the actions type and sendKeys.
 
 [source,java]
 ----
-UiElement sensibleElement = findById("secret").sensibleData();
+UiElement sensitiveElement = findById("secret").sensitiveData();
 ----
 Only the placeholder * is logged in the report instead of the real value.
 

docs/src/docs/reports.adoc

@@ -7,6 +7,7 @@ include::reports/testdetails.adoc[leveloffset=+1]
 include::reports/failure-aspects.adoc[leveloffset=+1]
 include::reports/log-view.adoc[leveloffset=+1]
 include::reports/threads-view.adoc[leveloffset=+1]
+include::reports/timings-view.adoc[leveloffset=+1]
 include::reports/teststeps.adoc[leveloffset=+1]
 include::reports/prioritymessages.adoc[leveloffset=+1]
 include::reports/layout-check.adoc[leveloffset=+1]

docs/src/docs/reports/overview.adoc

@@ -8,6 +8,7 @@ A report generated with `Report-NG` consists of these different views:
 * Failure Aspects - a summary of the different types of failures
 * Logs - a panel that contains detailed logging information
 * Threads - a graphical view of the thread activities during the parallel test execution
+* Timings - a detailed overview of the execution time of test cases and loading time of sessions
 
 image::report-ng-01.png[align="center", alt="Report-NG Dashboard"]
 

docs/src/docs/reports/threads-view.adoc

@@ -1,17 +1,19 @@
 = Threads View
 
-The Threads View displays all activities on the individual worker threads in a gantt chart. For details hover over a testcase to view a tooltip showing the name, its Run-Index, Start- and End-time and the duration.
+The Threads View displays all activities on the individual worker threads in a gantt chart.
+The y-axis delineates the thread names, while the x-axis portrays the timeline.
+Test cases are visualized within the respective threads where they were executed.
+For details hover over a test case to view a tooltip showing the name, its Run-Index, Start- and End-time and the duration.
 
 Navigation:
 
 * Use the mouse wheel to zoom in or out on the time axis.
 * Click the left button while moving the mouse to scroll horizontally.
 * Use the scroll bar on the right to scroll vertically.
-* Use the zoom bar at the bottom to zoom into a specific area by moving the start and end of the slider or drawing on an area by holding and releasing left click on the slider bar. You can then move the slider along the time axis by dragging it.
 
 Filter:
 
-* Use the status filter to focus on all testcases with the selected status.
-* Use the method input field to zoom in on a specific testcase.
+* Use the status filter to focus on all test cases with the selected status.
+* Use the method input field to zoom in on a specific test case.
 
 image::report-ng-threads-view.png[align="center", alt="Threads View"]

docs/src/docs/reports/timings-view.adoc

@@ -0,0 +1,35 @@
+= Timings View
+
+== Tests tab pane
+All executed test cases are included in a bar chart, grouped in ranges by their execution time.
+By hovering over a bar the methods within this range are listed in a tooltip.
+
+It is possible to adjust the number of method ranges by selecting a value of 5, 10, 15 or 20 in the corresponding drop-down menu.
+This way you can adjust the resolution of the chart.
+
+You can also search for a specific method by entering the name of the test case in the searchbar.
+The corresponding bar is then highlighted.
+
+By default, only the test methods themselves are included.
+However, it is possible to incorporate the configuration methods by toggling the switch located in the top right corner of the view.
+
+image::report-ng-timings-view_tests.png[align="center", alt="Tests"]
+
+== Sessions tab pane
+In the scatter chart you can see every session that was started in the test execution.
+On the x-axis, the starting time of session is indicated, while the loading duration is represented on the y-axis.
+
+When hovering over any of the dots, a tooltip appears providing details regarding the browser and its version, the session name and ID, along with the test cases executed within that session.
+
+If a base URL is configured, the load duration and timestamp of the base URL are also displayed.
+In this scenario, the two dots are linked, as the base URL is consistently loaded at session startup.
+Note that setting up a base URL is optional.
+If both dots exist, the hover effect will clarify which base URL dot corresponds to each session dot.
+
+Navigation:
+
+* Use the mouse wheel to zoom in or out on the y-axis.
+* Move the mouse while holding the left button to scroll vertically.
+* It is also possible to use the buttons in the upper right corner to zoom into a specific area, reset the zoom and restore the chart.
+
+image::report-ng-timings-view_sessions.png[align="center", alt="Sessions"]