Skip to content

EPMRPP-111091 || Reorganize Log level docs#1059

Merged
maria-hambardzumian merged 3 commits intodevelopfrom
EPMRPP-111091
Jan 20, 2026
Merged

EPMRPP-111091 || Reorganize Log level docs#1059
maria-hambardzumian merged 3 commits intodevelopfrom
EPMRPP-111091

Conversation

@pressayuliya
Copy link
Contributor

@pressayuliya pressayuliya commented Jan 19, 2026

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Log level documentation covering levels, UI behaviors (filters, color-coding, full-width, pagination), timestamps, stack traces, attachments, history, and navigation aids.
    • Removed the Log view section from the View Launches guide; remaining content preserved.
    • Adjusted document ordering/metadata for one doc and applied a minor configuration formatting fix.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 19, 2026

Walkthrough

Extracted Log view content from ViewLaunches.mdx into a new dedicated LogLevel.mdx, updated a document's sidebar_position, and added a newline in docusaurus.config.js; no code or runtime behavior changes.

Changes

Cohort / File(s) Summary
Log Level documentation extraction
docs/work-with-reports/LogLevel.mdx (new), docs/work-with-reports/ViewLaunches.mdx
Created LogLevel.mdx with the full Log view / Log level documentation; removed the corresponding ~335-line Log section from ViewLaunches.mdx.
Sidebar ordering
docs/work-with-reports/LaunchesTestItemsAttributes.mdx
Updated front matter sidebar_position from 4 to 5.
Docusaurus config whitespace / redirects
docusaurus.config.js
Added end-of-file newline; (PR note mentioned redirect mappings conceptually, but changed file only shows EOF newline).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • Release 25.2 #1044 — touches the same Log view / Log level documentation areas and may overlap or duplicate extracted content.

Suggested reviewers

  • maria-hambardzumian
  • AmsterGet

Poem

🐰 I hopped through docs, tidy paws in flight,

Gathered logs that scattered into night.
A new LogLevel burrow, neat and bright,
Sidebar shifted, redirects tucked tight,
Hooray — documentation done just right! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: reorganizing Log level documentation by extracting it to a dedicated file and updating document ordering.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch EPMRPP-111091

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Fix all issues with AI agents
In `@docs/work-with-reports/LogLevel.mdx`:
- Around line 1-5: The frontmatter in LogLevel.mdx contains a placeholder
description ("description: test"); update the description field to a meaningful,
SEO-friendly sentence summarizing the page (e.g., explain log level purpose and
relevance), ensuring it includes key terms like "log level", "logging", and
"severity" and is concise (one short sentence). Locate the YAML frontmatter at
the top of the file (the description property) and replace "test" with the new
descriptive text so metadata/search indexes surface the correct summary.
- Around line 67-70: The sentence under the "Stack trace" heading contains an
unmatched asterisk and quote; edit the sentence in Log view to remove the stray
`*` and trailing quote and fix grammar — e.g., change "in this section you can
find *5 last error logs"." to "in this section you can find the 5 most recent
error logs." Ensure the "Stack trace" tab reference and Log view wording are
preserved and any emphasis uses matching asterisks if needed.
- Around line 284-289: The steps under the "To **turn ON pagination**" header
are incorrect: update step 3 to reference the correct option in the Pagination
block (e.g., select "Turn On Pagination" or the actual UI label used) and update
step 4 to the correct confirmation button label (e.g., "Turn On & Reload" or the
actual UI text). Ensure the text around the "Log Settings button" and
"Pagination block" matches the real UI labels so steps 3–4 are consistent with
the header.
🧹 Nitpick comments (2)
docs/work-with-reports/LogLevel.mdx (2)

11-16: Tighten heading grammar.

“Logs messages” reads awkwardly; “Log messages” is clearer.

✏️ Suggested update
-## Logs messages
+## Log messages

305-308: Reduce repetitive phrasing.

Line 307 repeats “In case …”. Consider a rephrase for readability.

✏️ Suggested rewrite
-On the log view you can find the number of error logs found in current item. In case no error logs, the "Show" button will be disabled with "No error logs" message. In case only one error log is found, the "Show" button will be available and by clicking on it you will be navigated to the correspondent page, and the error log will be highlighted. In case there is more than one error log, you will be able to switch between "Previous" and "Next" error logs.
+On the log view you can find the number of error logs found in the current item. If there are no error logs, the "Show" button is disabled and displays "No error logs". If only one error log is found, the "Show" button navigates you to that log and highlights it. If multiple error logs are found, you can switch between "Previous" and "Next" error logs.

Comment on lines +1 to +5
---
sidebar_position: 4
sidebar_label: Log level
description: test
---
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace placeholder description for SEO and clarity.

description: test looks like a placeholder and will surface in metadata.

✏️ Suggested update
-description: test
+description: Configure and understand log levels, log view behavior, and log settings in ReportPortal.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
---
sidebar_position: 4
sidebar_label: Log level
description: test
---
---
sidebar_position: 4
sidebar_label: Log level
description: Configure and understand log levels, log view behavior, and log settings in ReportPortal.
---
🤖 Prompt for AI Agents
In `@docs/work-with-reports/LogLevel.mdx` around lines 1 - 5, The frontmatter in
LogLevel.mdx contains a placeholder description ("description: test"); update
the description field to a meaningful, SEO-friendly sentence summarizing the
page (e.g., explain log level purpose and relevance), ensuring it includes key
terms like "log level", "logging", and "severity" and is concise (one short
sentence). Locate the YAML frontmatter at the top of the file (the description
property) and replace "test" with the new descriptive text so metadata/search
indexes surface the correct summary.

