Skip to content

Commit

Permalink
EPMRPP-90924 + EPMRPP-90831 || Add <meta name="description"> tag to c…
Browse files Browse the repository at this point in the history
…ategory + redirects (#736)
  • Loading branch information
pressayuliya authored May 23, 2024
1 parent 8ba6ea7 commit 5c14b42
Show file tree
Hide file tree
Showing 90 changed files with 1,283 additions and 967 deletions.
4 changes: 2 additions & 2 deletions docs/FAQ/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ For sure, you can explore ReportPortal [without installation](/reportportal-tuto

**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.
The initial steps involve installing and configuring the tool. [Installation steps](/installation-steps) you can find in our documentation.

**8. Does the tool integrate with my existing test automation framework?**

Expand All @@ -49,7 +49,7 @@ ReportPortal is licensed under Apache v2.0, which means it’s free to use, come

**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.
At that moment, we offer the only premium feature – [Quality Gates](/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?**

Expand Down
4 changes: 1 addition & 3 deletions docs/admin-panel/_category_.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"label": "Admin Panel",
"position": "14",
"link": {
"type": "generated-index"
}
"link": {"type": "doc", "id": "index"}
}
10 changes: 10 additions & 0 deletions docs/admin-panel/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Admin Panel
description: Efficiently manage projects and users with our Admin Panel. Explore event monitoring and more for your centralized test automation tool.
---

# Admin Panel

import DocCardList from '@theme/DocCardList';

<DocCardList />
4 changes: 1 addition & 3 deletions docs/analysis/_category_.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"label": "Analysis",
"position": "11",
"link": {
"type": "generated-index"
}
"link": {"type": "doc", "id": "index"}
}
10 changes: 10 additions & 0 deletions docs/analysis/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Analysis
description: Deep into ReportPortal's advanced analysis methods for robust test automation metrics & efficient defect triaging.
---

# Analysis

import DocCardList from '@theme/DocCardList';

<DocCardList />
5 changes: 2 additions & 3 deletions docs/case-studies/_category_.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"label": "Case Studies",
"position": "19",
"link": {
"type": "generated-index"
}
"link": {"type": "doc", "id": "index"}
}

10 changes: 10 additions & 0 deletions docs/case-studies/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Case Studies
description: Discover success stories to see how top organizations improved processes thanks to our test automation reporting dashboard.
---

# Case Studies

import DocCardList from '@theme/DocCardList';

<DocCardList />
4 changes: 1 addition & 3 deletions docs/dashboards-and-widgets/_category_.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"label": "Dashboards and widgets",
"position": "13",
"link": {
"type": "generated-index"
}
"link": {"type": "doc", "id": "index"}
}
10 changes: 10 additions & 0 deletions docs/dashboards-and-widgets/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Dashboards and widgets
description: Explore guides for dashboard & widget management, aiding effective, real-time test failure analytics.
---

# Dashboards and widgets

import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ POST `/v2/{projectName}/log` - Create log.
## Differences in reporting

### Launch rerun
[Rerun developers guide](/dev-guides/RerunDevelopersGuide)
[Rerun developers guide](/developers-guides/RerunDevelopersGuide)

