Skip to content

MTA-6731 Release Notes Error Fixes#342

Merged
Pkylas007 merged 5 commits intomainfrom
mta-6731-release-notes-error-fixes
Apr 9, 2026
Merged

MTA-6731 Release Notes Error Fixes#342
Pkylas007 merged 5 commits intomainfrom
mta-6731-release-notes-error-fixes

Conversation

@Pkylas007
Copy link
Copy Markdown
Collaborator

@Pkylas007 Pkylas007 commented Apr 7, 2026

JIRA

Version

  • 8.2.0

Preview

Summary by CodeRabbit

  • Documentation
    • Improved release notes clarity and consistency across multiple versions.
    • Corrected punctuation, headings, verb agreement, and terminology (e.g., FQNs).
    • Clarified service-binding examples and parenthetical formatting.
    • Standardized product-version naming and broadened subtitle wording for multi-version coverage.
    • Removed stray whitespace and minor spacing issues for cleaner text.

Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 7, 2026

Warning

Rate limit exceeded

@Pkylas007 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 10 minutes and 37 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 10 minutes and 37 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 29ce170d-497f-45b7-ad18-713d33b3555e

📥 Commits

Reviewing files that changed from the base of the PR and between 5fc65d7 and cf6db5d.

📒 Files selected for processing (1)
  • docs/topics/release-notes-topics/ref_fixed-issues-8-0-1.adoc
📝 Walkthrough

Walkthrough

Documentation-only updates across release notes and master docinfo: punctuation/markup, verb plurality, acronym pluralization, example parentheses, trailing-whitespace removal, and parameterized product/version phrasing for 8.0.0, 8.0.1, and 8.1.0.

Changes

Cohort / File(s) Summary
Fixed-issues & examples
docs/topics/release-notes-topics/ref_fixed-issues-8-0-1.adoc, docs/topics/release-notes-topics/ref_fixed-issues-8-1-0.adoc
Adjusted punctuation and AsciiDoc block marker in Java binary analysis sentence; changed verb plurality in open-source dependencies text; clarified Cloud Foundry service-binding description and moved the cf bind-service ... example into parentheses.
Known issues & new-features text
docs/topics/release-notes-topics/ref_known-issues-8-0-1.adoc, docs/topics/release-notes-topics/ref_new-features-and-enhancements-8-1-0.adoc
Corrected acronym pluralization (FQNFQNs) and fixed spacing/wording in the LLM proxy service paragraph (e.g., “issued by Keycloak”).
Version/product phrasing & docinfo
docs/topics/release-notes-topics/ref_removed-features-8-0.adoc, docs/topics/release-notes-topics/ref_tech-previews-8-0.adoc, docs/release-notes/master-docinfo.xml
Removed parenthetical {ProductShortName} from product/version mentions and parameterized the release-notes subtitle to use {DocInfoProductNumber}.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • anarnold97
  • mguetta1
  • eemcmullan

Poem

🐰
I hopped through text and stitched a seam,
Placed commas soft as a springtime dream.
FQNs now plural, examples snug in place,
Versions trimmed neatly — a tidy, cheerful trace.

🚥 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 directly and accurately describes the primary change: fixing typos and grammar errors in release notes documentation across multiple files.
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 unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch mta-6731-release-notes-error-fixes

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
Copy Markdown
Contributor

@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

🧹 Nitpick comments (1)
docs/topics/release-notes-topics/ref_new-features-and-enhancements-8-1-0.adoc (1)

15-17: Consider standardizing punctuation in the bullet list.

The bullet list has inconsistent punctuation: the first two items lack a trailing period while the third item has one. For consistency, consider either removing the period from line 17 or adding periods to lines 15-16.

📝 Proposed fix (removing the period for consistency)
 * User interface (UI)
 * Command-line interface (CLI)