Comment on lines +67 to +70
## Stack trace

On the Log view for the fast redirection to the last 5 error log messages, please click on the tab Stack trace, in this section you can find *5 last error logs".

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix malformed emphasis/quote in Stack trace sentence.

Line 69 has an unmatched * and quote, which can break Markdown rendering.

✏️ Suggested update
-On the Log view for the fast redirection to the last 5 error log messages, please click on the tab Stack trace, in this section you can find *5 last error logs".
+On the Log view, click the Stack trace tab to quickly jump to the last 5 error log messages.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Stack trace
On the Log view for the fast redirection to the last 5 error log messages, please click on the tab Stack trace, in this section you can find *5 last error logs".
## Stack trace
On the Log view, click the Stack trace tab to quickly jump to the last 5 error log messages.
🤖 Prompt for AI Agents
In `@docs/work-with-reports/LogLevel.mdx` around lines 67 - 70, The sentence under
the "Stack trace" heading contains an unmatched asterisk and quote; edit the
sentence in Log view to remove the stray `*` and trailing quote and fix grammar
— e.g., change "in this section you can find *5 last error logs"." to "in this
section you can find the 5 most recent error logs." Ensure the "Stack trace" tab
reference and Log view wording are preserved and any emphasis uses matching
asterisks if needed.

Comment on lines +284 to +289
To **turn ON pagination**:

1. Go to the Log view (launch, suite, test, or step level).
2. Click the Log Settings button.
3. In the **Pagination block**, select "Turn Off Pagination" option.
4. Confirm the action by clicking "Turn Off & Reload".
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# First, let's examine the LogLevel.mdx file around the flagged lines
cat -n docs/work-with-reports/LogLevel.mdx | sed -n '270,300p'

Repository: reportportal/docs

Length of output: 1825


🏁 Script executed:

# Let's also search for pagination-related content in the documentation
rg -i "pagination" docs/work-with-reports/LogLevel.mdx -B 2 -A 5

Repository: reportportal/docs

Length of output: 3939


🏁 Script executed:

# Check if there are other pagination sections or similar documentation
fd "\.mdx$" docs/ | xargs grep -l -i "pagination"

Repository: reportportal/docs

Length of output: 96


Fix contradictory pagination instructions for turning ON pagination.

Lines 288–289 reference "Turn Off Pagination" and "Turn Off & Reload" while the section header "To turn ON pagination" indicates the opposite action. This appears to be copy-pasted from the preceding "turn OFF pagination" section. Update steps 3–4 to reference the correct UI option and button label for re-enabling pagination (verify against the actual UI labels in the Log Settings).

🤖 Prompt for AI Agents
In `@docs/work-with-reports/LogLevel.mdx` around lines 284 - 289, The steps under
the "To **turn ON pagination**" header are incorrect: update step 3 to reference
the correct option in the Pagination block (e.g., select "Turn On Pagination" or
the actual UI label used) and update step 4 to the correct confirmation button
label (e.g., "Turn On & Reload" or the actual UI text). Ensure the text around
the "Log Settings button" and "Pagination block" matches the real UI labels so
steps 3–4 are consistent with the header.

@maria-hambardzumian maria-hambardzumian merged commit 358a94b into develop Jan 20, 2026
2 checks passed
@maria-hambardzumian maria-hambardzumian deleted the EPMRPP-111091 branch January 20, 2026 08:33
maria-hambardzumian added a commit that referenced this pull request Jan 27, 2026
* Merge pull request #1059 from reportportal/EPMRPP-111091

EPMRPP-111091 || Reorganize Log level docs

* Update deploy-dev.yml to support OIDC auth for AWS

* Update permissions in deploy-dev workflow for OIDC

* EPMRPP-111752 || Add info about 'Change status' on Log and Step level (#1061)

Co-authored-by: Yuliya_Prihodko <Yuliya_Prihodko@epam.com>

---------

Co-authored-by: Yuliya Prihodko <107035036+pressayuliya@users.noreply.github.com>
Co-authored-by: Ilya <ilya_hancharyk@epam.com>
Co-authored-by: Yuliya_Prihodko <Yuliya_Prihodko@epam.com>
github-actions bot pushed a commit that referenced this pull request Jan 27, 2026
* Merge pull request #1059 from reportportal/EPMRPP-111091

EPMRPP-111091 || Reorganize Log level docs

* Update deploy-dev.yml to support OIDC auth for AWS

* Update permissions in deploy-dev workflow for OIDC

* EPMRPP-111752 || Add info about 'Change status' on Log and Step level (#1061)

Co-authored-by: Yuliya_Prihodko <Yuliya_Prihodko@epam.com>

---------

Co-authored-by: Yuliya Prihodko <107035036+pressayuliya@users.noreply.github.com>
Co-authored-by: Ilya <ilya_hancharyk@epam.com>
Co-authored-by: Yuliya_Prihodko <Yuliya_Prihodko@epam.com> 9390ed1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants