Merge pull request #819 from reportportal/develop

Publish

docs/admin-panel/index.md

@@ -5,6 +5,14 @@ description: Efficiently manage projects and users with our Admin Panel. Explore
 
 # Admin Panel
 
+The **Admin Panel** is a comprehensive section dedicated to project and user management for administrators in our test automation dashboard. This category provides all the essential tools needed to effectively oversee and customize your platform. As an admin, you can set up and organize projects, ensuring they are aligned with the goals and structure of your organization.
+
+Within the Admin Panel, you can **manage user roles and permissions**, tailoring access based on specific responsibilities and ensuring that users have the appropriate level of control. This helps in maintaining a secure environment by limiting access to sensitive information and critical functionalities to only authorized individuals.
+
+Another key feature of the Admin Panel is **event monitoring**, which allows admins to track activities at both the project and instance levels. This ensures that you have real-time visibility into the actions taken within your system, helping in troubleshooting and security management. From user actions to system alerts, you can keep a close watch on the platform’s behavior and quickly address any issues that arise.
+
+Overall, the Admin Panel is designed to offer a robust and flexible interface that empowers administrators to manage both projects and users efficiently, ensuring that the platform remains secure, organized, and aligned with the organization’s needs.
+
 import DocCardList from '@theme/DocCardList';
 
 <DocCardList />

docs/analysis/index.md

@@ -5,6 +5,16 @@ description: Deep into ReportPortal's advanced analysis methods for robust test
 
 # Analysis
 
+The **Analysis** section in ReportPortal offers detailed documentation on the powerful features available to help you conduct faster and more efficient test automation results analysis. Learn how to effectively investigate failures, monitor trends, and improve the overall quality, reliability, and performance of your test automation processes using ReportPortal.
+
+ReportPortal provides multiple methods for analyzing test results, including **automatic, manual, and immediate analysis** options. For instance, features like Pattern Analysis, Unique Error Analysis, and Auto-Analysis are designed to run automatically by default, offering real-time insights into test failures without manual intervention. However, these features can also be triggered manually in case automatic analysis is turned off.
+
+The automated analysis capabilities in ReportPortal are particularly useful for reducing the time spent on defect triage. By automatically categorizing and analyzing test results, our test results reporting service helps you quickly identify recurring issues and potential areas for improvement. This not only saves time but also enhances the accuracy of defect detection.
+
+With Immediate Auto-Analysis and Immediate Pattern Analysis, you can start analyzing failed tests right away, without having to wait for the launch to be completed.
+
+By leveraging these advanced analysis features, ReportPortal helps you optimize your test processes, enhance defect management, and maintain higher standards of software quality.
+
 import DocCardList from '@theme/DocCardList';
 
 <DocCardList />

docs/api/versioned_sidebars/api-sidebars.ts