-* The Visual Studio Code {ProductShortName} extension.
+* The Visual Studio Code {ProductShortName} extension
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@docs/topics/release-notes-topics/ref_new-features-and-enhancements-8-1-0.adoc`
around lines 15 - 17, Standardize the bullet-list punctuation by making the
three items consistent: either remove the trailing period from "The Visual
Studio Code {ProductShortName} extension." or add trailing periods to "User
interface (UI)" and "Command-line interface (CLI)"; update the lines containing
the strings "User interface (UI)", "Command-line interface (CLI)", and "The
Visual Studio Code {ProductShortName} extension." so all bullets have the same
punctuation style.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In
`@docs/topics/release-notes-topics/ref_new-features-and-enhancements-8-1-0.adoc`:
- Line 27: There is a double space in the phrase "issued by  Keycloak" in the
release-notes text; locate the string "issued by  Keycloak" and replace it with
"issued by Keycloak" (single space) so the sentence reads correctly; update the
sentence near the paragraph that begins "You can allow client endpoints..."
(look for that exact opening) to remove the extra space.

---

Nitpick comments:
In
`@docs/topics/release-notes-topics/ref_new-features-and-enhancements-8-1-0.adoc`:
- Around line 15-17: Standardize the bullet-list punctuation by making the three
items consistent: either remove the trailing period from "The Visual Studio Code
{ProductShortName} extension." or add trailing periods to "User interface (UI)"
and "Command-line interface (CLI)"; update the lines containing the strings
"User interface (UI)", "Command-line interface (CLI)", and "The Visual Studio
Code {ProductShortName} extension." so all bullets have the same punctuation
style.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: ecef76b9-7224-44db-839c-0497c6d31ea8

📥 Commits

Reviewing files that changed from the base of the PR and between cd4dc5a and be783d7.

📒 Files selected for processing (6)
  • docs/topics/release-notes-topics/ref_fixed-issues-8-0-1.adoc
  • docs/topics/release-notes-topics/ref_fixed-issues-8-1-0.adoc
  • docs/topics/release-notes-topics/ref_known-issues-8-0-1.adoc
  • docs/topics/release-notes-topics/ref_new-features-and-enhancements-8-1-0.adoc
  • docs/topics/release-notes-topics/ref_removed-features-8-0.adoc
  • docs/topics/release-notes-topics/ref_tech-previews-8-0.adoc

Comment thread docs/topics/release-notes-topics/ref_new-features-and-enhancements-8-1-0.adoc Outdated
Prabha Kylasamiyer Sundara Rajan added 2 commits April 7, 2026 14:40
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
@Pkylas007 Pkylas007 requested a review from anarnold97 April 7, 2026 09:22
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
{ProductFirstRef} ({ProductShortName}) version 8.0.1 provides the following fixed issues and other problems that have a significant impact.

In {ProductShortName} 8.0.1 the performance of Java binary analysis has significantly improved.
In {ProductShortName} 8.0.1, the performance of Java binary analysis has significantly improved::
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This whole section is about 8.0.1, so I suggest the following rewrtie:

Suggested change
In {ProductShortName} 8.0.1, the performance of Java binary analysis has significantly improved::
Improved performance of the Java binary analysis::

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done, thanks!

(link:https://issues.redhat.com/browse/MTA-6231[MTA-6231])

Analysis of binary applications classify open source dependencies accurately::
Analysis of binary applications classifies open source dependencies accurately::
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Analysis of binary applications classifies open source dependencies accurately::
Analysis of binary applications correctly classifies open source dependencies::


{ProductShortName} CLI correctly processes Cloud Foundry applications with service bindings::
Before this update, the discovery process for Cloud Foundry (CF) applications with service bindings by using live connection failed in the {ProductFullName} command-line interface (CLI). {ProductShortName} CLI did not parse the `VCAP_SERVICES` environment variables correctly to handle service binding information for services, for example, `cf bind-service _<application_name>_ postgres01`. With this update, {ProductShortName} CLI no longer fails to complete the discovery of CF applications with service bindings.
Before this update, the discovery process for Cloud Foundry (CF) applications with service bindings by using live connection failed in the {ProductFullName} command-line interface (CLI). {ProductShortName} CLI did not parse the `VCAP_SERVICES` environment variables correctly to handle service binding information for services (for example, `cf bind-service _<application_name>_ postgres01`). With this update, {ProductShortName} CLI no longer fails to complete the discovery of CF applications with service bindings.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Per our guidelines, we don't really use parentheses when listing example items. Thus, the initial option is correct. Sometimes, our scripts can report false positives.

Suggested change
Before this update, the discovery process for Cloud Foundry (CF) applications with service bindings by using live connection failed in the {ProductFullName} command-line interface (CLI). {ProductShortName} CLI did not parse the `VCAP_SERVICES` environment variables correctly to handle service binding information for services (for example, `cf bind-service _<application_name>_ postgres01`). With this update, {ProductShortName} CLI no longer fails to complete the discovery of CF applications with service bindings.
Before this update, the discovery process for Cloud Foundry (CF) applications with service bindings by using live connection failed in the {ProductFullName} command-line interface (CLI). {ProductShortName} CLI did not parse the `VCAP_SERVICES` environment variables correctly to handle service binding information for services, for example, `cf bind-service _<application_name>_ postgres01`. With this update, {ProductShortName} CLI no longer fails to complete the discovery of CF applications with service bindings.

Copy link
Copy Markdown
Collaborator

@mpershina mpershina left a comment

Choose a reason for hiding this comment

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

A couple of minor fixes needed, otherwise, LGTM!

Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
@Pkylas007 Pkylas007 merged commit 160573e into main Apr 9, 2026
2 checks passed
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