Skip to content

EPMRPP-114802 || Implement canonical and robots meta tags for duplicated Docs case-study pages#1112

Merged
siarheirazuvalau merged 8 commits into
developfrom
feature/EPMRPP-114802-canonical-and-robots-meta-tags
May 7, 2026
Merged

EPMRPP-114802 || Implement canonical and robots meta tags for duplicated Docs case-study pages#1112
siarheirazuvalau merged 8 commits into
developfrom
feature/EPMRPP-114802-canonical-and-robots-meta-tags

Conversation

@a-rudak-EIS
Copy link
Copy Markdown
Contributor

@a-rudak-EIS a-rudak-EIS commented May 7, 2026

EPMRPP-114802 || Implement canonical and robots meta tags for duplicated Docs case-study pages

Summary

Add noindex,follow robots meta tag and custom canonical URLs to all 4 case study pages to point search engines to the canonical versions on reportportal.io (outside the /docs/ path).

Changes

  • Added explicit title frontmatter to ensure the page title is correctly set
  • Added inline <head> JSX block with robots meta tag and custom link rel="canonical" pointing to the corresponding pages on reportportal.io

Pages affected

  • docs/case-studies/ReducingRegressionTimeBy50.mdx
  • docs/case-studies/IncreasingTestAutomationStabilityAndVisibility.mdx
  • docs/case-studies/ReducingRegressionAnalysisEfforts.mdx
  • docs/case-studies/ImprovingTestAutomationStability.mdx
image image image image

Summary by CodeRabbit

Release Notes

  • Documentation
    • Enhanced case study pages with improved metadata organization and SEO configuration.
    • Reformatted case study content for better readability and visual presentation.

maria-hambardzumian and others added 7 commits March 19, 2026 20:23
Co-authored-by: Yuliya Prihodko <107035036+pressayuliya@users.noreply.github.com>
Co-authored-by: Yuliya_Prihodko <Yuliya_Prihodko@epam.com>
* Update pytest.md

* Merge pull request #1104 from reportportal/feature/EPMRPP-114901-Add-a-trigger-for-RP-docs-rebuild-on-release-creation-update

EPMRPP-114901 || Add a trigger for RP docs rebuild on release creation/update

---------

Co-authored-by: Vadzim Hushchanskou <HardNorth@users.noreply.github.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 7, 2026

Review Change Stack

Walkthrough

This PR updates four case study MDX files with consistent metadata and formatting improvements. Each file receives a structured frontmatter title and description, document head sections with SEO metadata (robots tag, canonical URL), and reformatted MediaViewer components to explicit multiline JSX syntax.

Changes

Case Study Documentation Enhancement

Layer / File(s) Summary
Frontmatter and Document Head
docs/case-studies/ImprovingTestAutomationStability.mdx, docs/case-studies/IncreasingTestAutomationStabilityAndVisibility.mdx, docs/case-studies/ReducingRegressionAnalysisEfforts.mdx, docs/case-studies/ReducingRegressionTimeBy50.mdx
Adds title and description frontmatter fields. Introduces <head> sections with robots meta tags set to noindex,follow and canonical link elements pointing to case study URLs.
MediaViewer Component Formatting
docs/case-studies/ImprovingTestAutomationStability.mdx, docs/case-studies/IncreasingTestAutomationStabilityAndVisibility.mdx, docs/case-studies/ReducingRegressionAnalysisEfforts.mdx, docs/case-studies/ReducingRegressionTimeBy50.mdx
Reformats MediaViewer from single-line JSX to multi-line format with src and alt props on separate lines, maintaining existing prop values.

Estimated Code Review Effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 Four tales now shine with metadata bright,
Frontmatter fields and head tags in sight,
MediaViewers spread their wings so wide,
In multiline format, full of pride!
Documentation hops along so right.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: adding canonical and robots meta tags to duplicated case-study documentation pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/EPMRPP-114802-canonical-and-robots-meta-tags

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.

@a-rudak-EIS a-rudak-EIS marked this pull request as ready for review May 7, 2026 07:52
Copy link
Copy Markdown

@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: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/case-studies/ReducingRegressionTimeBy50.mdx (1)

