Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughConsolidated and restructured AsciiDoc documentation across the repository: removed multiple standalone topics and template includes, standardized and moved inline xrefs into Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@assemblies/ui-guide/assembly_tagging-applications.adoc`:
- Line 20: The sentence "You can either set an automated tagging or tag
applications manually." uses incorrect phrasing; change "set an automated
tagging" to a grammatically correct option such as "set up automated tagging" or
"use automated tagging" so the sentence reads e.g. "You can either set up
automated tagging or tag applications manually." Update the text in
assembly_tagging-applications.adoc accordingly.
🪄 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: 5e41f86f-3daa-49bb-98b5-30a6bf60d6e3
📒 Files selected for processing (20)
assemblies/cli-guide/assembly_analyzing-applications-mta-cli.adocassemblies/cli-guide/assembly_analyzing-nonjava-applications.adocassemblies/mta-install-title/assembly_red-hat-build-of-keycloak.adocassemblies/ui-guide/assembly_assessment-questionnaires.adocassemblies/ui-guide/assembly_configuring-mta-instance-environment.adocassemblies/ui-guide/assembly_tagging-applications.adocdocs/topics/about-home-var.adocdocs/topics/available-openrewrite-recipes.adocdocs/topics/cli-args.adocdocs/topics/developer-preview-feature.adocdocs/topics/fork-ruleset-repo.adocdocs/topics/mta-install/con_mta-features.adocdocs/topics/mta-install/con_mta-rules.adocdocs/topics/mta-install/con_mta-tools.adocdocs/topics/mta-install/proc_accessing-rhbk-admin-console.adocdocs/topics/mta-ui/con_assessment-module-features.adocdocs/topics/mta-web-applying-assessments-to-other-apps.adocdocs/topics/rules-important-links.adocdocs/topics/templates/developer-preview.adocdocs/topics/templates/technology-preview-admonition.adoc
💤 Files with no reviewable changes (9)
- assemblies/ui-guide/assembly_configuring-mta-instance-environment.adoc
- docs/topics/fork-ruleset-repo.adoc
- docs/topics/about-home-var.adoc
- docs/topics/templates/technology-preview-admonition.adoc
- docs/topics/rules-important-links.adoc
- docs/topics/developer-preview-feature.adoc
- docs/topics/cli-args.adoc
- docs/topics/templates/developer-preview.adoc
- docs/topics/available-openrewrite-recipes.adoc
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 (1)
docs/topics/rules-development/yaml-builtin-provider.adoc (1)
73-83:⚠️ Potential issue | 🟡 MinorChange
hasTags:tobuiltin.hasTags:on line 80 for consistency.The example uses
hasTags:directly, but all other builtin capabilities in this file (builtin.file,builtin.filecontent,builtin.xml,builtin.json) and across the provider documentation are consistently namespaced with thebuiltin.prefix. Update the example to match this established pattern.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/rules-development/yaml-builtin-provider.adoc` around lines 73 - 83, Update the example to use the namespaced capability name: replace the plain hasTags usage with builtin.hasTags in the YAML snippet so it matches the rest of the docs; locate the example showing "when: hasTags:" and change it to "when: builtin.hasTags:" (referencing hasTags and builtin.hasTags to find the correct block).
🧹 Nitpick comments (2)
docs/topics/rules-development/yaml-rule-metadata.adoc (1)
39-42: Remove leftover template guidance commentsThe
//// ... ////block looks like authoring-template guidance. Consider removing it before merge to keep the module source clean.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/rules-development/yaml-rule-metadata.adoc` around lines 39 - 42, Remove the leftover authoring-template guidance block that begins with "////" and ends with "////" (the Optional. Delete if not used... Do not include additional text.) from the YAML rule metadata topic; delete the entire comment block and either replace it with the actual bulleted link list if relevant or leave nothing in its place so no template guidance remains in the source.docs/topics/rules-development/yaml-builtin-provider.adoc (1)
37-38: Remove the stray list marker before thexmlcapability heading.Line 37 adds a standalone bullet (
* \xml`) immediately beforexml::`, which can render as an unintended extra list item and disrupt section formatting.Proposed fix
-* `xml` `xml`::🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/rules-development/yaml-builtin-provider.adoc` around lines 37 - 38, Remove the stray list marker that precedes the xml capability heading: delete the standalone "* `xml`" bullet that appears immediately before the "xml::" heading so only the "xml::" macro remains; update the section containing the xml capability (the lines showing "* `xml`" and "xml::") to remove the leading asterisk/bullet and ensure the "xml::" heading is the first token on that line.
🤖 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/rules-development/yaml-rule-metadata.adoc`:
- Around line 31-35: Update the phrase describing the category metadata: locate
the bullet that starts with "`category` is severity of the issue for migration."
and change it to read "`category` is the severity of the issue for migration.
Values can be one of `mandatory`, `potential` or `optional`." so it reads
grammatically correct; the unique identifier to find is the `category` bullet in
the YAML rule metadata section.
---
Outside diff comments:
In `@docs/topics/rules-development/yaml-builtin-provider.adoc`:
- Around line 73-83: Update the example to use the namespaced capability name:
replace the plain hasTags usage with builtin.hasTags in the YAML snippet so it
matches the rest of the docs; locate the example showing "when: hasTags:" and
change it to "when: builtin.hasTags:" (referencing hasTags and builtin.hasTags
to find the correct block).
---
Nitpick comments:
In `@docs/topics/rules-development/yaml-builtin-provider.adoc`:
- Around line 37-38: Remove the stray list marker that precedes the xml
capability heading: delete the standalone "* `xml`" bullet that appears
immediately before the "xml::" heading so only the "xml::" macro remains; update
the section containing the xml capability (the lines showing "* `xml`" and
"xml::") to remove the leading asterisk/bullet and ensure the "xml::" heading is
the first token on that line.
In `@docs/topics/rules-development/yaml-rule-metadata.adoc`:
- Around line 39-42: Remove the leftover authoring-template guidance block that
begins with "////" and ends with "////" (the Optional. Delete if not used... Do
not include additional text.) from the YAML rule metadata topic; delete the
entire comment block and either replace it with the actual bulleted link list if
relevant or leave nothing in its place so no template guidance remains in the
source.
🪄 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: 3af91b05-d249-494c-93f1-b130fdc1a109
📒 Files selected for processing (18)
assemblies/rules-development-guide/assembly_rule-rulesets.adocassemblies/rules-development-guide/assembly_rule-yaml-actions.adocassemblies/rules-development-guide/assembly_rule-yaml-conditions.adocassemblies/rules-development-guide/assembly_rules-introduction.adocdocs/topics/mta-intellij-plugin/what-is-the-toolkit.adocdocs/topics/rules-development/about-rules.adocdocs/topics/rules-development/con_provider-capability-in-custom-rules.adocdocs/topics/rules-development/developer-preview-admonition.adocdocs/topics/rules-development/rules-guide-intro.adocdocs/topics/rules-development/technology-preview.adocdocs/topics/rules-development/yaml-builtin-provider.adocdocs/topics/rules-development/yaml-condition-patterns.adocdocs/topics/rules-development/yaml-dotnet-provider.adocdocs/topics/rules-development/yaml-go-provider.adocdocs/topics/rules-development/yaml-java-provider.adocdocs/topics/rules-development/yaml-rule-actions.adocdocs/topics/rules-development/yaml-rule-metadata.adocdocs/topics/rules-development/yaml-rulesets.adoc
💤 Files with no reviewable changes (5)
- assemblies/rules-development-guide/assembly_rule-rulesets.adoc
- docs/topics/rules-development/rules-guide-intro.adoc
- docs/topics/rules-development/developer-preview-admonition.adoc
- assemblies/rules-development-guide/assembly_rules-introduction.adoc
- docs/topics/rules-development/technology-preview.adoc
✅ Files skipped from review due to trivial changes (9)
- assemblies/rules-development-guide/assembly_rule-yaml-actions.adoc
- docs/topics/rules-development/yaml-condition-patterns.adoc
- docs/topics/rules-development/yaml-rulesets.adoc
- docs/topics/rules-development/about-rules.adoc
- docs/topics/rules-development/yaml-go-provider.adoc
- docs/topics/rules-development/yaml-dotnet-provider.adoc
- docs/topics/rules-development/yaml-rule-actions.adoc
- docs/topics/rules-development/yaml-java-provider.adoc
- docs/topics/rules-development/con_provider-capability-in-custom-rules.adoc
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/topics/rules-development/yaml-rule-metadata.adoc (1)
39-42: Remove template-instruction comment block before merge.This
//// ... ////scaffold is template guidance and can be dropped to keep source docs clean.✂️ Suggested cleanup
[role="_additional-resources"] .Additional resources -//// -Optional. Delete if not used. -Provide a bulleted list of links and display text relevant to the assembly. These links can include `link:` and `xref:` macros. Do not include additional text. -//// * xref:yaml-rule-labels_rule-yaml-metadata[Rule labels] * xref:yaml-rule-categories_rule-yaml-metadata[Rule categories]🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/rules-development/yaml-rule-metadata.adoc` around lines 39 - 42, Remove the template scaffold block delimited by "////" that contains the line "Optional. Delete if not used. Provide a bulleted list of links and display text relevant to the assembly..."—delete the entire "//// ... ////" section so the file no longer contains the template instruction comments and only keeps real documentation content.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/topics/rules-development/yaml-rule-metadata.adoc`:
- Around line 39-42: Remove the template scaffold block delimited by "////" that
contains the line "Optional. Delete if not used. Provide a bulleted list of
links and display text relevant to the assembly..."—delete the entire "//// ...
////" section so the file no longer contains the template instruction comments
and only keeps real documentation content.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 6456e559-8f03-4d70-84a9-de7847524671
📒 Files selected for processing (7)
docs/topics/mta-ui/con_assessment-module-features.adocdocs/topics/rules-development/about-rules.adocdocs/topics/rules-development/yaml-builtin-provider.adocdocs/topics/rules-development/yaml-dotnet-provider.adocdocs/topics/rules-development/yaml-go-provider.adocdocs/topics/rules-development/yaml-java-provider.adocdocs/topics/rules-development/yaml-rule-metadata.adoc
✅ Files skipped from review due to trivial changes (4)
- docs/topics/rules-development/about-rules.adoc
- docs/topics/rules-development/yaml-go-provider.adoc
- docs/topics/rules-development/yaml-builtin-provider.adoc
- docs/topics/rules-development/yaml-dotnet-provider.adoc
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/topics/mta-ui/con_assessment-module-features.adoc
| @@ -11,7 +11,7 @@ The Language Server used by the Java provider is Eclipse's JDTLS. Internally, th | |||
|
|
|||
| In the `pattern` element of a `java.referenced` condition, you can search through application code by using these utilities. For more details, see link:https://help.eclipse.org/latest/index.jsp?topic=%2Forg.eclipse.jdt.doc.isv%2Freference%2Fapi%2Forg%2Feclipse%2Fjdt%2Fcore%2Fsearch%2FSearchPattern.html&anchor=createPattern[Class SearchPattern], which contains all the information for building these patterns for `createPattern(String, int, int, int)`. | |||
There was a problem hiding this comment.
Should first be checked; external links are not advised
There was a problem hiding this comment.
agreed, let us check with Ramon if he really wants this link. If not, then we will delete
There was a problem hiding this comment.
@rromannissen, WDYT? Do we need to link to Class SearchPattern?
assemblies/cli-guide/assembly_analyzing-applications-mta-cli.adoc
Outdated
Show resolved
Hide resolved
assemblies/cli-guide/assembly_analyzing-applications-mta-cli.adoc
Outdated
Show resolved
Hide resolved
assemblies/mta-install-title/assembly_red-hat-build-of-keycloak.adoc
Outdated
Show resolved
Hide resolved
docs/topics/rules-development/con_provider-capability-in-custom-rules.adoc
Outdated
Show resolved
Hide resolved
docs/topics/rules-development/con_provider-capability-in-custom-rules.adoc
Outdated
Show resolved
Hide resolved
anarnold97
left a comment
There was a problem hiding this comment.
A few tiny things that i might correct
We need to check the Eclipse link with Ramon
However, looking at the previews, it is a really nice piece of work that is much cleaner.
assemblies/cli-guide/assembly_analyzing-applications-mta-cli.adoc
Outdated
Show resolved
Hide resolved
Co-authored-by: Andy Arnold <anarnold@redhat.com>
assemblies/mta-install-title/assembly_red-hat-build-of-keycloak.adoc
Outdated
Show resolved
Hide resolved
| * Run the analysis against multiple applications in either of the following ways: | ||
| ** Enter a series of `--analyze` commands, each against an application and each generating a separate report. | ||
| ** Use the `--bulk` option to analyze multiple applications at once and generate a single report. Note that this feature is a Developer Preview feature only. |
Report with all the comments: https://docs.google.com/spreadsheets/d/1ICPE3F3zbHH4Gy6MvI1WIvR4A5_LZIEV_s0iI6kwttw/edit?gid=2139460735#gid=2139460735
Previews
CLI
Install
UI
RDG