@@ -14,7 +14,7 @@ const apiSidebars: SidebarsConfig = {
     {
       type: 'html',
       defaultStyle: false,
-      value: versionCrumb(`v5.11`),
+      value: versionCrumb(`v5.12`),
       className: 'version-crumb',
     },
     {
@@ -30,6 +30,31 @@ const apiSidebars: SidebarsConfig = {
     },
   ],
   // This is the sidebar for versioned Service API
+  'service-api-5.11': [
+    {
+      type: 'html',
+      defaultStyle: false,
+      value: versionSelector(serviceApiVersions),
+      className: 'version-button',
+    },
+    {
+      type: 'html',
+      defaultStyle: false,
+      value: versionCrumb(`v5.11`),
+      className: 'version-crumb',
+    },
+    {
+      type: 'category',
+      label: 'Service API',
+      link: {
+        type: 'generated-index',
+        title: 'Service API',
+        description: 'This is a generated index of the ReportPortal Service API.',
+        slug: '/category/api/service-api-5.11'
+      },
+      items: require('../service-api/versions/5.11/sidebar.ts')
+    }
+  ],
   'service-api-5.10': [
     {
       type: 'html',

docs/api/versioned_sidebars/uat-sidebars.ts

@@ -14,7 +14,7 @@ const uatSidebars: SidebarsConfig = {
     {
       type: 'html',
       defaultStyle: false,
-      value: versionCrumb(`v5.11`),
+      value: versionCrumb(`v5.12`),
       className: 'version-crumb',
     },
     {
@@ -30,6 +30,31 @@ const uatSidebars: SidebarsConfig = {
     },
   ],
   // This is the sidebar for versioned Service UAT
+  'service-uat-5.11': [
+    {
+      type: 'html',
+      defaultStyle: false,
+      value: versionSelector(serviceUatVersions),
+      className: 'version-button',
+    },
+    {
+      type: 'html',
+      defaultStyle: false,
+      value: versionCrumb(`v5.11`),
+      className: 'version-crumb',
+    },
+    {
+      type: 'category',
+      label: 'Service Authorization',
+      link: {
+        type: 'generated-index',
+        title: 'Service Authorization',
+        description: 'This is a generated index of the ReportPortal Authtorization API.',
+        slug: '/category/api/service-uat-5.11'
+      },
+      items: require('../service-uat/versions/5.11/sidebar.ts')
+    }
+  ],
   'service-uat-5.10': [
     {
       type: 'html',

docs/case-studies/index.md

@@ -5,6 +5,12 @@ description: Discover success stories to see how top organizations improved proc
 
 # Case Studies
 
+The **Case Studies** section offers an in-depth look at how ReportPortal functions in real-world scenarios, highlighting its impact across various industries. Here, you’ll find success stories from businesses that have significantly improved their testing processes through the platform. By reading these case studies, you’ll see how ReportPortal accelerates test execution, enhances defect detection, and ultimately optimizes overall software quality, resulting in more reliable and faster product releases.
+
+Each case study demonstrates visible benefits, showing how organizations have used our test report dashboard to streamline their testing workflows. Whether you’re in finance, healthcare, retail, technology, or any other industry, these examples provide valuable insights into how the platform can address the specific challenges faced in different environments. You’ll learn how teams have reduced testing time, minimized human error, and improved product release cycles by implementing ReportPortal’s automated reporting and monitoring capabilities. The case studies also show how users have taken advantage of ReportPortal’s advanced features like real-time analytics and AI-based defect triage to drive higher efficiency and more accurate testing results.
+
+In addition to these real-world examples, this section offers practical tips and actionable ideas that can be applied to your own test automation strategy. Whether you’re looking to improve defect detection rates, speed up test execution, or enhance reporting accuracy, the lessons learned from these case studies will give you a deeper understanding of how to maximize the efficiency of your testing efforts using ReportPortal.
+
 import DocCardList from '@theme/DocCardList';
 
 <DocCardList />

docs/configuration/index.md

@@ -5,6 +5,14 @@ description: Set up your test report dashboard. Detailed configuration steps fro
 
 # Configuration
 
+The **Configuration** section is designed specifically for Project Managers, offering essential tools and information to help configure project settings and manage users effectively. In this section, you will find detailed guides that cover every aspect of setting up and customizing project settings to fit the unique needs of your team and organization. Whether you’re just starting a new project or refining an existing one, these resources will help ensure that your project runs smoothly and efficiently.
+
+**A key feature of this section** is its focus on **user management**. These guides will show you how to invite user on a project, assign roles to team members, and control access to various functionalities within the platform. This ensures that collaboration is smooth, secure, and aligned with the responsibilities of each team member.
+
+Additionally, this section covers the **Launches retention policy** – an important aspect of managing your project’s data. In ReportPortal, the retention policy determines how long regular launches, and their related data (such as logs and attachments) will be stored before they are automatically deleted. Understanding and configuring this policy is critical for optimizing storage usage and ensuring that old, unnecessary data doesn’t clutter your system.
+
+Thanks to the Configuration section, Project Managers can ensure efficient project setup, effective user management, and optimal data retention practices.
+
 import DocCardList from '@theme/DocCardList';
 
 <DocCardList />

docs/dashboards-and-widgets/index.md

@@ -5,6 +5,14 @@ description: Explore guides for dashboard & widget management, aiding effective,
 
 # Dashboards and widgets
 
+The **Dashboards and widgets** section is designed to help users create a powerful, customized test automation results dashboard that visualizes essential test automation metrics in real-time. Dashboards in ReportPortal serve as central hubs for tracking and analyzing your project’s quality, providing an accessible way to understand complex test data. Here, you’ll find guidance on creating dashboards to consolidate your test automation report data, allowing you to present critical insights effectively to your team or stakeholders.
+
+Using widgets, you can customize your dashboard to display specific metrics that matter most to your project. Widgets enable you to view real-time data on test results, defect trends, launch statistics, and much more. From tracking project health to identifying areas for improvement, widgets offer granular insights that are essential for optimizing test automation processes.
+
+Each widget type is designed to display different aspects of your testing data, from passing rates and error patterns to execution times. You’ll learn how to configure each widget, add them to your dashboard, and arrange them for maximum clarity and usability. These visualizations not only make it easier to monitor ongoing test results but also streamline the process of creating and sharing test automation reports with your team.
+
+By leveraging dashboards and widgets effectively, you can enhance your testing workflows, keep your team informed, and ensure data-driven decisions are at the heart of your QA process.
+
 import DocCardList from '@theme/DocCardList';
 
 <DocCardList />

docs/developers-guides/index.md

@@ -5,6 +5,14 @@ description: Enhance your test results dashboard with ReportPortal's comprehensi
 
 # Developers guides
 
+The **Developers guides** section is designed to provide comprehensive resources for developers who want to expand and enhance the functionality of ReportPortal. This section is essential for those who wish to customize our test automation reporting dashboard to meet their specific needs, offering a wealth of knowledge and practical tools to get the most out of ReportPortal, making your testing processes more efficient and effective.
+
+Here, you will find step-by-step tutorials that guide you through the process of building custom plugins and extending existing features. For instance, we offer a guide for developing a custom import plugin. These tutorials are crafted to help developers at any level - whether you're just starting with ReportPortal customization or you're an experienced developer looking to optimize the platform for more complex use cases.
+
+The API references available in this section provide detailed documentation on how to interact with ReportPortal programmatically. Alongside API documentation, you’ll also find practical examples and best practices to help you customize ReportPortal to fit your specific needs, ensuring optimal performance and functionality.
+
+Whether you’re looking to modify user interfaces, extend test reporting capabilities, or build custom integrations with other software development tools, the Developers guides section offers everything you need to fully leverage the power of ReportPortal for your project’s unique requirements and technical goals.
+
 import DocCardList from '@theme/DocCardList';
 
 <DocCardList />

docs/external-integrations/index.md

@@ -5,6 +5,14 @@ description: Enhance collaboration with our External Integrations section. Integ
 
 # External Integrations
 
+The **External Integrations** section of ReportPortal is designed to help you extend the capabilities of your test automation processes and enhance overall efficiency. Integrating external tools into our test automation reporting dashboard allows you to streamline workflows, improve data synchronization, and better manage your testing activities. This section provides essential information on how to connect and configure external systems.
+
+Currently, one external integration available in ReportPortal is with **testRigor**. This integration enables seamless data synchronization between the two platforms, 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 the quality of your software without the hassle of manually handling test information.
+
+Additionally, integrating external tools like testRigor into your ReportPortal environment helps enhance the overall test automation process by providing deeper insights into testing results and facilitating more informed decision-making. Whether you're managing large-scale projects or handling complex test cases, these integrations empower you to maintain a streamlined, efficient workflow.
+
+By taking advantage of the information in the External Integrations section, you can optimize your development and testing processes, ensuring that you get the most out of ReportPortal and the tools you already use.
+
 import DocCardList from '@theme/DocCardList';
 
 <DocCardList />

docs/features/VisualisationOfTestResults.md

@@ -13,7 +13,7 @@ One of ReportPortal's most compelling features is its real-time dashboards and w
 
 **Versatile Tracking**
 
-ReportPortal's widgets are designed to track essential metrics and trends in your test results. Whether you are interested in code coverage, performance metrics, or failure trends, there's a widget to help you monitor it. The real-time aspect ensures that any shifts in these metrics are immediately visible, allowing your team to adapt and respond more quickly than ever before.
+ReportPortal's widgets are designed to track essential metrics and trends in your test results. Whether you are interested in failure trends, test execution time, passing rate, there's a widget to help you monitor it. The real-time aspect ensures that any shifts in these metrics are immediately visible, allowing your team to adapt and respond more quickly than ever before.
 
 **Eye-Opening Insights**
 

docs/features/index.md

@@ -5,6 +5,12 @@ description: Discover ReportPortal's features like real-time reporting, AI-based
 
 # Features
 
+The **Features** section of ReportPortal outlines the powerful capabilities that make it one of the essential automation testing reporting tools for modern software development teams. ReportPortal is designed to simplify testing workflows, provide insights into test performance, and ensure higher-quality software through its diverse functionality. Each feature addresses key challenges in test automation, from organizing and categorizing test data to delivering real-time test reports and visual summaries.
+
+With ReportPortal, teams gain access to unified reporting that consolidates all test results in one place, making it easier to track trends and monitor project health. Intelligent categorization and AI-driven analysis help identify root causes of failures, streamlining the process of spotting bugs and prioritizing issues for faster resolution. In addition to improved tracking capabilities, users benefit from features that facilitate collaboration, allowing for easier issue management across teams and stakeholders. Real-time reporting and customizable dashboards offer immediate feedback, supporting agile workflows and informed decision-making.
+
+Moreover, ReportPortal’s flexibility allows teams to tailor the platform to their unique project requirements, from setting quality standards to automating integrations with existing tools through its REST API. These features empower teams to improve testing efficiency and reliability, making ReportPortal a comprehensive solution for elevating test automation to the next level.
+
 import DocCardList from '@theme/DocCardList';
 
 <DocCardList />

docs/installation-steps-advanced/index.md

@@ -5,6 +5,14 @@ description: Explore advanced installation capabilities to optimize your test au
 
 # Installation Steps Advanced
 
+The **Installation Steps Advanced** section is invaluable for those looking to go beyond basic installation, providing the knowledge and tools needed to maintain a stable, efficient, and high-performing environment for test management and reporting.
+
+In addition to system requirements, this section highlights the importance of performing regular maintenance. Keeping your instance updated with the latest patches and fixes will ensure you can avoid potential security vulnerabilities and performance issues. **The monitoring setup is equally important**, as it allows you to track the health and performance of your ReportPortal instance in real time. By setting up monitoring, you can quickly identify and resolve any issues that may arise, such as resource exhaustion or unexpected downtime.
+
+Installation Steps Advanced section offers valuable **insights into optimizing system configurations** to better handle large-scale projects or complex testing environments. It provides clear, actionable advice on managing tasks, safeguarding data, and scaling services to meet the growing demands of your project. Whether you're concerned with security, storage, or cloud integration, these advanced steps will guide you through the process of creating a more robust and adaptable ReportPortal instance.
+
+This section also covers other advanced configurations that help you maintain the efficiency and reliability of your test reporting environment. By following these advanced installation steps, you ensure that your ReportPortal instance is optimized for long-term success and can continue to support your growing test automation needs.
+
 import DocCardList from '@theme/DocCardList';
 
 <DocCardList />