Skip to content

Commit

Permalink
EPMRPP-89807 || Improve anchor text for documentation (#724)
Browse files Browse the repository at this point in the history
  • Loading branch information
pressayuliya authored Apr 15, 2024
1 parent 28c89f6 commit f48f331
Show file tree
Hide file tree
Showing 16 changed files with 32 additions and 62 deletions.
2 changes: 1 addition & 1 deletion docs/FAQ/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ ReportPortal has a lot of widgets to visualize test results and understand the s

**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).
We do not support direct integration with performance testing frameworks, but as a workaround you can [import performance test results](https://github.com/reportportal/reportportal/issues/1820) in JUnit format into ReportPortal.

**15. Does ReportPortal have integration with Jira?**

Expand Down
2 changes: 1 addition & 1 deletion docs/dev-guides/BackEndJavaContributionGuide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,7 @@ This documentation should assist you in configuring the ReportPortal local devel

The simplified development workflow should look as follows:

- Always maintain the latest schema and data in your local DB instance using [these instructions](#how-to-keep-db-data-up-to-date).
- Always [maintain the latest schema and data](#how-to-keep-db-data-up-to-date) in your local DB instance.
- Checkout the `develop` branch in the required repository.
- Implement changes.
- If changes in dependencies are necessary:
Expand Down
4 changes: 1 addition & 3 deletions docs/dev-guides/ReportingDevelopersGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -659,6 +659,4 @@ Where body is:
}
```

## Example

Example using bash yo can find [here](https://github.com/ihar-kahadouski/dev-guide/tree/master/bash-example)
## [Example](https://github.com/ihar-kahadouski/dev-guide/tree/master/bash-example)
5 changes: 1 addition & 4 deletions docs/dev-guides/RerunDevelopersGuide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -153,10 +153,7 @@ If such item found - retry of the item will be created.

If not - new item will be created.

## Example

You can try to rerun launch [here](https://github.com/reportportal/examples-java)

## [Example](https://github.com/reportportal/examples-java)



Expand Down
4 changes: 2 additions & 2 deletions docs/dev-guides/RetriesReporting.mdx
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](https://github.com/reportportal/documentation/blob/master/src/md/src/DevGuides/reporting.md)) looks like:
Common child `Test item` request ([check reporting dev guide](/dev-guides/ReportingDevelopersGuide)) looks like:

```shell
curl --header "Content-Type: application/json" \
Expand Down Expand Up @@ -93,4 +93,4 @@ As a result 2 separate `Test items` will be displayed, so ORDER of sent requests

In ReportPortal the only `Test item` from the `Retries` group that has statistics and can have an `issue` attached is the one with max `startTime`.
In previous requests `startTime` was `1574423237000` for the first one and `1574423237100` for the second one, so the second one is a 'main' `Test Item`
with statistics and `issue` (if attached).
with statistics and `issue` (if attached).
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ sidebar_label: Additional configuration parameters
| RABBITMQ_DEFAULT_USER | rabbitmq | API,ANALYZER | PostgreSQL database name |
| RABBITMQ_DEFAULT_PASS | rabbitmq | API,ANALYZER | PostgreSQL database name |

Example of docker compose with filled out configuration parameters [can be found here](https://github.com/reportportal/reportportal/blob/master/docker-compose.yml).
[Example of docker compose](https://github.com/reportportal/reportportal/blob/master/docker-compose.yml) with filled out configuration parameters.
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,8 @@ Find more information about [gcloud credential helper](https://cloud.google.com/
Installation of ReportPortal requires setting up access to your GKE cluster for creating
a service account in GKE and providing permissions for some services to access Kubernetes API.

For adjusting access, you can do it using both Identity and Access Management (IAM)
and Kubernetes RBAC.
[Read](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control#iam-interaction) about it.
For adjusting access, you can do it using both [Identity and Access Management (IAM)
and Kubernetes RBAC](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control#iam-interaction).

You can use [Predefined GKE Roles](https://cloud.google.com/kubernetes-engine/docs/how-to/iam#predefined) and update
your account role. To set a service account on nodes, you must also have the Service Account User role (roles/iam.serviceAccountUser).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ rp.launch={NAME_OF_YOUR_LAUNCH}
Starting from the Service Release 23.1++, `rp.uuid` was renamed to `rp.api.key`.
:::

This set of properties will allow you to report your tests. And there are more properties available for fine grain tuning of integration. Details available [here](https://github.com/reportportal/client-java#property-file).
This set of properties will allow you to report your tests. And there are more [properties](https://github.com/reportportal/client-java#property-file) available for fine grain tuning of integration.

If you need a sophisticated and full-featured integration with a test framework, you can configure it by your self.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,8 @@ In this tutorial, we will walk you through the process of integrating ReportPort
To run your tests in any kind of CI, you first need a way to execute them in the
console. For example, for Java this might be calling a build tool like Gradle or Maven
with: `./gradlew test` or `./mvnw test` respectively. For Python, it might be
`pytest` command. Your tests should be already integrated with a ReportPortal agent. To
find out how to do that, check out our documentation on [corresponding
page](/log-data-in-reportportal/test-framework-integration/).
You also need a working ReportPortal instance. We will be using GitHub Actions secrets, to securely get our
credentials while the workflow is running, see official [GitHub Docs
](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) for more details.
`pytest` command. Your tests should be already [integrated with a ReportPortal agent](/log-data-in-reportportal/test-framework-integration/). You also need a working ReportPortal instance. We will be using GitHub Actions secrets, to securely get our
credentials while the workflow is running, see official [GitHub Docs](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) for more details.

## Using GitHub Actions workflow file

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,7 @@ In this tutorial we will walk you through the process of integrating ReportPorta
To run your tests in any kind of CI, you first need a way to execute them in the
console. E.G. for Java this might be calling a build tool like Gradle or Maven
with: `./gradlew test` or `./mvnw test` respectively. For Python it might be
`pytest` command. Your tests should be already integrated with a ReportPortal agent. To
find out how to do that, check out our documentation on [corresponding
page](/log-data-in-reportportal/test-framework-integration/).
You also need a working ReportPortal instance and access to your secret storage, E.G.
`pytest` command. Your tests should be already [integrated with a ReportPortal agent](/log-data-in-reportportal/test-framework-integration/). You also need a working ReportPortal instance and access to your secret storage, E.G.
[HashiCorp Vault](https://www.vaultproject.io/), to securely get your
credentials while the pipeline is running.

Expand Down
3 changes: 1 addition & 2 deletions docs/releases/Version23.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,7 @@ sidebar_label: Version 23.1

- [CVE-2018-10237](https://github.com/advisories/GHSA-mvr2-9pj6-7w5j), [CVE-2018-12022](https://github.com/advisories/GHSA-cjjf-94ff-43w7), [CVE-2018-12023](https://github.com/advisories/GHSA-6wqp-v4v6-c87c), [CVE-2018-14718](https://github.com/advisories/GHSA-645p-88qh-w398), [CVE-2018-14719](https://github.com/advisories/GHSA-4gq5-ch57-c2mg), [CVE-2018-14720](https://github.com/advisories/GHSA-x2w5-5m2g-7h5m), [CVE-2018-14721](https://github.com/advisories/GHSA-9mxf-g3x6-wv74), [CVE-2018-19360](https://github.com/advisories/GHSA-f9hv-mg5h-xcw9), [CVE-2018-19361](https://github.com/advisories/GHSA-mx9v-gmh4-mgqw), [CVE-2018-19362](https://github.com/advisories/GHSA-c8hm-7hpq-7jhg), [CVE-2019-11254](https://github.com/advisories/GHSA-wxc4-f4m6-wwqv), [CVE-2019-12814](https://github.com/advisories/GHSA-cmfg-87vq-g5g4), [CVE-2019-14892](https://github.com/advisories/GHSA-cf6r-3wgc-h863), [CVE-2019-14893](https://github.com/advisories/GHSA-qmqc-x3r4-6v39), [CVE-2019-16335](https://github.com/advisories/GHSA-85cw-hj65-qqv9), [CVE-2019-16942](https://github.com/advisories/GHSA-mx7p-6679-8g3q), [CVE-2019-16943](https://github.com/advisories/GHSA-fmmc-742q-jg75), [CVE-2019-17267](https://github.com/advisories/GHSA-f3j5-rmmp-3fc5), [CVE-2019-17531](https://github.com/advisories/GHSA-gjmw-vf9h-g25v), [CVE-2019-20330](https://github.com/advisories/GHSA-gww7-p5w4-wrfv), [CVE-2020-10650](https://github.com/advisories/GHSA-rpr3-cw39-3pxh), [CVE-2020-10672](https://github.com/advisories/GHSA-95cm-88f5-f2c7), [CVE-2020-10673](https://github.com/advisories/GHSA-fqwf-pjwf-7vqv), [CVE-2020-10968](https://github.com/advisories/GHSA-rf6r-2c4q-2vwg), [CVE-2020-10969](https://github.com/advisories/GHSA-758m-v56v-grj4), [CVE-2020-11111](https://github.com/advisories/GHSA-v3xw-c963-f5hc), [CVE-2020-11112](https://github.com/advisories/GHSA-58pp-9c76-5625), [CVE-2020-11619](https://github.com/advisories/GHSA-27xj-rqx5-2255), [CVE-2020-11620](https://github.com/advisories/GHSA-h4rc-386g-6m85), [CVE-2020-13956](https://github.com/advisories/GHSA-7r82-7xv7-xcpj), [CVE-2020-14040](https://github.com/advisories/GHSA-5rcv-m4m3-hfh7), [CVE-2020-14060](https://github.com/advisories/GHSA-j823-4qch-3rgm), [CVE-2020-14061](https://github.com/advisories/GHSA-c2q3-4qrh-fm48), [CVE-2020-14062](https://github.com/advisories/GHSA-c265-37vj-cwcc), [CVE-2020-15138](https://github.com/advisories/GHSA-wvhm-4hhf-97x9), [CVE-2020-24750](https://github.com/advisories/GHSA-qjw2-hr98-qgfh), [CVE-2020-25649](https://github.com/advisories/GHSA-288c-cq4h-88gq), [CVE-2020-29652](https://github.com/advisories/GHSA-3vm4-22fp-5rfm), [CVE-2020-35728](https://github.com/advisories/GHSA-5r5r-6hpj-8gg9), [CVE-2020-36179](https://github.com/advisories/GHSA-9gph-22xh-8x98), [CVE-2020-36180](https://github.com/advisories/GHSA-8c4j-34r4-xr8g), [CVE-2020-36181](https://github.com/advisories/GHSA-cvm9-fjm9-3572), [CVE-2020-36182](https://github.com/advisories/GHSA-89qr-369f-5m5x), [CVE-2020-36183](https://github.com/advisories/GHSA-9m6f-7xcq-8vf8), [CVE-2020-36184](https://github.com/advisories/GHSA-m6x4-97wx-4q27), [CVE-2020-36185](https://github.com/advisories/GHSA-8w26-6f25-cm9x), [CVE-2020-36186](https://github.com/advisories/GHSA-v585-23hc-c647), [CVE-2020-36187](https://github.com/advisories/GHSA-r695-7vr9-jgc2), [CVE-2020-36188](https://github.com/advisories/GHSA-f9xh-2qgp-cq57), [CVE-2020-36189](https://github.com/advisories/GHSA-vfqx-33qm-g869), [CVE-2020-36518](https://github.com/advisories/GHSA-57j2-w4cx-62h2), [CVE-2020-7746](https://github.com/advisories/GHSA-h68q-55jf-x68w), [CVE-2020-8840](https://github.com/advisories/GHSA-4w82-r329-3q67), [CVE-2021-20190](https://github.com/advisories/GHSA-5949-rw7g-wx7w), [CVE-2021-22060](https://github.com/advisories/GHSA-6gf2-pvqw-37ph), [CVE-2021-22096](https://github.com/advisories/GHSA-rfmp-97jj-h8m6), [CVE-2021-23341](https://github.com/advisories/GHSA-h4hr-7fg3-h35w), [CVE-2021-30640](https://github.com/advisories/GHSA-36qh-35cm-5w2w), [CVE-2021-32723](https://github.com/advisories/GHSA-gj77-59wh-66hg), [CVE-2021-33037](https://github.com/advisories/GHSA-4vww-mc66-62m6), [CVE-2021-3801](https://github.com/advisories/GHSA-hqhp-5p83-hx96), [CVE-2021-38561](https://github.com/advisories/GHSA-ppp9-7jff-5vj2), [CVE-2021-41079](https://github.com/advisories/GHSA-59g9-7gfx-c72p), [CVE-2021-4235](https://github.com/advisories/GHSA-r88r-gmrh-7j83), [CVE-2021-4279](https://github.com/advisories/GHSA-8gh8-hqwg-xf34), [CVE-2022-22950](https://github.com/advisories/GHSA-558x-2xjg-6232), [CVE-2022-22965](https://github.com/advisories/GHSA-36p3-wjmg-h94x), [CVE-2022-22969](https://github.com/advisories/GHSA-c2cp-3xj9-97w9), [CVE-2022-23181](https://github.com/advisories/GHSA-9f3j-pm6f-9fm5), [CVE-2022-24785](https://github.com/advisories/GHSA-8hfj-j24r-96c4), [CVE-2022-24999](https://github.com/advisories/GHSA-hrpp-h998-j3pp), [CVE-2022-27191](https://github.com/advisories/GHSA-8c26-wmh5-6g9v), [CVE-2022-28948](https://github.com/advisories/GHSA-hp87-p4gw-j4gq), [CVE-2022-31129](https://github.com/advisories/GHSA-wc69-rhjr-hc9g), [CVE-2022-32149](https://github.com/advisories/GHSA-69ch-w2m2-3vjp), [CVE-2022-40150](https://github.com/advisories/GHSA-x27m-9w8j-5vcw), [CVE-2022-40152](https://github.com/advisories/GHSA-3f7h-mf4q-vrm4), [CVE-2022-42003](https://github.com/advisories/GHSA-jjjh-jjxp-wpff), [CVE-2022-42004](https://github.com/advisories/GHSA-rgv9-q543-rqg4), [CVE-2022-42252](https://github.com/advisories/GHSA-p22x-g9px-3945), [CVE-2022-45685](https://github.com/advisories/GHSA-7rf3-mqpx-h7xg).

## 5. Link to Migration guide:
https://github.com/reportportal/reportportal/wiki/Migration-to-ReportPortal-v.23.1
## 5. [Migration guide](https://github.com/reportportal/reportportal/wiki/Migration-to-ReportPortal-v.23.1)

## 6. Released versions

Expand Down
30 changes: 8 additions & 22 deletions docs/releases/Version23.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,48 +7,36 @@ sidebar_label: Version 23.2

## 1. What's Changed:

- **New feature - Monitoring:**
- **New feature - [Monitoring](/admin-panel/EventMonitoring):**

A new Event Monitoring interface has been introduced, providing administrators with a convenient means to review all activities at the Project level through the Search & Filter functionality within the Admin panel. Events at the instance level are not visible on the UI, but they are securely stored in the database. This data can be easily transmitted to SIEM systems for future monitoring and analysis.
A new Event Monitoring interface has been introduced, providing administrators with a convenient means to review all activities at the Project level through the Search & Filter functionality within the Admin panel. Events at the instance level are not visible on the UI, but they are securely stored in the database. This data can be easily transmitted to SIEM systems for future monitoring and analysis.

More details can be found via the [link](/admin-panel/EventMonitoring).

- **Project Activity Panel Adjustments:**
- **[Project Activity Panel](/dashboards-and-widgets/ProjectActivityPanel) Adjustments:**

The list of project activities displayed in the Project Activity Panel has been expanded.

More details can be found via the [link](/dashboards-and-widgets/ProjectActivityPanel).

:::important

Please take into account that starting from this point forward, all events will have a new format for their storing in the database. Consequently, all events which have been stored prior to version 23.2 will be deleted.
:::

- **New feature – Delete Account:**
- **New feature – [Delete Account](/user-account/DeleteAccount):**

Now instance administrators can empower users to delete their accounts and obfuscate associated personal data.

More details can be found via the [link](/user-account/DeleteAccount).

- **New feature – Personal Data Retention policy:**
- **New feature – Personal [Data Retention policy](/user-account/DataRetentionProcedure):**

ReportPortal now offers the option to set a retention period for collected personal data during instance configuration.

More details can be found via the [link](/user-account/DataRetentionProcedure).

:::note
Please note that Features 3 and 4 are configurable, giving you the flexibility to decide whether you want to use these features or not. If you choose to utilize them, you can configure them using environmental variables. Further details can be found in the respective documentation.
:::

- **New feature – API Key:**
- **New feature – [API Key](/reportportal-configuration/HowToGetAnAccessTokenInReportPortal#2-authorization-with-users-api-key-for-agents):**

You can now generate as many API Keys as you need. You also have the ability to keep track of the creation date of API Keys and revoke any that are unused. Old tokens will still continue to function. Additionally, easy identification of the purpose of API Keys is facilitated through the use of prefixes.

More details can be found via the [link](/reportportal-configuration/HowToGetAnAccessTokenInReportPortal#2-authorization-with-users-api-key-for-agents).

- **Gitlab CI integration Workaround:**

More details can be found via the [link](/quality-gates/IntegrationWithCICD/IntegrationWithGitLabCI).
- **[Gitlab CI integration](/quality-gates/IntegrationWithCICD/IntegrationWithGitLabCI) Workaround:**

## 2. Small updates:

Expand Down Expand Up @@ -109,6 +97,4 @@ Configuration examples on the user profile page have been updated.
|Auto Analyzer|reportportal/service-auto-analyzer|5.10.0|
|Metrics Gatherer|reportportal/service-metrics-gatherer|5.10.0|

## 6. Link to Migration guide:

[Migration guide](https://github.com/reportportal/reportportal/wiki/Migration-to-ReportPortal-v.23.2)
## 6. [Migration guide](https://github.com/reportportal/reportportal/wiki/Migration-to-ReportPortal-v.23.2)
3 changes: 1 addition & 2 deletions docs/releases/Version24.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,5 +88,4 @@ Some of the environmental variables names are still ElasticSearch specific, but
|Auto Analyzer|reportportal/service-auto-analyzer|5.11.0|
|Metrics Gatherer|reportportal/service-metrics-gatherer|5.11.0|

## 7. Link to Migration Guide:
https://github.com/reportportal/reportportal/wiki/Migration-to-ReportPortal-v24.1
## 7. [Migration Guide](https://github.com/reportportal/reportportal/wiki/Migration-to-ReportPortal-v.24.1)
4 changes: 1 addition & 3 deletions docs/releases/Version5.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,7 @@ In this version we have:
- Manual set up [without Docker](/installation-steps/DeployWithoutDocker)
- [**v4 -> v5 data migration instruction**](https://github.com/reportportal/reportportal/wiki/Migration-to-ReportPortal-v.5)
## Plugins
Jira, Rally, SauceLabs integration now will work through the plugin functionality. You need to download latest JAR package from our Bintray repository, and drag-n-drop it ReportPortal in Administrative section -> Plugins.

Read more [here](/plugins/ManagePlugins#upload-plugin).
Jira, Rally, SauceLabs integration now will work through the plugin functionality. You need to download [latest JAR package](/plugins/ManagePlugins#upload-plugin) from our Bintray repository, and drag-n-drop it ReportPortal in Administrative section -> Plugins.

Available plugins to download:
- [Jira](/plugins/AtlassianJiraServer)
Expand Down
11 changes: 6 additions & 5 deletions docs/releases/Version5.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ sidebar_label: Version 5.1.0

# Version 5.1.0

>**Important**: We are constantly improving ReportPortal. And in version 5.1 we have changed a way we encrypt your personal data. Please be aware, that for successful interaction with version 5.1 you need to change a password at the first login.
> **Please read instructions below**.
>
> Thank you for being with us, ReportPortal team
:::important
We are constantly improving ReportPortal. And in version 5.1 we have changed a way we encrypt your personal data. Please be aware, that for successful interaction with version 5.1 you need to change a password at the first login.

Please read instructions below.
:::

## Brand new features
- [#893](https://github.com/reportportal/reportportal/issues/893) Improved ML in Аuto-Autoanalysis 2.0
Expand Down Expand Up @@ -50,4 +51,4 @@ sidebar_label: Version 5.1.0
LDAP returns Code 500 when the integration configuration is not correct

## How to migrate to the latest version 5.1
Details can be found [here](https://github.com/reportportal/reportportal/wiki/Migration-to-ReportPortal-v.5.1)
[Migration guide](https://github.com/reportportal/reportportal/wiki/Migration-to-ReportPortal-v.5.1)
Loading

0 comments on commit f48f331

Please sign in to comment.