Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EPMRPP-88588 || Upgrade Docusaurus to version 3 #654

Merged
merged 22 commits into from
Dec 26, 2023
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
654aff2
Add docusaurus-mdx-checker dependence
raikbitters Dec 19, 2023
0d0181a
Update docs files for supporting MDX3
raikbitters Dec 19, 2023
a9da589
Apply linter
raikbitters Dec 19, 2023
021725f
Impl yet-another-react-lightbox for mediaViewer
raikbitters Dec 19, 2023
5c3b282
Update mediaViewer dimensions
raikbitters Dec 20, 2023
63684e9
Update dependencies in package.json
raikbitters Dec 20, 2023
fe6c8f7
Update code highlighting themes in docusaurus.config.js
raikbitters Dec 20, 2023
46d4e72
Update mediaViewer README.md with corrected type values
raikbitters Dec 20, 2023
44c7a7a
Change MDXComponent mapping
raikbitters Dec 20, 2023
ed8253e
Update dependencies in package.json
raikbitters Dec 20, 2023
db12fb1
Update import statements and export default in docusaurus.config.js a…
raikbitters Dec 20, 2023
c7c15cd
Fix formatting in FAQ index.md
raikbitters Dec 20, 2023
2a245af
Update searchButton.jsx to use useSearchLinkCreator
raikbitters Dec 20, 2023
90a8f95
Rewrite Swizzling for NotFound theme
raikbitters Dec 20, 2023
b148655
Change pop-up with iframe from video
raikbitters Dec 20, 2023
ecac7bb
Update video iframe attributes
raikbitters Dec 20, 2023
cb5604a
Remove picture-in-picture permission from video iframe
raikbitters Dec 20, 2023
b4d21e3
Fix link in AutoAnalysisOfLaunches.mdx
raikbitters Dec 22, 2023
da2f2e3
Fix links in Java client for launch log reporting
raikbitters Dec 22, 2023
a44186b
Update Node.js version to 20
raikbitters Dec 22, 2023
37720f1
Update Node.js version to 20 in CI and deploy workflows
raikbitters Dec 22, 2023
470eb91
Update package-lock.json with new versions of dependencies
raikbitters Dec 22, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
{
"name": "Node.js & TypeScript",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bullseye"

// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},

// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],

// Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": "yarn install",

// Configure tool-specific properties.
// "customizations": {},

// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
}
2 changes: 1 addition & 1 deletion docs/FAQ/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: 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? **
**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.

Expand Down
6 changes: 3 additions & 3 deletions docs/admin-panel/AllProjectsPage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The sorting can be performed by: Creation date, Name, Members, Launches, Last La
To find a project quickly, type 3 or more symbols of the project name into the
"Search" field.

<media-view thumbnail={require('./img/AllProjectsPage.png')} src="https://youtu.be/YxPc1bLFoqo" alt="All projects page in our test automation results dashboard" type="video" />
<MediaViewer thumbnail={require('./img/AllProjectsPage.png')} src="https://youtu.be/YxPc1bLFoqo" alt="All projects page in our test automation results dashboard" type="video" />

All Projects page allows:
- to create a project
Expand Down Expand Up @@ -100,7 +100,7 @@ button to complete the registration.
12. The user will be assigned to the project that the invitation was sent from, and to "Personal Project" with the PROJECT
MANAGER project role.

<media-view thumbnail={require('./img/InviteUserAllProjectsPage.png')} src="https://youtu.be/bqtJDSBjBIs" alt="Invite User from All Projects page" type="video" />
<MediaViewer thumbnail={require('./img/InviteUserAllProjectsPage.png')} src="https://youtu.be/bqtJDSBjBIs" alt="Invite User from All Projects page" type="video" />

:::note
The link for registration will be active until the user registers in the system for up to,
Expand Down Expand Up @@ -134,7 +134,7 @@ To delete a project, perform the following steps:

5. Click "Delete". The project will be deleted from ReportPortal.

<media-view thumbnail={require('./img/DeleteProject.png')} src="https://youtu.be/0ryP5Zf5_q8" alt="Delete Project" type="video" />
<MediaViewer thumbnail={require('./img/DeleteProject.png')} src="https://youtu.be/0ryP5Zf5_q8" alt="Delete Project" type="video" />

