CQA 2.1 (Feb) - IntelliJ#317
Merged
anarnold97 merged 4 commits intomigtools:mainfrom Feb 26, 2026
Merged
Conversation
Signed-off-by: A.Arnold <anarnold@redhat.com>
anarnold97
commented
Feb 24, 2026
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR refines IntelliJ plugin documentation through wording standardization, content consolidation, and structural improvements. Changes include replacing duplicated JDK version blocks with consolidated text, relocating includes for better document organization, standardizing terminology (e.g., "Quick Fix" capitalization), and clarifying UI descriptions with minor phrasing adjustments across multiple documentation files. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
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 (3)
docs/topics/mta-intellij-plugin/installing-intellij-idea-plugin.adoc (1)
24-24:⚠️ Potential issue | 🟡 MinorNew CLI prerequisite is missing a predicate — grammatically incomplete.
The other bullets in this list are complete sentences ("8 GB of RAM is required…", "the value of
maxprocmust be…"). Line 24 is a noun phrase with no verb describing what the user must do.✏️ Proposed fix
-* The latest version of `{LC_PSN}-cli` from the link:{DevDownloadPageURL}[{ProductShortName} download page] +* The latest version of `{LC_PSN}-cli` must be installed from the link:{DevDownloadPageURL}[{ProductShortName} download page].🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/mta-intellij-plugin/installing-intellij-idea-plugin.adoc` at line 24, Turn the noun phrase bullet "* The latest version of `{LC_PSN}-cli` from the link:{DevDownloadPageURL}[{ProductShortName} download page]" into a complete instruction sentence; update the text to something like "Install the latest version of `{LC_PSN}-cli` from the {DevDownloadPageURL} ({ProductShortName} download page)." so the bullet has a verb and matches the other complete-sentence bullets referencing `{LC_PSN}-cli`, `{DevDownloadPageURL}`, and `{ProductShortName}`.docs/topics/mta-intellij-plugin/intellij-idea-plugin-run-configuration.adoc (2)
19-19:⚠️ Potential issue | 🟡 MinorMissing article "the" before "configuration".
"right-click configuration in the list" should read "right-click the configuration in the list".
✏️ Proposed fix
-. If this is not your first configuration, right-click configuration in the list and select *New configuration*. +. If this is not your first configuration, right-click the configuration in the list and select *New configuration*.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/mta-intellij-plugin/intellij-idea-plugin-run-configuration.adoc` at line 19, Fix the missing article in the sentence: change "right-click configuration in the list and select *New configuration*" to "right-click the configuration in the list and select *New configuration*" so the phrase reads correctly; update the line containing "right-click configuration in the list" in the docs text.
38-40:⚠️ Potential issue | 🟡 MinorInconsistent UI label:
*Report*(singular) vs*Reports*(plural).Line 38 instructs the user to click
*Report*, but line 40 describes the same element as*Reports*. If the actual button label is "Reports", line 38 needs to be corrected to avoid confusion.✏️ Proposed fix (assuming "Reports" is the correct UI label)
-When the analysis is completed, you can click either *Report* or *Results* below the name of the configuration file you ran. +When the analysis is completed, you can click either *Reports* or *Results* below the name of the configuration file you ran.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/mta-intellij-plugin/intellij-idea-plugin-run-configuration.adoc` around lines 38 - 40, The UI label is inconsistent: the text references `*Report*` (singular) but later uses `*Reports*` (plural); update the first occurrence to `*Reports*` to match the actual button and the later description, ensuring the phrase "click either *Reports* or *Results*" is consistent and that the `*Reports*` link and surrounding sentence remain unchanged (check the paragraph containing `*Report*` and the paragraph starting with `** *Reports* opens the {ProductShortName} report` to make both use `*Reports*`).
🤖 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/intellij-idea-plugin-guide/master.adoc`:
- Around line 15-17: The introductory paragraph referencing {ProductName}
appears before the include that defines it (document-attributes.adoc), so move
that introductory paragraph (the sentence starting "Use the {ProductName} plugin
for IntelliJ IDEA...") to immediately after the
include::topics/templates/document-attributes.adoc[] line; before committing,
verify whether ProductName is supplied via CLI build flags (e.g., -a
ProductName=...) and if it is, no change is needed, otherwise perform the move
to ensure the attribute is defined before first use.
---
Outside diff comments:
In `@docs/topics/mta-intellij-plugin/installing-intellij-idea-plugin.adoc`:
- Line 24: Turn the noun phrase bullet "* The latest version of `{LC_PSN}-cli`
from the link:{DevDownloadPageURL}[{ProductShortName} download page]" into a
complete instruction sentence; update the text to something like "Install the
latest version of `{LC_PSN}-cli` from the {DevDownloadPageURL}
({ProductShortName} download page)." so the bullet has a verb and matches the
other complete-sentence bullets referencing `{LC_PSN}-cli`,
`{DevDownloadPageURL}`, and `{ProductShortName}`.
In `@docs/topics/mta-intellij-plugin/intellij-idea-plugin-run-configuration.adoc`:
- Line 19: Fix the missing article in the sentence: change "right-click
configuration in the list and select *New configuration*" to "right-click the
configuration in the list and select *New configuration*" so the phrase reads
correctly; update the line containing "right-click configuration in the list" in
the docs text.
- Around line 38-40: The UI label is inconsistent: the text references
`*Report*` (singular) but later uses `*Reports*` (plural); update the first
occurrence to `*Reports*` to match the actual button and the later description,
ensuring the phrase "click either *Reports* or *Results*" is consistent and that
the `*Reports*` link and surrounding sentence remain unchanged (check the
paragraph containing `*Report*` and the paragraph starting with `** *Reports*
opens the {ProductShortName} report` to make both use `*Reports*`).
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
assemblies/intellij-plugin-guide/assembly_resolving-issues.adocdocs/intellij-idea-plugin-guide/master.adocdocs/topics/making-open-source-more-inclusive.adocdocs/topics/mta-intellij-plugin/about-ide-addons-intellij.adocdocs/topics/mta-intellij-plugin/installing-intellij-idea-plugin.adocdocs/topics/mta-intellij-plugin/intellij-idea-plugin-run-configuration.adocdocs/topics/mta-intellij-plugin/proc_edit-code-file.adocdocs/topics/mta-intellij-plugin/proc_quick-fix.adocdocs/topics/mta-intellij-plugin/what-is-the-toolkit.adoc
Comment on lines
+15
to
+17
| Use the {ProductName} plugin for IntelliJ IDEA to analyze applications, find migration issues, and apply fixes from your IDE. This guide describes installation, run configuration, and resolving issues. | ||
|
|
||
| include::topics/templates/document-attributes.adoc[] |
Contributor
There was a problem hiding this comment.
{ProductName} may render as a literal string — move the introductory paragraph after the document-attributes.adoc include.
The introductory paragraph at Line 15 references {ProductName}, but document-attributes.adoc (which defines that attribute) is not included until Line 17. In standard single-pass Asciidoctor processing, an undefined attribute at the point of reference renders as a literal {ProductName} string in the output.
The original placement had include::topics/templates/document-attributes.adoc[] immediately after :mta: (before any content), ensuring all attributes were defined before first use. Moving the intro paragraph after the include restores safe ordering.
Please confirm whether {ProductName} is also passed via CLI build flags (e.g., -a ProductName=...), which would make it available even before the include. If it is NOT passed via CLI, apply this fix:
🛠️ Proposed fix — move intro paragraph after include
:mta:
:_mod-docs-content-type: ASSEMBLY
[id="intellij-idea-plugin-guide"]
= IntelliJ IDEA Plugin Guide
-Use the {ProductName} plugin for IntelliJ IDEA to analyze applications, find migration issues, and apply fixes from your IDE. This guide describes installation, run configuration, and resolving issues.
-
include::topics/templates/document-attributes.adoc[]
+Use the {ProductName} plugin for IntelliJ IDEA to analyze applications, find migration issues, and apply fixes from your IDE. This guide describes installation, run configuration, and resolving issues.
+
//Inclusive language statement
include::topics/making-open-source-more-inclusive.adoc[]#!/bin/bash
# Verify whether {ProductName} is defined in document-attributes.adoc
fd -g 'document-attributes.adoc' --exec grep -n 'ProductName'🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/intellij-idea-plugin-guide/master.adoc` around lines 15 - 17, The
introductory paragraph referencing {ProductName} appears before the include that
defines it (document-attributes.adoc), so move that introductory paragraph (the
sentence starting "Use the {ProductName} plugin for IntelliJ IDEA...") to
immediately after the include::topics/templates/document-attributes.adoc[] line;
before committing, verify whether ProductName is supplied via CLI build flags
(e.g., -a ProductName=...) and if it is, no change is needed, otherwise perform
the move to ensure the attribute is defined before first use.
mpershina
reviewed
Feb 26, 2026
| [id="intellij-idea-plugin-guide"] | ||
| = IntelliJ IDEA Plugin Guide | ||
|
|
||
| Use the {ProductName} plugin for IntelliJ IDEA to analyze applications, find migration issues, and apply fixes from your IDE. This guide describes installation, run configuration, and resolving issues. |
Collaborator
There was a problem hiding this comment.
No need for the abstract in master.adoc
Suggested change
| Use the {ProductName} plugin for IntelliJ IDEA to analyze applications, find migration issues, and apply fixes from your IDE. This guide describes installation, run configuration, and resolving issues. |
mpershina
reviewed
Feb 26, 2026
|
|
||
| [role="_abstract"] | ||
| Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see link:https://www.redhat.com/en/blog/making-open-source-more-inclusive-eradicating-problematic-language[our CTO Chris Wright's message]. | ||
| Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with four terms: primary or source (instead of the former term), replica or responder (instead of the former term), blocklist (instead of the former term), and allowlist (instead of the former term). Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see link:https://www.redhat.com/en/blog/making-open-source-more-inclusive-eradicating-problematic-language[our CTO Chris Wright's message]. |
Collaborator
There was a problem hiding this comment.
The initial text is universal for all docs across RH. We should leave it as it is. Moreover, if I'm not mistaken, this module will be completely removed in the future.
mpershina
requested changes
Feb 26, 2026
Collaborator
mpershina
left a comment
mpershina
left a comment
There was a problem hiding this comment.
Just a couple of minor things to fix, otherwise, LGTM!
anarnold97
commented
Feb 26, 2026
anarnold97
commented
Feb 26, 2026
Collaborator
Author
|
@mpershina - thanks. will update my script not to add abstract in |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
CQA 2.1 and Vale Validation Report: IntelliJ IDEA Plugin Guide
Date: February 2025
Scope:
docs/intellij-idea-plugin-guideand all content included in the guideReference: CQA 2.1 (Content Quality Assessment), Vale (Red Hat + AsciiDocDITA)
1. Summary
The IntelliJ IDEA Plugin Guide was assessed against CQA 2.1 pre-migration and quality requirements and validated with Vale using the Red Hat and AsciiDocDITA packages. All identified errors and warnings were addressed so that the guide content passes with 0 errors and 0 warnings.
2. Validation Approach
2.1 CQA 2.1
2.2 Vale
https://github.com/jhradilek/asciidoctor-dita-vale/releases/latest/download/AsciiDocDITA.zip).2.3 Files in Scope
docs/intellij-idea-plugin-guide/master.adocdocs/topics/templates/document-attributes.adocdocs/topics/making-open-source-more-inclusive.adocdocs/topics/mta-intellij-plugin/about-ide-addons-intellij.adocdocs/topics/mta-intellij-plugin/what-is-the-toolkit.adocdocs/topics/mta-intellij-plugin/installing-intellij-idea-plugin.adocdocs/topics/mta-intellij-plugin/intellij-idea-plugin-run-configuration.adocdocs/topics/mta-intellij-plugin/intellij-idea-plugin-reviewing-issues.adocdocs/topics/mta-intellij-plugin/proc_edit-code-file.adocdocs/topics/mta-intellij-plugin/proc_quick-fix.adocassemblies/intellij-plugin-guide/assembly_resolving-issues.adoc3. CQA Pre-Migration Fixes
3.1 Assembly Structure (No Content Between Includes)
master.adoc, the document title and short description were moved above the firstinclude::. The assembly now has:[role="_abstract"]short descriptioninclude::directives (no narrative text between them)3.2 Short Description
[role="_abstract"], blank line after the level-0 title.master.adoc:4. Vale (Red Hat + AsciiDocDITA) Fixes
4.1 Master Assembly (
docs/intellij-idea-plugin-guide/master.adoc)[role="_abstract"]short description.4.2 Topics: Style and Grammar
about-ide-addons-intellij.adocwhat-is-the-toolkit.adoc?from "What is the {ProductName}?", "How does the {ProductName} simplify migration?", "How do I learn more?"what-is-the-toolkit.adocwhat-is-the-toolkit.adoc4.3 Topics: Spelling and Terminology
installing-intellij-idea-plugin.adocinstalling-intellij-idea-plugin.adocintellij-idea-plugin-run-configuration.adoc4.4 Topics: Accessibility and Non-Visual Description
proc_edit-code-file.adocproc_quick-fix.adocproc_quick-fix.adoc4.5 Assembly: Wording
assembly_resolving-issues.adoc4.6 Shared Modules
making-open-source-more-inclusive.adocdocument-attributes.adoc5. Configuration Changes
5.1
vale.ini(repository root)write-goodreference; kept Red Hat and AsciiDocDITA so Vale runs successfully.document-attributes.adoc:[**/document-attributes.adoc]BasedOnStyles = RedHat(no AsciiDocDITA for this fragment).TokenIgnoresso path-like attribute values and the approved GitHub URL do not trigger Slash/GitLinks in this file.5.2
.github/styles/RedHat/GitLinks.ymlhttps://github.com/windup/in the exception list so the approved:LinkAPI:reference indocument-attributes.adocdoes not trigger a warning.5.3
.github/styles/RedHat/CaseSensitiveTerms.yml5.4 Vale Sync
vale syncwas run so the AsciiDocDITA package is present under.github/stylesand Vale can load both Red Hat and AsciiDocDITA.6. Final Validation Result
Vale was run on all 11 guide files (master, included topics, and resolving-issues assembly):
7. How to Re-run Validation
From the repository root:
Or, to lint only the guide directory (master.adoc and any local files):
8. References
.github/styles/RedHat/in this repository.Summary by CodeRabbit
Release Notes