Merge pull request #612 from reportportal/develop

release for new landing

docs/FAQ/index.md

@@ -0,0 +1,72 @@
+---
+sidebar_position: 21
+sidebar_label: FAQ
+---
+
+# FAQ
+
+On this page, we have put together a list of the most frequently asked questions. Here, you can find prompt responses.
+
+**1. Does on-prem installed ReportPortal make any external calls? What are the content and nature of these calls? **
+
+All test results and testing data reside in-house, within your instance of ReportPortal. However, there are two types of external calls that ReportPortal makes. The first checks our status page for the latest version and informs users of it on the login page. The second sends anonymized data to [Google Analytics](/terms-and-conditions/GoogleAnalyticsUsageByReportPortal), helping us refine the user experience and better understand application usage. This can be toggled off if desired.
+
+**2. Assuming ReportPortal locally caches logs to understand their content, where are these stored, and what are the associated retention policies?**
+
+ReportPortal utilizes PostgreSQL for its database, MinIO and the local system for file storage, and Elasticsearch for log indexing and ML processes.
+
+Retention policies can be set and adjusted within the application on a per-project basis.
+
+**3. How is data encrypted in transit and at rest?**
+
+We use encryption in transit via SSL for our SaaS instances. For on-prem installation it depends on your LoadBalancer.
+
+We use encryption at rest for our SaaS instances. It is provided by AWS and configured during VM provisioning. For on-prem installation it depends on your DevOps.
+
+**4. Does the containerized solution function as a standalone, or can it be integrated with K8S or other orchestration platforms? Is there a helm chart available?**
+
+ReportPortal is containerized and can be orchestrated using either docker-compose or [Kubernetes](https://github.com/reportportal/kubernetes/tree/develop/reportportal).
+
+**5. Is there any training available to use ReportPortal effectively?**
+
+Check our [Tutorial](/reportportal-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.
+
+**6. Is there a demo available?**
+
+For sure, you can explore ReportPortal [without installation](/reportportal-tutorial/#how-to-explore-reportportal-without-installation) visiting our Demo instance.
+
+**7. How can I begin using ReportPortal?**
+
+The initial steps involve installing and configuring the tool. [Installation steps](/category/installation-steps) you can find in our documentation.
+
+**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/).
+
+**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?**
+
+At that moment, we offer the only premium feature – [Quality Gates](/category/quality-gates). It is a set of predefined criteria that must be satisfied for a run to be deemed successful.
+
+**11. Does ReportPortal use AI?**
+
+We provide ML-driven failure triage. Read [this article](https://reportportal.io/blog/How-we-use-AI) to know how we use AI.
+
+**12. Do we need specific infrastructure prerequisites to avoid performance problems?**
+
+Look into [Optimal Performance Hardware setup](/installation-steps/OptimalPerformanceHardwareSetup).
+
+**13. What types of reports can I generate with the ReportPortal?**
+
+ReportPortal has a lot of widgets to visualize test results and understand the state of the product. Most popular our widgets: [Overall statistics chart](/dashboards-and-widgets/OverallStatistics), [Launch statistics chart](/dashboards-and-widgets/LaunchStatisticsChart), [Failed cases trend chart](/dashboards-and-widgets/FailedCasesTrendChart), [Launch execution and issue statistic](/dashboards-and-widgets/LaunchExecutionAndIssueStatistic), [Component health check](/dashboards-and-widgets/ComponentHealthCheck).
+
+**14. Can ReportPortal aggregate performance test results?**
+
+We do not support direct integration with performance testing frameworks, but as a workaround you can import performance test results in JUnit format into ReportPortal. Further information on this topic can be found [here](https://github.com/reportportal/reportportal/issues/1820).
+
+**15. Does ReportPortal have integration with Jira?**
+
+Our test automation reporting dashboard have integration with following Bug Tracking Systems: [Jira Server](/plugins/AtlassianJiraServer), [Jira Cloud](/plugins/AtlassianJiraCloud), [Azure DevOps](/plugins/AzureDevOpsBTS), and [Rally](/plugins/Rally). 

docs/admin-panel/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Admin Panel",
-  "position": "12",
+  "position": "14",
   "link": {
     "type": "generated-index"
   }

docs/analysis/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Analysis",
-  "position": "8",
+  "position": "11",
   "link": {
     "type": "generated-index"
   }

docs/case-studies/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Case Studies",
-  "position": "16",
+  "position": "19",
   "link": {
     "type": "generated-index"
   }

docs/dashboards-and-widgets/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Dashboards and widgets",
-  "position": "10",
+  "position": "13",
   "link": {
     "type": "generated-index"
   }

docs/dev-guides/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Developers guides",
-  "position": "7",
+  "position": "9",
   "link": {
     "type": "generated-index"
   }

docs/features/AIFailureReasonDetection.md

@@ -0,0 +1,32 @@
+---
+sidebar_position: 3
+sidebar_label: AI failure reason detection
+---
+
+# AI-based failure reason detection
+
+In the realm of test automation, failure analysis often becomes a bottleneck, consuming valuable time and resources. ReportPortal introduces a game-changing solution with its AI-powered failure reason detection feature. Employing advanced Machine Learning (ML) algorithms, this feature streamlines your test processes, enabling quicker, more accurate results.
+
+**Unlocking Efficiency through Automation**
+
+Running daily regression tests can be a double-edged sword: they're essential for maintaining a robust application, but they also generate an avalanche of test results that need analysis. The good news? ReportPortal's AI algorithms take over this repetitive task, automatically categorizing test failures according to their root cause. As a result, your team can shift their focus to newly emerged issues, substantially cutting down the time spent on manual triage.
+
+**Speed and Precision in Defect Identification**
+
+The power of AI doesn't stop at handling daily jobs; it extends to making your defect identification process lightning-fast and razor-sharp. ReportPortal's Auto-Analysis feature scans through test results, logs, and other associated data to quickly pinpoint failures and automatically tag them with defect types. This efficiency enables your team to discover a maximum number of bugs in minimal time, supercharging your QA process.
+
+**Elevated Accuracy in Failure Classification**
+
+Human error is an inevitable part of any process, particularly one as monotonous as going through lines of test logs. ReportPortal's AI-driven approach minimizes this risk. By automating the classification of test failures, it not only eliminates manual errors but also adds an extra layer of precision that even the most experienced testers might miss.
+
+ReportPortal's AI functionality comes in three distinct forms to accommodate various testing needs:
+
+- **Analyzer:** This feature automatically classifies test failures, sparing your team the manual labor of sifting through results. Utilizing advanced algorithms, the Analyzer categorizes different types of test failures, so you can prioritize issues that need immediate attention.
+- **Unique Error:** This tool groups identical test failures together for accelerated bulk analysis. By clustering similar failures, Unique Error allows for more efficient troubleshooting and quicker resolution of recurring issues.
+- **ML-Based Suggestions:** Leveraging machine learning algorithms, this feature provides suggestions for failures that are most similar to ones you've encountered before while do manual analysis. The suggestions guide your team in identifying the root causes of test failures more accurately and swiftly.
+
+**Conclusion: A Smarter Way to Test**
+
+AI-based failure reason detection is more than just a flashy feature. First deployed in production in 2016, long before the hype cycle surrounding GenAI technology. It's a strategic asset that enhances team productivity and the reliability of your applications. By automating the most cumbersome aspects of test analysis, ReportPortal frees up your team to focus on what truly matters: delivering high-quality software.
+
+Embrace the future of test automation with ReportPortal's AI capabilities and give your team the edge they've been waiting for.

docs/features/CategorisationOfFailures.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 2
+sidebar_label: Categorisation of failures
+---
+
+# Categorization of failures based on issue roots
+
+In the realm of software development and QA, test failure analysis isn't just a task—it's a critical practice. The way we categorize test failures informs not only the testing process but also how quickly and efficiently developers can resolve issues. ReportPortal provides an advanced, feature-rich environment for streamlined failure categorization, which is an integral part of any agile development cycle.
+
+Navigate to the 'Launches' tab in ReportPortal and you'll find an intuitive breakdown of your test executions, displaying Total, Passed, Failed, and Skipped test cases. What sets ReportPortal apart is its pre-categorized issues like Product Bug, Automation Bug, and System Issue. This leaves your team with a focused subset of items marked “To Investigate.”
+
+**The Process of Intelligent Triage**
+
+When you open one of these “To Investigate” items, a QA engineer engages in defect triage by reviewing logs, screenshots, and video recordings, all of which are seamlessly integrated into each failed test item. Based on this comprehensive analysis, the engineer categorizes the failures through the “Make Decision” modal, as follows:
+
+- **Product Bug:** These issues stem from flaws in the application code and should be the developers' first priority for resolution.
+- **Automation Bug:** This category addresses issues related to test data, such as outdated tests or incorrect data, and timeouts.
+- **System Issue:** Failures in this category usually result from an unstable testing environment or issues with third-party software.
+- **Not a Defect:** Use this classification for tests that have been resolved or manually validated.
+
+**The Takeaways**
+
+Intelligent categorization with ReportPortal serves several essential functions:
+
+**1. Root Cause Analysis:** The key question remains: Was the failure caused by an issue within the software, or was it an external factor? With access to detailed logs, screenshots, and video, pinpointing the root cause becomes a far more efficient process.
+
+**2. Functional Area Identification:** Categorizing failures often reveals which area of the application is prone to issues, allowing for targeted remediation.
+
+**3. Severity Assessment:** Understanding the severity of a failure is critical. Is it an application issue that mandates postponing deployment, or is it a lesser issue that can be prioritized accordingly?
+
+In summary, the intelligent test failure categorization offered by ReportPortal is a cornerstone for delivering high-quality products swiftly and effectively. 

docs/features/QualityGates.md

@@ -0,0 +1,24 @@
+---
+sidebar_position: 7
+sidebar_label: Quality Gates
+---
+
+# Quality Gates
+
+Quality Gates is a feature thanks to which ReportPortal becomes an integral part of continuous testing platform. It prevents the code from moving forward if it doesn’t meet testing criteria. ReportPortal uses aggregated data and rule engine to verify testing results against required conditions.
+
+Top-3 benefits of Quality Gates:
+
+**Increased Speed and Efficiency**
+
+Automated GO / NO-GO decisions enable quick decision-making by instantly evaluating whether a particular build or code change meets the predefined quality criteria while tested. This eliminates the need for manual reviews at various stages of the process, allowing teams to release software more quickly and efficiently and avoid delays and human error.
+
+**Improved Consistency and Reliability**
+
+By setting standardized quality criteria, automated quality gates ensure that each code change adheres to the same high-quality standards. This consistency helps to reduce the likelihood of defects and errors, making the end product more reliable and robust.
+
+**Enhanced Collaboration and Accountability**
+
+Automated quality gates provide immediate, objective feedback that is accessible to all team members, from developers to QA to management. This shared understanding of what constitutes "quality" improves collaboration and holds everyone accountable for the quality of the software.
+
+In summary, Quality Gates are an essential feature in ReportPortal that helps to understand the quality of your product and make release decisions. 

docs/features/RESTAPI.md

@@ -0,0 +1,30 @@
+---
+sidebar_position: 7
+sidebar_label: REST API
+---
+
+# REST API
+
+ReportPortal offers a robust set of features through its REST API, covering test data, user data, project data, statistics, integrations, and more.
+
+The REST API can be particularly useful for those looking to:
+
+- Implement own reporter and integrate it with a custom testing framework or runner.
+- Retrieve data from ReportPortal for custom reports or integration with third-party systems.
+- Enhance functionality and develop add-ons.
+
+Here are the examples of how REST API can be helpful, including:
+
+**1. Creating/updating test results**, test runs, logs, adding attachments, and comments, and other information as attributes. It improves the testing process in general by supplying more context and information about the test results.
+
+**2. Integration with test management tools** (Jira, TestRail, and others). It allows to collect and manage test results and other data in one place.
+
+**3. Integration with bug tracking systems** (Jira Server, Jira Cloud, Azure DevOps, Rally, and others). This makes it possible to easily track issues.
+
+**4. Integration with CI/CD pipelines** (Jenkins, Travis CI, TeamCity, and others) for the real-time test results, faster feedback and quicker release cycles.
+
+**5. Integration with other systems** like Data Mart (Microsoft Dynamics, Power BI, Vertica). They serve for extensive data analysis.
+
+**6. Custom integration.** With REST API, you can create your own extensions. For example, if here there is no integration with specific test framework that you need, you can make any integration using API.
+
+Generally, REST API can be used for getting the most out of the test automation reporting tools such as ReportPortal and for the extension of capabilities. REST API allows to track and manage bugs in one central area, to design unique reports and dashboards that might offer insightful data and assist teams in making better decisions regarding the testing process.

docs/features/RealTimeReporting.md

@@ -0,0 +1,26 @@
+---
+sidebar_position: 5
+sidebar_label: Real-time reporting
+---
+
+# Real-time reporting
+
+Real-time test reporting provides the most current data without delay. Thanks to near real-time capabilities, you can receive the first test results in a matter of seconds after the execution has started and benefit from the advantage of getting the entire execution results before it is completed.
+
+Real-time reporting in ReportPortal comes with three main advantages:
+
+**Saving time on early reaction and Early Defect Identification**
+
+With test case results and logs appearing in ReportPortal in real-time, teams can begin triaging issues immediately. This not only saves time but also allows for early identification of defects, leading to quicker resolutions and improved code quality.
+
+At the same time, you can save time and effort with manual re-testing of failed test cases, while the entire execution is still on the go.
+
+**Maximized Testing Efficiency for Large Regressions**
+
+For extensive regression tests that may take several hours to complete, real-time reporting ensures that teams don't have to wait until the end to start analyzing results. They can begin the analysis while the rest of the tests are still running, thereby making optimal use of time and resources.
+
+**Streamlined Workflow with Continuous Feedback:**
+
+The real-time nature of the reporting enables a continuous feedback loop among testers, developers, and other stakeholders. This makes it easier to implement changes on the fly and ensures that everyone stays informed, reducing the likelihood of surprises at the end of the regression cycle.
+
+Overall, real-time reporting provides easy access to test results as soon as they are generated, allows to quickly identify issues and make decisions, reduces costs by preventing similar issues and ensures effective communication between team and stakeholders. 

docs/features/RichArtifactsInTestReports.md

@@ -0,0 +1,30 @@
+---
+sidebar_position: 4
+sidebar_label: Rich artifacts in test reports
+---
+
+# Rich artifacts in test reports
+
+Test execution report in ReportPortal may contain extra details in addition to the standard test results (passed/failed status).
+
+These additional artifacts in test reports can consist of:
+
+**1. Logs.**
+
+Logs can include error messages that are very helpful for test failure analysis. With logs, it is possible to understand the root cause and set the defect type properly.
+
+**2. Screenshots.**
+
+You can see the image of the data displayed on the screen during the test run. Screenshots make the debugging process easier and may give insights into why this issue occurred.
+
+**3. Video recordings.**
+
+Logs in ReportPortal can have video recordings attached as well. A video shows the exact screen states. Using this artifact, you will be able to troubleshoot problems more quickly.
+
+Besides, ReportPortal also supports integration with Sauce Labs via corresponding plugin so that it is possible to watch videos of test executions right in the ReportPortal.
+
+**4. Network traffic.**
+
+These are details about the network calls performed while the test was running (requests and responses).
+
+You can send all the artifacts to ReportPortal as attachments and use them to simplify defect triage, to replicate and debug issues, to find performance and network-related issues, to comprehend the context in which certain problems occurred.