:::note
PERSONAL PROJECTS cannot be deleted from the system.
Expand Down
14 changes: 7 additions & 7 deletions docs/admin-panel/AllUsersPage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ To add a user on the "All Users" page, perform the following steps:
the system and assigned to the selected project, and to "Personal Project" with the
PROJECT MANAGER project role. Message with authorization data will be sent to the user's email.

<media-view thumbnail={require('./img/AddUserAllUsersPage.png')} src="https://youtu.be/LBLeaIbYIKc" alt="Add User From All Users Page in our test report dashboard" type="video" />
<MediaViewer thumbnail={require('./img/AddUserAllUsersPage.png')} src="https://youtu.be/LBLeaIbYIKc" alt="Add User From All Users Page in our test report dashboard" type="video" />

:::note
This is the only place in the system where an Administrator can be created
Expand Down Expand Up @@ -67,7 +67,7 @@ but not more than 24 hours. When the user clicks the link, he/she will see a reg
The user will be assigned to the project that was specified by you during the invitation,
and to "Personal Project" with the PROJECT MANAGER project role.

<media-view thumbnail={require('./img/InviteUserAllUsersPage.png')} src="https://youtu.be/228C6lLEpDE" alt="Invite User From All Users page" type="video" />
<MediaViewer thumbnail={require('./img/InviteUserAllUsersPage.png')} src="https://youtu.be/228C6lLEpDE" alt="Invite User From All Users page" type="video" />

## Assign user on project

Expand Down Expand Up @@ -104,7 +104,7 @@ To unassign a user from the project, perform the following steps:

5. Confirm the action. - The user will be unassigned from the project.

<media-view thumbnail={require('./img/AssignUnassignAllUsersPage.png')} src="https://youtu.be/AMETdsGPg1g" alt="Assign and Unassign User From All Users page" type="video" />
<MediaViewer thumbnail={require('./img/AssignUnassignAllUsersPage.png')} src="https://youtu.be/AMETdsGPg1g" alt="Assign and Unassign User From All Users page" type="video" />

## Edit user's project role

Expand All @@ -123,7 +123,7 @@ steps:

6. Click on the tick button.

<media-view thumbnail={require('./img/EditUserProjectRoleAllUsersPage.png')} src="https://youtu.be/SPsn1Pw3Tno" alt="Edit Project Role From All Users page" type="video" />
<MediaViewer thumbnail={require('./img/EditUserProjectRoleAllUsersPage.png')} src="https://youtu.be/SPsn1Pw3Tno" alt="Edit Project Role From All Users page" type="video" />

## Delete user

Expand All @@ -140,7 +140,7 @@ To delete a user from ReportPortal, perform the following steps:
5. Click the "Delete" button. The user will be deleted from the ReportPortal. All launches and shared data (filters,
dashboards and widgets), that the user owns on the projects will be kept in ReportPortal.

<media-view thumbnail={require('./img/DeleteUserAllUsersPage.png')} src="https://youtu.be/T5PYG91iygU" alt="Delete User" type="video" />
<MediaViewer thumbnail={require('./img/DeleteUserAllUsersPage.png')} src="https://youtu.be/T5PYG91iygU" alt="Delete User" type="video" />

## Edit user account role

Expand All @@ -161,7 +161,7 @@ To give Administrator role for any user, perform the following steps:
5. Click "Change" button on pop-up window. Account role User will be changed to
Administrator. The user account will be marked with "admin" label.

<media-view thumbnail={require('./img/MakeAdmin.png')} src="https://youtu.be/ZkACZLc1wAk" alt="Change Account Role to Administrator" type="video" />
<MediaViewer thumbnail={require('./img/MakeAdmin.png')} src="https://youtu.be/ZkACZLc1wAk" alt="Change Account Role to Administrator" type="video" />

**Take away ADMINISTRATOR role**

Expand All @@ -178,4 +178,4 @@ To take away Administrator account role, perform the following steps:
5. Click "Change" button. Account role "Administrator" will be changed to
"User".