22-22: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Typo: "Unavailble" → "Unavailable"

✏️ Proposed fix
-  - Unavailble environments (15VMs) blocked by aggregation scripts
+  - Unavailable environments (15VMs) blocked by aggregation scripts
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/case-studies/ReducingRegressionTimeBy50.mdx` at line 22, Fix the typo
"Unavailble" to "Unavailable" in the case study text string inside
docs/case-studies/ReducingRegressionTimeBy50.mdx (the line that currently reads
"Unavailble environments (15VMs) blocked by aggregation scripts"); update that
phrase to "Unavailable environments (15 VMs) blocked by aggregation scripts"
making sure to correct the misspelling and optionally add a space in "15VMs" to
"15 VMs" for readability.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/case-studies/ReducingRegressionTimeBy50.mdx`:
- Around line 8-14: The MDX file inserts a <head> block with a <link
rel="canonical"> which may duplicate Docusaurus's auto-generated canonical; open
the rendered reducing-regression-time-by-50 page, inspect the document <head>,
and confirm there is exactly one <link rel="canonical"> pointing to
reportportal.io; if you find two, remove the manual <head> canonical from
ReducingRegressionTimeBy50.mdx (or the other three MDX files) and instead
override the theme-level SiteMetadata/Head component (swizzle Head or
SiteMetadata) to emit the single canonical you need so Docusaurus does not also
output a self-referencing tag.

---

Outside diff comments:
In `@docs/case-studies/ReducingRegressionTimeBy50.mdx`:
- Line 22: Fix the typo "Unavailble" to "Unavailable" in the case study text
string inside docs/case-studies/ReducingRegressionTimeBy50.mdx (the line that
currently reads "Unavailble environments (15VMs) blocked by aggregation
scripts"); update that phrase to "Unavailable environments (15 VMs) blocked by
aggregation scripts" making sure to correct the misspelling and optionally add a
space in "15VMs" to "15 VMs" for readability.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 428601b3-2cd2-417e-9528-31fa4c1186b6

📥 Commits

Reviewing files that changed from the base of the PR and between e6dd6f2 and ca21f55.

📒 Files selected for processing (4)
  • docs/case-studies/ImprovingTestAutomationStability.mdx
  • docs/case-studies/IncreasingTestAutomationStabilityAndVisibility.mdx
  • docs/case-studies/ReducingRegressionAnalysisEfforts.mdx
  • docs/case-studies/ReducingRegressionTimeBy50.mdx

Comment thread docs/case-studies/ReducingRegressionTimeBy50.mdx
@siarheirazuvalau siarheirazuvalau merged commit de78822 into develop May 7, 2026
2 checks passed
@siarheirazuvalau siarheirazuvalau deleted the feature/EPMRPP-114802-canonical-and-robots-meta-tags branch May 7, 2026 10:40
maria-hambardzumian added a commit that referenced this pull request May 7, 2026
* Update GitHub workflows

* EPMRPP-115059 || Remove Analyzer train mention from the docs (#1109)

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

* EPMRPP-114977 || Exclude /docs/search/ page from indexing and sitemap (#1108)

* docs: update case studies with titles, meta tags, and formatting adjustments (#1112)

Co-authored-by: maria-hambardzumian <164881199+maria-hambardzumian@users.noreply.github.com>
Co-authored-by: Yuliya Prihodko <107035036+pressayuliya@users.noreply.github.com>
Co-authored-by: Yuliya_Prihodko <Yuliya_Prihodko@epam.com>
Co-authored-by: Vadzim Hushchanskou <HardNorth@users.noreply.github.com>

---------

Co-authored-by: maria-hambardzumian <maria_hambardzumyan@gmail.com>
Co-authored-by: Yuliya Prihodko <107035036+pressayuliya@users.noreply.github.com>
Co-authored-by: Yuliya_Prihodko <Yuliya_Prihodko@epam.com>
Co-authored-by: Aliaksei Rudak <143392025+a-rudak-EIS@users.noreply.github.com>
Co-authored-by: Vadzim Hushchanskou <HardNorth@users.noreply.github.com>
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.

3 participants