EPMRPP-91432 || Reorganize RP Documentation sections (#749)

docs/FAQ/index.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 21
+sidebar_position: 23
 sidebar_label: FAQ
 ---
 
@@ -29,11 +29,11 @@ ReportPortal is containerized and can be orchestrated using either docker-compos
 
 **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.
+Check our [Tutorial](/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.
+For sure, you can explore ReportPortal [without installation](/tutorial/#how-to-explore-reportportal-without-installation) visiting our Demo instance.
 
 **7. How can I begin using ReportPortal?**
 
@@ -57,7 +57,7 @@ We provide ML-driven failure triage. Read [this article](https://reportportal.io
 
 **12. Do we need specific infrastructure prerequisites to avoid performance problems?**
 
-Look into [Optimal Performance Hardware setup](/installation-steps/OptimalPerformanceHardwareSetup).
+Look into [Hardware Requirements](/installation-steps/HardwareRequirements).
 
 **13. What types of reports can I generate with the ReportPortal?**
 
@@ -69,4 +69,4 @@ We do not support direct integration with performance testing frameworks, but as
 
 **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). 
+Our test automation reporting dashboard have integration with following Bug Tracking Systems: [Jira Server](/plugins/AtlassianJiraServer), [Jira Cloud](/plugins/AtlassianJiraCloud), [Azure DevOps](/plugins/AzureDevOps), and [Rally](/plugins/Rally). 

docs/admin-panel/AllProjectsPage.mdx

@@ -60,11 +60,11 @@ All Projects page allows:
 
 ## Create projects
 
-To create a project, please refer to [Creation of project and adding users](/reportportal-configuration/CreationOfProjectAndAddingUsers)
+To create a project, please refer to [Creation of project and adding users](/configuration/CreationOfProjectAndAddingUsers)
 
 ## Modify project settings
 
-To modify project settings please refer to [Project Configuration](/reportportal-configuration/ProjectConfiguration)
+To modify project settings please refer to [Project Configuration](/configuration/ProjectConfiguration)
 
 ## Invite user on "All Projects" page
 

docs/admin-panel/_category_.json

@@ -1,5 +1,5 @@
 {
   "label": "Admin Panel",
-  "position": "14",
+  "position": "15",
   "link": {"type": "doc", "id": "index"}
 }

docs/analysis/_category_.json

@@ -1,5 +1,5 @@
 {
   "label": "Analysis",
-  "position": "11",
+  "position": "12",
   "link": {"type": "doc", "id": "index"}
 }

docs/case-studies/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Case Studies",
-  "position": "19",
+  "position": "21",
   "link": {"type": "doc", "id": "index"}
 }
 

docs/reportportal-configuration/CreationOfProjectAndAddingUsers.md → docs/configuration/CreationOfProjectAndAddingUsers.md

@@ -55,7 +55,7 @@ The name should be unique and cannot be changed after saving.
 :::
 An Admin can configure the project settings or leave them as the default. 
 Project members with PROJECT_MANAGER roles are able to set up the project settings.
-To know how project settings could be updated, go to the [ProjectConfiguration](/reportportal-configuration/ProjectConfiguration) section.
+To know how project settings could be updated, go to the [ProjectConfiguration](/configuration/ProjectConfiguration) section.
 
 To know more about the project's management, go to "Administrate" section > "All Projects" page.
 

docs/reportportal-configuration/IntegrationViaPlugin.mdx → docs/configuration/IntegrationViaPlugin.mdx

@@ -9,14 +9,14 @@ Users can enhance ReportPortal by adding additional integrations with:
 * [Atlassian Jira Server](/plugins/AtlassianJiraServer)
 * [Atlassian Jira Cloud](/plugins/AtlassianJiraCloud)
 * [Rally](/plugins/Rally)
-* [Azure DevOps](/plugins/AzureDevOpsBTS)
-* [GitLab BTS](/plugins/GitLabBTS)
+* [Azure DevOps](/plugins/AzureDevOps)
+* [GitLab](/plugins/GitLab)
 * [Sauce Labs](/plugins/SauceLabs)
 * [E-mail server](/plugins/EmailServer)
-* [LDAP](/reportportal-configuration/authorization/LDAP)
-* [Active Directory](/reportportal-configuration/authorization/ActiveDirectory)
-* [Okta SAML](/reportportal-configuration/authorization/SamlProviders/OktaSaml)
-* [Azure SAML](/reportportal-configuration/authorization/SamlProviders/AzureSaml)
+* [LDAP](/plugins/authorization/LDAP)
+* [Active Directory](/plugins/authorization/ActiveDirectory)
+* [Okta SAML](/plugins/authorization/SamlProviders/OktaSaml)
+* [Azure SAML](/plugins/authorization/SamlProviders/AzureSaml)
 
 <MediaViewer src={require('./img/Integrations.png')} alt="Integrations with our test automation results dashboard" />
 

docs/reportportal-configuration/ProjectConfiguration.mdx → docs/configuration/ProjectConfiguration.mdx

@@ -27,7 +27,7 @@ The project settings are divided into following tabs: "General", "Integrations",
 Our test automation results dashboard allows you to control the amount of the stored data (launches, test items, logs and attachments) by removing outdated elements using Quartz jobs.
 Functionality of data removing depends on two configurations. 
 
-The first one is API service back-end environment variables that are described in [ReportPortal jobs configuration](/reportportal-configuration/ReportPortalJobsConfiguration)
+The first one is API service back-end environment variables that are described in [ReportPortal jobs configuration](/installation-steps-advanced/JobsConfiguration)
 
 The second one is the "General" tab you can configure parameter of data storage in ReportPortal for this project:
 
@@ -70,7 +70,7 @@ After this period a launch will be deleted, and you can not see it in ReportPort
 
 The "Integration" tab can allow the project to connect ReportPortal with external systems or rewrite global configurations for third party systems.
 
-For more information on this topic, please refer to [Integration with external systems](/reportportal-configuration/IntegrationViaPlugin).
+For more information on this topic, please refer to [Integration with external systems](/configuration/IntegrationViaPlugin).
 
 ### E-mail notifications
 

docs/configuration/_category_.json

@@ -0,0 +1,5 @@
+{
+  "label": "Configuration",
+  "position": "7",
+  "link": {"type": "doc", "id": "index"}
+}

docs/reportportal-configuration/index.md → docs/configuration/index.md

@@ -1,9 +1,9 @@
 ---
-title: ReportPortal Configuration
+title: Configuration
 description: Set up your test report dashboard. Detailed configuration steps from project creation to authorization.
 ---
 
-# ReportPortal Configuration
+# Configuration
 
 import DocCardList from '@theme/DocCardList';
 

docs/dashboards-and-widgets/_category_.json

@@ -1,5 +1,5 @@
 {
   "label": "Dashboards and widgets",
-  "position": "13",
+  "position": "14",
   "link": {"type": "doc", "id": "index"}
 }

docs/developers-guides/_category_.json

@@ -1,5 +1,5 @@
 {
   "label": "Developers guides",
-  "position": "9",
+  "position": "10",
   "link": {"type": "doc", "id": "index"}
 }

docs/external-integrations/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "External Integrations",
-  "position": "16",
+  "position": "17",
   "link": {"type": "doc", "id": "index"}
 }
 

docs/reportportal-glossary/index.mdx → docs/glossary/index.mdx

@@ -1,9 +1,9 @@
 ---
-sidebar_position: 20
-sidebar_label: ReportPortal Glossary
+sidebar_position: 22
+sidebar_label: Glossary
 ---
 
-# ReportPortal Glossary
+# Glossary
 
 ## Agent
 

docs/installation-steps/deploy-with-kubernetes/AmazonALBNGINXIngressController.md → docs/installation-steps-advanced/AmazonALBNGINXIngressController.md

@@ -109,4 +109,4 @@ ingress:
 <...>
 ```
 
-Follow the official guide [Deploy ReportPortal with Kubernetes](/installation-steps/deploy-with-kubernetes) to complete the deployment.
+Follow the official guide [Deploy ReportPortal with Kubernetes](/installation-steps/DeployWithKubernetes) to complete the deployment.

docs/reportportal-configuration/ReportPortalBackupRestoreGuide.md → docs/installation-steps-advanced/BackupRestoreGuide.md

@@ -1,9 +1,9 @@
 ---
 sidebar_position: 7
-sidebar_label: ReportPortal Backup & Restore Guide
+sidebar_label: Backup & Restore Guide
 ---
 
-# ReportPortal Backup & Restore Guide
+# Backup & Restore Guide
 
 ## Introduction
 

docs/installation-steps/BasicMonitoringConfiguration.md → docs/installation-steps-advanced/BasicMonitoringConfiguration.md

@@ -37,7 +37,7 @@ In addition to that, for the basic database monitoring is used PGHero tool - use
 Not recommended mixing the ReportPortal services and monitoring services on the same machine, especially in docker installation. 
 To avoid competition for resources with the services of the ReportPortal, deploy a separate virtual machine for monitoring (for our instances we using m5.large shape for the monitoring node) and install the following services: 
 
-1) InfluxDB database: https://docs.influxdata.com/influxdb/v2.0/install/?t=Docker;
+1) [InfluxDB database](https://docs.influxdata.com/influxdb/v2.0/install/?t=Docker);
 
 2) Grafana:
 Dashboard examples(Grafana IDs): 5955, 3056.

docs/installation-steps/DeployWithAWSECSFargate.md → docs/installation-steps-advanced/DeployWithAWSECSFargate.md

@@ -11,7 +11,7 @@ sidebar_label: Deploy with AWS ECS Fargate
 
 ReportPortal can be deployed using AWS ECS Fargate by interpreting the [docker-compose.yml](https://raw.githubusercontent.com/reportportal/reportportal/master/docker-compose.yml)
 
-### Pre-requisites
+### Prerequisites
 Ensure following services are available in the chosen AWS region & you have permissions to create/modify the resources.
 
 1. Elastic File System

docs/installation-steps/ReportPortal23.1FileStorageOptions.md → docs/installation-steps-advanced/FileStorageOptions.md

@@ -1,9 +1,9 @@
 ---
 sidebar_position: 12
-sidebar_label: ReportPortal 23.1 File storage options
+sidebar_label: File storage options
 ---
 
-# ReportPortal 23.1 File storage options
+# File storage options
 
 In ReportPortal 23.1 we can use multiple ways to store log attachments, user pictures and plugins.
 

docs/reportportal-configuration/ReportPortalJobsConfiguration.md → docs/installation-steps-advanced/JobsConfiguration.md

@@ -1,9 +1,9 @@
 ---
 sidebar_position: 4
-sidebar_label: ReportPortal jobs configuration
+sidebar_label: Jobs configuration
 ---
 
-# ReportPortal jobs configuration
+# Jobs configuration
 
 Currently, ReportPortal has 5 configurable jobs for data removing:
 * Clean launches

docs/installation-steps/MaintainCommandsCheatSheet.md → docs/installation-steps-advanced/MaintainCommandsCheatSheet.md

@@ -61,4 +61,4 @@ docker exec -i <postgres_container_name> psql -U <POSTGRES_USER> -d <database_na
 ```
 
 
-You can download [PDF file](./resources/CheatSheet.pdf) with commands.
+You can download [PDF file](../installation-steps/resources/CheatSheet.pdf) with commands.

docs/installation-steps/MigrateOneInstanceToAnother.md → docs/installation-steps-advanced/MigrateOneInstanceToAnother.md

@@ -37,4 +37,4 @@ Here's a general outline of the steps you should follow for the migration:
 
 Please consider referring to the official documentation for PostgreSQL, MinIO, and OpenSearch to make sure that the backup and migration processes are carried out appropriately.
 
-It's important to note that migrating local ReportPortal to the cloud also involves [infrastructure considerations](/installation-steps/OptimalPerformanceHardwareSetup/), security configurations, and networking setup that need to be in place for a smooth migration.
+It's important to note that migrating local ReportPortal to the cloud also involves [infrastructure considerations](/installation-steps/HardwareRequirements), security configurations, and networking setup that need to be in place for a smooth migration.

docs/reportportal-configuration/_category_.json → docs/installation-steps-advanced/_category_.json

@@ -1,5 +1,6 @@
 {
-  "label": "ReportPortal Configuration",
+  "label": "Installation Steps Advanced",
   "position": "5",
   "link": {"type": "doc", "id": "index"}
 }
+

docs/installation-steps-advanced/index.md

@@ -0,0 +1,10 @@
+---
+title: Installation Steps Advanced
+description: Explore advanced installation capabilities to optimize your test automation dashboard.
+---
+
+# Installation Steps Advanced
+
+import DocCardList from '@theme/DocCardList';
+
+<DocCardList />

docs/installation-steps/DeployWithDocker.md

@@ -84,6 +84,6 @@ Depending on your hardware configuration and the parameters of your system, you
  -c max_parallel_workers_per_gather=
 ``` 
 
-Please choose to set the values of these variables that are right for your system. You can also change the PostgreSQL host by passing a new value to the `POSTGRES_SERVER` environment [variable](/installation-steps/AdditionalConfigurationParameters).
+Please choose to set the values of these variables that are right for your system. You can also change the PostgreSQL host by passing a new value to the `POSTGRES_SERVER` environment [variable](/installation-steps-advanced/AdditionalConfigurationParameters).
 
-More info can be found at the following [link](/installation-steps/OptimalPerformanceHardwareSetup#5-postgresql-performance-tuning)
+More info can be found at the following [link](/installation-steps/HardwareRequirements#5-postgresql-performance-tuning)

docs/installation-steps/OptimalPerformanceHardwareSetup.mdx → docs/installation-steps/HardwareRequirements.mdx

@@ -1,9 +1,9 @@
 ---
 sidebar_position: 1
-sidebar_label: Optimal Performance Hardware setup
+sidebar_label: Hardware Requirements
 ---
 
-# Optimal Performance Hardware setup
+# Hardware Requirements
 
 Find below the recommended hardware configuration to set up ReportPortal and have good performance using our centralized test automation tool.
 

docs/issues-troubleshooting/_category_.json

@@ -1,5 +1,5 @@
 {
   "label": "Issues Troubleshooting",
-  "position": "18",
+  "position": "20",
   "link": {"type": "doc", "id": "index"}
 }

docs/log-data-in-reportportal/_category_.json

@@ -1,5 +1,5 @@
 {
   "label": "Log data in ReportPortal",
-  "position": "8",
+  "position": "9",
   "link": {"type": "doc", "id": "index"}
 }

docs/plugins/AtlassianJiraCloud.mdx

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 4
 sidebar_label: Atlassian Jira Cloud
 description: ReportPortal and Jira Cloud integration streamlines testing, tracks issues and enhances collaboration for improved productivity.
 ---

docs/plugins/AtlassianJiraServer.mdx

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 3
 sidebar_label: Atlassian Jira Server
 ---
 

docs/plugins/AzureDevOpsBTS.mdx → docs/plugins/AzureDevOps.mdx

@@ -1,11 +1,11 @@
 ---
-sidebar_position: 4
-sidebar_label: Azure DevOps BTS
+sidebar_position: 5
+sidebar_label: Azure DevOps
 ---
 
-# Azure DevOps BTS
+# Azure DevOps
 
-To install the Azure DevOps BTS plugin, see [Upload plugin](/plugins/ManagePlugins#upload-plugin) section.
+To install the Azure DevOps plugin, see [Upload plugin](/plugins/ManagePlugins#upload-plugin) section.
 
 Integration with our centralized test automation tool can be helpful for projects which are already using Azure DevOps BTS (Bug Tracking System) as a tracking tool. This feature allows posting issues and linking/unlinking issues, getting updates on their statuses. For example, just a few clicks – and bug with detailed logs is created!
 

docs/plugins/EmailServer.mdx

@@ -1,13 +1,13 @@
 ---
-sidebar_position: 8
+sidebar_position: 9
 sidebar_label: E-mail server
 ---
 
 # E-mail server
 
 E-mail server plugin is available in ReportPortal on the Plugins page.
 
-You don't need to download . It is already available in ReportPortal on the Plugins page.
+You don't need to download. It is already available in ReportPortal on the Plugins page.
 
 ## Add E-mail server integrations
 

docs/plugins/GitLabBTS.mdx → docs/plugins/GitLab.mdx

@@ -1,11 +1,11 @@
 ---
-sidebar_position: 5
-sidebar_label: GitLab BTS
+sidebar_position: 6
+sidebar_label: GitLab
 ---
 
-# GitLab BTS
+# GitLab
 
-To install the GitLab BTS plugin, see [Upload plugin](/plugins/ManagePlugins#upload-plugin) section.
+To install the GitLab plugin, see [Upload plugin](/plugins/ManagePlugins#upload-plugin) section.
 
 Integration with the GitLab Bug Tracking System (BTS) can be helpful for projects which are already using GitLab BTS as a tracking tool. The integration provides an exchange of information between our test automation reporting dashboard and the GitLab Server, such as posting issues and linking issues, getting updates on their statuses.