<media-view thumbnail={require('./img/TakeAwayAdminRole.png')} src="https://youtu.be/pJbbmuXK2ZQ" alt="Take away Administrator role" type="video" />
<MediaViewer thumbnail={require('./img/TakeAwayAdminRole.png')} src="https://youtu.be/pJbbmuXK2ZQ" alt="Take away Administrator role" type="video" />
4 changes: 2 additions & 2 deletions docs/admin-panel/EventMonitoring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To view the list of all activities within your project, open the menu at the bot

Here, you will find a table with the following columns: Time, User, Action, Object Type, Object Name, Old Value, and New Value.

<media-view src={require('./img/EventMonitoring.png')} alt="Event monitoring in our test report dashboard" />
<MediaViewer src={require('./img/EventMonitoring.png')} alt="Event monitoring in our test report dashboard" />

### Time

Expand Down Expand Up @@ -45,7 +45,7 @@ The **Old Value** and **New Value** columns display the changes that were made.

You can filter activities by user, action, object type, and object name.

<media-view thumbnail={require('./img/EventMonitoring.png')} src="https://youtu.be/_Gz3s3PYYac" alt="Event monitoring in our test automation dashboard" type="video" />
<MediaViewer thumbnail={require('./img/EventMonitoring.png')} src="https://youtu.be/_Gz3s3PYYac" alt="Event monitoring in our test automation dashboard" type="video" />

Another way to view the event list in your project is by creating a ["Project Activity Panel" widget](/dashboards-and-widgets/ProjectActivityPanel).

Expand Down
18 changes: 9 additions & 9 deletions docs/analysis/AutoAnalysisOfLaunches.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ There are several ways to use an analyzer in our test automation reporting dashb

* Add info about Service Analyzer and service ElasticSearch in the docker-compose file;