### Nested steps
[Nested steps wiki](https://github.com/reportportal/client-java/wiki/Nested-steps)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,19 +63,19 @@ rp.reporting.async=true

Async controllers have `/api/v2` prefix.
Requests and responses have no differences with sync ones but there are some specific distinctions in the behavior that is described in
[reporting guide](/dev-guides/ReportingDevelopersGuide).

* [Start launch](/dev-guides/ReportingDevelopersGuide#start-launch)
* [Start root(suite) item](/dev-guides/ReportingDevelopersGuide#start-rootsuite-item)
* [Start child(container) item](/dev-guides/ReportingDevelopersGuide#start-childcontainer-item)
* [Start child(step) item](/dev-guides/ReportingDevelopersGuide#start-childstep-item)
* [Finish child item](/dev-guides/ReportingDevelopersGuide#finish-child-item)
* [Finish parent(container) item](/dev-guides/ReportingDevelopersGuide#finish-parentcontainer-item)
* [Save single log without attachment](/dev-guides/ReportingDevelopersGuide#save-single-log-without-attachment)
* [Batch save logs](/dev-guides/ReportingDevelopersGuide#batch-save-logs)
* [Save launch log](/dev-guides/ReportingDevelopersGuide#save-launch-log)
* [Finish root(suite) item](/dev-guides/ReportingDevelopersGuide#finish-rootsuite-item)
* [Finish launch](/dev-guides/ReportingDevelopersGuide#finish-launch)
[reporting guide](/developers-guides/ReportingDevelopersGuide).

* [Start launch](/developers-guides/ReportingDevelopersGuide#start-launch)
* [Start root(suite) item](/developers-guides/ReportingDevelopersGuide#start-rootsuite-item)
* [Start child(container) item](/developers-guides/ReportingDevelopersGuide#start-childcontainer-item)
* [Start child(step) item](/developers-guides/ReportingDevelopersGuide#start-childstep-item)
* [Finish child item](/developers-guides/ReportingDevelopersGuide#finish-child-item)
* [Finish parent(container) item](/developers-guides/ReportingDevelopersGuide#finish-parentcontainer-item)
* [Save single log without attachment](/developers-guides/ReportingDevelopersGuide#save-single-log-without-attachment)
* [Batch save logs](/developers-guides/ReportingDevelopersGuide#batch-save-logs)
* [Save launch log](/developers-guides/ReportingDevelopersGuide#save-launch-log)
* [Finish root(suite) item](/developers-guides/ReportingDevelopersGuide#finish-rootsuite-item)
* [Finish launch](/developers-guides/ReportingDevelopersGuide#finish-launch)

### Detailed scheme of interactions between RabbitMq and API

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ On the step view we can see that items with names `getActivitiesForProject`, `ge

#### Using API

To start launch rerun you should call [default start launch endpoint](/dev-guides/ReportingDevelopersGuide#start-launch) adding `"rerun"=true` parameter in the request body.
To start launch rerun you should call [default start launch endpoint](/developers-guides/ReportingDevelopersGuide#start-launch) adding `"rerun"=true` parameter in the request body.

```json
{
Expand Down Expand Up @@ -89,7 +89,7 @@ If system cannot find launch with the same name - system throws error with `404`

#### Using API

To start launch rerun you should call [default start launch endpoint](/dev-guides/ReportingDevelopersGuide#start-launch) adding `"rerun"=true` and `"rerunOf"=launch_uuid` parameters in the request body. Where `launch_uuid` is UUID of launch that have to be reruned.
To start launch rerun you should call [default start launch endpoint](/developers-guides/ReportingDevelopersGuide#start-launch) adding `"rerun"=true` and `"rerunOf"=launch_uuid` parameters in the request body. Where `launch_uuid` is UUID of launch that have to be reruned.

```json
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ On the `Log view` you can also switch between `Retries`:

## Retries reporting

Common child `Test item` request ([check reporting dev guide](/dev-guides/ReportingDevelopersGuide)) looks like:
Common child `Test item` request ([check reporting dev guide](/developers-guides/ReportingDevelopersGuide)) looks like:

```shell
curl --header "Content-Type: application/json" \
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"label": "Developers guides",
"position": "9",
"link": {
"type": "generated-index"
}
"link": {"type": "doc", "id": "index"}
}
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
10 changes: 10 additions & 0 deletions docs/developers-guides/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Developers guides
description: Enhance your test results dashboard with ReportPortal's comprehensive Developers' guides.
---

# Developers guides

import DocCardList from '@theme/DocCardList';

<DocCardList />
5 changes: 2 additions & 3 deletions docs/external-integrations/_category_.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"label": "External Integrations",
"position": "16",
"link": {
"type": "generated-index"
}
"link": {"type": "doc", "id": "index"}
}

10 changes: 10 additions & 0 deletions docs/external-integrations/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: External Integrations
description: Enhance collaboration with our External Integrations section. Integrate with tools for end to end testing reporting tools.
---

# External Integrations

import DocCardList from '@theme/DocCardList';

<DocCardList />
4 changes: 1 addition & 3 deletions docs/features/_category_.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"label": "Features",
"position": "2",
"link": {
"type": "generated-index"
"link": {"type": "doc", "id": "index"}
}
}
10 changes: 10 additions & 0 deletions docs/features/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Features
description: Discover ReportPortal's features like real-time reporting, AI-based defects triage, visualization of test data and more.
---

# Features

import DocCardList from '@theme/DocCardList';

<DocCardList />
2 changes: 1 addition & 1 deletion docs/installation-steps/ScalingUpReportPortalAPIService.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Scaling Up the ReportPortal Service API

# Scaling Up the ReportPortal Service API

Due to the current implementation specifics [Asynchronous Reporting Scheme](/dev-guides/AsynchronousReporting#scheme), horizontal auto-scaling of the ReportPortal service API is not feasible. However, manual scaling is achievable. This limitation stems from the way RabbitMQ, in conjunction with the API, manages the number of queues on the RabbitMQ side.
Due to the current implementation specifics [Asynchronous Reporting Scheme](/developers-guides/AsynchronousReporting#scheme), horizontal auto-scaling of the ReportPortal service API is not feasible. However, manual scaling is achievable. This limitation stems from the way RabbitMQ, in conjunction with the API, manages the number of queues on the RabbitMQ side.

Given that ReportPortal can receive a substantial volume of concurrent streams from different project spaces, a mechanism has been implemented. This mechanism determines the number of queues based on the hash of the launch object and distributes them across different queues to increase the likelihood of processing.

Expand Down
5 changes: 2 additions & 3 deletions docs/installation-steps/_category_.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"label": "Installation Steps",
"position": "4",
"link": {
"type": "generated-index"
}
"link": {"type": "doc", "id": "index"}
}

10 changes: 10 additions & 0 deletions docs/installation-steps/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Installation Steps
description: Explore step-by-step instructions for deploying ReportPortal, a powerful, centralized test automation tool.
---

# Installation Steps

import DocCardList from '@theme/DocCardList';

<DocCardList />
2 changes: 1 addition & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ReportPortal is a TestOps service, that provides increased capabilities to speed
ReportPortal is a great addition to Continuous Integration and Continuous
Testing process.

ReportPortal is distributed under the Apache v2.0 license, and it is free to use and modify, even for commercial purposes. We offer the only paid premium feature – [Quality Gates](/category/quality-gates).
ReportPortal is distributed under the Apache v2.0 license, and it is free to use and modify, even for commercial purposes. We offer the only paid premium feature – [Quality Gates](/quality-gates).

If a company is interested in our services, we can provide support hours to deploy, integrate, configure, or customize the tool, as well as [SaaS options](https://reportportal.io/pricing).

Expand Down
4 changes: 1 addition & 3 deletions docs/issues-troubleshooting/_category_.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"label": "Issues Troubleshooting",
"position": "18",
"link": {
"type": "generated-index"
}
"link": {"type": "doc", "id": "index"}
}
10 changes: 10 additions & 0 deletions docs/issues-troubleshooting/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Issues Troubleshooting
description: Utilize ReportPortal's Issues Troubleshooting guide for improved test report generation and effective bug triage.
---

# Issues Troubleshooting

import DocCardList from '@theme/DocCardList';

<DocCardList />
2 changes: 1 addition & 1 deletion docs/log-data-in-reportportal/ImplementOwnIntegration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Implement own integration

# Implement own integration

You can find a detailed description of how report results to ReportPortal in our [developers` guide](/dev-guides/ReportingDevelopersGuide).
You can find a detailed description of how report results to ReportPortal in our [developers` guide](/developers-guides/ReportingDevelopersGuide).

Based on this information you can create your integration with a test framework.

Expand Down
1 change: 1 addition & 0 deletions docs/log-data-in-reportportal/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Log data in ReportPortal
description: Discover how to efficiently import data, integrate test frameworks, and run your tests with our test reporting tool.
---

# Log data in ReportPortal
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 6

Please find the full list of available integrations with test frameworks in our [GitHub repositories](https://github.com/reportportal).

If you need further guidelines, you can explore our [Developers guides](/category/developers-guides).
If you need further guidelines, you can explore our [Developers guides](/developers-guides).

What you can do if you can not find your Test Framework?
You can create custom integrations. To get started, please look at our [Implement own Integration](/log-data-in-reportportal/ImplementOwnIntegration) page.
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/ManagePlugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ ReportPortal as a test management system can be reinforced by uploading plugins.
|E-mail server| With this plugin, you will be able to configure notifications about test result finish in real time.|
|SauceLabs| This plugin helps you to integrate ReportPortal with Sauce Labs and watch a video of test executions right in the ReportPortal application on the log view.
|LDAP/Active directory/SAML| This plugin helps authorize without new user creation|
| Implement your own plugin |https://reportportal.io/docs/dev-guides/PluginDevelopersGuide/|
| Implement your own plugin |[Plugin developers guide](/developers-guides/PluginDevelopersGuide)|

## Upload plugin

Expand Down
4 changes: 1 addition & 3 deletions docs/plugins/_category_.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"label": "Plugins",
"position": "15",
"link": {
"type": "generated-index"
}
"link": {"type": "doc", "id": "index"}
}
10 changes: 10 additions & 0 deletions docs/plugins/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Plugins
description: Explore seamless connections to Jira Server, Jira Cloud, E-mail server and other plugins for enhanced test reporting tool.
---

# Plugins

import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ will cut it off from the output.

Enterprise users can utilize our Quality Gates plugin to get more
control over application-under-test quality. To enable and configure Quality Gates plugin on
ReportPortal, please, refer to [corresponding documentation](/category/quality-gates).
ReportPortal, please, refer to [corresponding documentation](/quality-gates).

ReportPortal's Quality Gates plugin doesn't have native integration with GitHub Actions, so we
need to use a custom approach here. One way is polling ReportPortal Launch info API for
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ variable name in the logs.

Enterprise users can utilize our Quality Gates plugin to get more
control over application-under-test quality. To enable and configure Quality Gates plugin on
ReportPortal, please, refer to [corresponding documentation](/category/quality-gates).
ReportPortal, please, refer to [corresponding documentation](/quality-gates).

ReportPortal the Quality Gates plugin doesn't have native integration with GitLab, so we
need to use a custom approach here. One way is polling ReportPortal Launch info API for
Expand Down
4 changes: 1 addition & 3 deletions docs/quality-gates/_category_.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"label": "Quality Gates",
"position": "16",
"link": {
"type": "generated-index"
}
"link": {"type": "doc", "id": "index"}
}
10 changes: 10 additions & 0 deletions docs/quality-gates/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Quality Gates
description: Drive efficiency with Quality Gates. Configure rules, integrate with CI/CD for enhanced test report dashboard.
---

# Quality Gates

import DocCardList from '@theme/DocCardList';

<DocCardList />
4 changes: 1 addition & 3 deletions docs/releases/_category_.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"label": "Releases",
"position": "5",
"link": {
"type": "generated-index"
}
"link": {"type": "doc", "id": "index"}
}
10 changes: 10 additions & 0 deletions docs/releases/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Releases
description: Check out the most recent ReportPortal releases to enhance your test automation dashboard and QA metrics analysis.
---

# Releases

import DocCardList from '@theme/DocCardList';

<DocCardList />
Loading

0 comments on commit 5c14b42

Please sign in to comment.