* Set {vm.max_map_count} kernel setting before ReportPortal deploying with [command>](https://www.elastic.co/guide/en/elasticsearch/reference/6.1/docker.html#docker-cli-run-prod-mode);
* Set `{vm.max_map_count}` kernel setting before ReportPortal deploying with [command>](https://www.elastic.co/guide/en/elasticsearch/reference/6.1/docker.html#docker-cli-run-prod-mode);
raikbitters marked this conversation as resolved.
Show resolved Hide resolved

* Give right permissions to ElasticSearch data folder using the following command:
```javascript
Expand Down Expand Up @@ -70,7 +70,7 @@ The following info is sent:
* Unique ID;
* Test case ID;

For the better analysis, we merge small logs (which consist of 1-2 log lines and words number <= 100) together. We store this merged log message as a separate document if there are no other big logs (consisting of more than 2 log lines or having a stacktrace) in the test item. We store this merged log message in a separate field "merged_small_logs" for all the big logs if there are ones.
For the better analysis, we merge small logs (which consist of 1-2 log lines and words number less or equal 100) together. We store this merged log message as a separate document if there are no other big logs (consisting of more than 2 log lines or having a stacktrace) in the test item. We store this merged log message in a separate field "merged_small_logs" for all the big logs if there are ones.

The Analyzer preprocesses log messages from the request for test failure analysis: extracts error message, stacktrace, numbers, exceptions, urls, paths, parameters and other parts from text to search for the most similar items by these parts in the analytical base. These parts are saved in a separate fields for each log entry.

Expand Down Expand Up @@ -177,7 +177,7 @@ All settings and configurations of Analyzer and ElasticSearch are situated on a

2. Come on Project Settings, choose Auto-Analysis section;

<media-view thumbnail={require('./img/AutoAnalysisSettings.png')} src="https://youtu.be/0AK2OHD79Ps" alt="Auto-analysis settings for AI-based defects triage" type="video" />
<MediaViewer thumbnail={require('./img/AutoAnalysisSettings.png')} src="https://youtu.be/0AK2OHD79Ps" alt="Auto-analysis settings for AI-based defects triage" type="video" />

In this section user can perform the following actions:

Expand Down Expand Up @@ -242,7 +242,7 @@ You can **remove the Index from ElasticSearch** and all logs with there defect t
Your investigations in ReportPortal will not be changed. The operation concerns only ElasticSearch base.
:::

<media-view thumbnail={require('./img/RemoveIndex.png')} src="https://youtu.be/4Xhwu7NSeQ4" alt="Remove Index" type="video" />
<MediaViewer thumbnail={require('./img/RemoveIndex.png')} src="https://youtu.be/4Xhwu7NSeQ4" alt="Remove Index" type="video" />

Another option, you can **generate the Index in ElasticSearch**. In the case of generation, all data will be removed from ElasticSearch and the new one will be generated based on all previous investigations on the project following current analysis settings.

Expand All @@ -257,7 +257,7 @@ The new base will be generated following logs and settings that are existing on
:::
* you have changed a parameter **Number of log lines** for 3. But your existing index contains logs with value ALL. You can generate a new index, the old index will be removed, and a new one will be generated. Logs in the new index will contain 3 lines;

<media-view thumbnail={require('./img/GenerateIndex.png')} src="https://youtu.be/HYvtZmIzfiA" alt="Generate Index" type="video" />
<MediaViewer thumbnail={require('./img/GenerateIndex.png')} src="https://youtu.be/HYvtZmIzfiA" alt="Generate Index" type="video" />

We strongly do not recommend use auto-analysis until the new index will be generated.

Expand Down Expand Up @@ -308,22 +308,22 @@ For option **Only current launch** you can not choose *Items analyzed automatica

Any launches with an active analyzing process will be marked with the "Analysis" label.

<media-view thumbnail={require('./img/AutoAnalysisLaunchedManually.png')} src="https://youtu.be/OmT2exhOdC4" alt="Auto-Analysis Launched Manually" type="video" />
<MediaViewer thumbnail={require('./img/AutoAnalysisLaunchedManually.png')} src="https://youtu.be/OmT2exhOdC4" alt="Auto-Analysis Launched Manually" type="video" />

## Label AA

When the test item is analyzed by the ReportPortal, a label "AA" is set on the test item on a Step Level. You can filter results with a parameter “Analysed by RP (AA)”

<media-view src={require('./img/LabelAA.png')} alt="Label AA" />
<MediaViewer src={require('./img/LabelAA.png')} alt="Label AA" />

## Ignore in Auto-Analysis

If you don't want to save some test items in ElasticSearch, you can "Ignore in Auto-Analysis". For that you can choose this action in “Make decision” modal:

<media-view src={require('./img/IgnoreInAutoAnalysis1.png')} alt="Ignore in Auto-Analysis" />
<MediaViewer src={require('./img/IgnoreInAutoAnalysis1.png')} alt="Ignore in Auto-Analysis" />

Or from the action list for several test items:

<media-view src={require('./img/IgnoreInAutoAnalysis2.png')} alt="Auto-Analysis Ignore Action List" />
<MediaViewer src={require('./img/IgnoreInAutoAnalysis2.png')} alt="Auto-Analysis Ignore Action List" />

When you choose “Ignore in AA”, logs of the chosen item are removed from the ElasticSearch.
4 changes: 2 additions & 2 deletions docs/analysis/MLSuggestions.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ The ElasticSearch returns to the service Analyzer 10 logs with the highest score
* whether it has the same unique id, from the same launch
* the probability for being of a specific defect type given by the Random Forest Classifier trained on Tf-Idf vectors

The model gives a probability for each candidate, we filter out test items with the probability <= 40%. We sort the test items by this probability, after that we deduplicate test items inside this ranked list. If two test items are similar with >= 98% by their messages, then we will leave the test item with the highest probability. After deduplication we take maximimum 5 items with the highest score to show in the ML Suggestions section.
The model gives a probability for each candidate, we filter out test items with the probability less or equal 40%. We sort the test items by this probability, after that we deduplicate test items inside this ranked list. If two test items are similar with >= 98% by their messages, then we will leave the test item with the highest probability. After deduplication we take maximimum 5 items with the highest score to show in the ML Suggestions section.

ML suggestions section contains at maximum 5 suggested items, they are shown together with the scores given by the model and we divide them into 3 groups:
* the group "SAME", test items with the score = 100%
* the group "HIGH", test items with the score in the range [70% - 99.9%]
* the group "LOW", test items with the score in the range [40% - 69.9%]

<media-view thumbnail={require('./img/MLSuggestions.png')} src="https://youtu.be/Ooggk-k5fTQ" alt="ML Suggestions" type="video" />
<MediaViewer thumbnail={require('./img/MLSuggestions.png')} src="https://youtu.be/Ooggk-k5fTQ" alt="ML Suggestions" type="video" />
Loading