Open
Conversation
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
|
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:
📝 WalkthroughWalkthroughAdds a new assembly documenting centralized analysis configurations, two new UI procedures (configure profile, run analysis), minor edits to target/custom migration docs, and integrates the new assembly into the web-console-guide master include. Changes
Sequence Diagram(s)(No sequence diagrams generated — changes are documentation additions and procedure updates without new multi-component runtime control flow.) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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 |
Collaborator
Author
|
Peer review is completed in #297 which is now closed. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
🧹 Nitpick comments (1)
docs/topics/mta-ui/proc_configuring-target-profiles.adoc (1)
27-27: Clarify the CLI download restriction.The note states "You can download this profile configuration from the {ProductShortName} {CLIName} only if you select the profile from this list." However, it's not immediately clear what "this list" refers to in the context of an optional selection field, or why the restriction exists.
Consider rephrasing for clarity:
-. (Optional) Select an analysis profile for the application from the list. You can download this profile configuration from the {ProductShortName} {CLIName} only if you select the profile from this list. +. (Optional) Select an analysis profile for the application. Selecting a profile here makes it available for download via the {ProductShortName} {CLIName}.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/topics/mta-ui/proc_configuring-target-profiles.adoc` at line 27, The sentence "You can download this profile configuration from the {ProductShortName} {CLIName} only if you select the profile from this list." is ambiguous; update the sentence in proc_configuring-target-profiles.adoc (the line containing "(Optional) Select an analysis profile...") to explicitly reference "the list of available analysis profiles shown in the UI" and rephrase to explain the restriction (e.g., downloads via {CLIName} are supported only for profiles chosen from that UI list), so readers understand what "this list" means and why the CLI download is limited to those profiles.
🤖 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_centralized-configurations-analysis.adoc`:
- Line 30: The sentence "As a Migrator, can use these profiles to perform an
application analysis." is missing the subject; update the sentence in
assembly_centralized-configurations-analysis.adoc to read "As a Migrator, you
can use these profiles to perform an application analysis." so it is
grammatically correct and includes the missing "you".
- Line 20: Remove the extra space between "delete" and "custom" in the sentence
"As an Architect, you can create, edit, and delete custom migration targets and
configurations." by editing the text in
assembly_centralized-configurations-analysis.adoc so it reads "create, edit, and
delete custom migration targets and configurations." Ensure only the double
space is removed and surrounding spacing/punctuation remains unchanged.
In
`@docs/topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adoc`:
- Line 26: The sentence "This option only appears if you are analyzing a single
application" is misleading in the profile configuration context; update the
sentence in the paragraph that begins "Upload a local binary." to either remove
that clause or replace it with a clarification such as "This option is shown
when configuring a profile for a single-application analysis" (or state that the
option is always available when creating a reusable profile), and ensure the
rest of the sentence about dragging or clicking Upload remains unchanged.
- Around line 68-70: Add a short warning note immediately after the "Click
Save." confirmation in proc_configuring-profile-for-an-application-analysis.adoc
indicating that analysis profiles are tied to target profiles and will be
automatically deleted if their associated target profile is removed; reference
the existing proc_configuring-target-profiles.adoc cascade-deletion note,
suggest users export or duplicate important analysis profiles before deleting
target profiles, and link to the target-profiles procedure for details.
In `@docs/topics/mta-ui/proc_configuring-target-profiles.adoc`:
- Around line 30-40: Resolve the Git merge conflict markers in the document by
removing the conflict headers/footers (<<<<<<<, =======, >>>>>>>) and
consolidating the duplicated content about the archetype detail view and the
deletion note into a single clean paragraph: keep the sentence "You can click on
the archetype row to open the archetype detail view where the target profiles
for the archetype are listed." and the NOTE block about deleting a target
profile also deleting its analysis profile, ensuring there are no leftover
conflict markers or duplicated lines.
In `@docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc`:
- Around line 26-29: The line referring to "Enable enhanced analysis details" is
incomplete; update the documentation snippet that contains the phrase "Enable
enhanced analysis details" by either (a) expanding it to explain exactly what
data or UI changes this toggles (e.g., additional metrics, logs, visualization
panels, or longer retention), typical scenarios to enable it (debugging,
detailed performance investigation, or verbose reporting), and any trade-offs
(performance, storage, or privacy) and steps to enable/disable it in the UI, or
(b) remove the step and the "//need more information..." TODO if the feature is
not ready to document; also delete the TODO comment and ensure the surrounding
procedure remains coherent after the change.
- Line 20: Add a warning note immediately after the step that currently reads
"Select a pre-configured profile from the list for running an analysis." (the
profile selection step) explaining that profiles are tied to target profiles and
may be automatically deleted if their associated target profile is removed;
reference the target profile deletion behavior documented in
proc_configuring-target-profiles.adoc so users can follow that link for details.
Ensure the note is brief, clearly labeled as a caution/important note, and
placed directly after the existing profile selection instruction so it appears
in the workflow where users choose a profile.
---
Nitpick comments:
In `@docs/topics/mta-ui/proc_configuring-target-profiles.adoc`:
- Line 27: The sentence "You can download this profile configuration from the
{ProductShortName} {CLIName} only if you select the profile from this list." is
ambiguous; update the sentence in proc_configuring-target-profiles.adoc (the
line containing "(Optional) Select an analysis profile...") to explicitly
reference "the list of available analysis profiles shown in the UI" and rephrase
to explain the restriction (e.g., downloads via {CLIName} are supported only for
profiles chosen from that UI list), so readers understand what "this list" means
and why the CLI download is limited to those profiles.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 76194c97-be11-487b-b891-69ac5b71a332
📒 Files selected for processing (6)
assemblies/ui-guide/assembly_centralized-configurations-analysis.adocdocs/topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adocdocs/topics/mta-ui/proc_configuring-target-profiles.adocdocs/topics/mta-ui/proc_creating-custom-migration-targets.adocdocs/topics/mta-ui/proc_running-an-analysis-using-profile.adocdocs/web-console-guide/master.adoc
assemblies/ui-guide/assembly_centralized-configurations-analysis.adoc
Outdated
Show resolved
Hide resolved
docs/topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adoc
Outdated
Show resolved
Hide resolved
docs/topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adoc
Show resolved
Hide resolved
added 2 commits
March 9, 2026 14:04
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
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 `@docs/topics/mta-ui/proc_configuring-target-profiles.adoc`:
- Line 27: The step tells users to select an analysis profile from the list but
omits the prerequisite that an analysis profile must exist; update the sentence
where it reads "(Optional) Select an analysis profile for the application from
the list..." to add a prerequisite or cross-reference to the analysis-profile
creation procedure (e.g., "Ensure an analysis profile exists — see 'Creating an
analysis profile'") so readers know what to do if the list is empty and can
follow the creation instructions before selecting a profile.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 7a34d741-c0f7-4acf-981c-4acc04fa02ee
📒 Files selected for processing (2)
docs/topics/mta-ui/proc_configuring-target-profiles.adocdocs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc
| . In the *Name* field in the opened dialogue, enter a unique name for the target profile. | ||
| . Click the *Tag category* field and select the category tag to associate with the tag. | ||
| . Select specific generators and click the right arrow to move the generator from the *Available generators* list to the *Chosen generators* list. | ||
| . (Optional) Select an analysis profile for the application from the list. You can download this profile configuration from the {ProductShortName} {CLIName} only if you select the profile from this list. |
There was a problem hiding this comment.
Add the missing prerequisite for this dropdown.
This step assumes an analysis profile already exists, but the procedure never says that. If the list is empty, readers have no next action. Add a short prerequisite or cross-reference to the analysis-profile creation procedure before telling them to select from the list.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/topics/mta-ui/proc_configuring-target-profiles.adoc` at line 27, The
step tells users to select an analysis profile from the list but omits the
prerequisite that an analysis profile must exist; update the sentence where it
reads "(Optional) Select an analysis profile for the application from the
list..." to add a prerequisite or cross-reference to the analysis-profile
creation procedure (e.g., "Ensure an analysis profile exists — see 'Creating an
analysis profile'") so readers know what to do if the list is empty and can
follow the creation instructions before selecting a profile.
Collaborator
Author
Collaborator
Author
Pkylas007
commented
Mar 16, 2026
| + | ||
| NOTE: {ProductShortName} displays automatically attached tags only _after_ you run the analysis. You can attach tags to the application manually instead of enabling automated tagging or in addition to it. | ||
| + | ||
| . *Enable enhanced analysis details*. |
Collaborator
Author
There was a problem hiding this comment.
@sjd78 Can you please provide me with information on what enhanced details mean?
Contributor
There was a problem hiding this comment.
I believe this generate and captures additional logging from the analysis.
There was a problem hiding this comment.
Enhanced details should already be defined in other parts of the documentation for the analysis wizard but basically it means:
- pod/contains logs and output of commands run in the addon are attached/uploaded to the hub as output is streamed rather than at the end of the analysis.
- more information details is captured. This includes the analyzer raw report.
Collaborator
Author
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
assemblies/ui-guide/assembly_centralized-configurations-analysis.adoc (1)
20-20:⚠️ Potential issue | 🟡 MinorFix double space before "custom".
There's an extra space between "delete" and "custom".
📝 Proposed fix
-As an Architect, you can create, edit, and delete custom migration targets and configurations. For example, analysis profiles and custom rulesets in the {ProductShortName} {WebName}. The analysis profiles contain the following details: +As an Architect, you can create, edit, and delete custom migration targets and configurations. For example, analysis profiles and custom rulesets in the {ProductShortName} {WebName}. The analysis profiles contain the following details:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@assemblies/ui-guide/assembly_centralized-configurations-analysis.adoc` at line 20, In the sentence "As an Architect, you can create, edit, and delete custom migration targets and configurations." remove the extra space between "delete" and "custom" so it reads "delete custom"; update the text in assembly_centralized-configurations-analysis.adoc for the sentence that begins "As an Architect, you can create, edit, and delete" to ensure only a single space exists before "custom".
🤖 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_centralized-configurations-analysis.adoc`:
- Line 30: The sentence "As a Migrator, you can use these profiles to perform an
application analysis." contains trailing whitespace after the period; remove the
extra space character at the end of that line so the line ends exactly with the
period and no trailing whitespace.
---
Duplicate comments:
In `@assemblies/ui-guide/assembly_centralized-configurations-analysis.adoc`:
- Line 20: In the sentence "As an Architect, you can create, edit, and delete
custom migration targets and configurations." remove the extra space between
"delete" and "custom" so it reads "delete custom"; update the text in
assembly_centralized-configurations-analysis.adoc for the sentence that begins
"As an Architect, you can create, edit, and delete" to ensure only a single
space exists before "custom".
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 068cb573-b723-4fb0-b0a5-32d409d1c2d0
📒 Files selected for processing (1)
assemblies/ui-guide/assembly_centralized-configurations-analysis.adoc
sshveta
suggested changes
Mar 19, 2026
docs/topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adoc
Show resolved
Hide resolved
docs/topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adoc
Outdated
Show resolved
Hide resolved
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Collaborator
Author
anarnold97
reviewed
Mar 23, 2026
|
|
||
|
|
||
| [role="_abstract"] | ||
| As an architect, you can configure a profile that has the configuration needed to analyze an application for a specific migration target. |
Contributor
There was a problem hiding this comment.
Suggested change
| As an architect, you can configure a profile that has the configuration needed to analyze an application for a specific migration target. | |
| As an Architect, you can configure a profile that has the configuration needed to analyze an application for a specific migration target. |
You have used capitalization consistently, see line 20 of assembly_centralized-configurations-analysis.adoc
Collaborator
Author
There was a problem hiding this comment.
Got it, capitalized the user persona, thanks!
anarnold97
reviewed
Mar 23, 2026
Contributor
|
@Pkylas007 - strong documentation, thanks |
jortel
reviewed
Mar 24, 2026
| ifdef::context[] | ||
| [id="centralized-configurations_{context}"] | ||
| endif::[] | ||
| = Analyzing an application with centralized profiles |
There was a problem hiding this comment.
I don't think "centralized" makes sense here. The nature of tackle is that everything is centralized.
Contributor
There was a problem hiding this comment.
"analysis profiles" lines up better with the UI
Collaborator
Author
There was a problem hiding this comment.
Thanks, yes that's right! Changed it to 'analysis profiles'.
sjd78
suggested changes
Mar 25, 2026
| ifdef::context[] | ||
| [id="centralized-configurations_{context}"] | ||
| endif::[] | ||
| = Analyzing an application with centralized profiles |
Contributor
There was a problem hiding this comment.
"analysis profiles" lines up better with the UI
| + | ||
| NOTE: {ProductShortName} displays automatically attached tags only _after_ you run the analysis. You can attach tags to the application manually instead of enabling automated tagging or in addition to it. | ||
| + | ||
| . *Enable enhanced analysis details*. |
Contributor
There was a problem hiding this comment.
I believe this generate and captures additional logging from the analysis.
jortel
reviewed
Mar 25, 2026
|
|
||
| As a Migrator, you can use these profiles to perform an application analysis. | ||
|
|
||
| The {ProductShortName} Hub stores and syncs the profile configurations. {ProductShortName} components periodically sync with the Hub and pull the analysis profiles that contain the latest updates to the configuration. |
There was a problem hiding this comment.
The hub does not "sync" profiles but rather provides them to external components wanting to sync them.
Collaborator
Author
There was a problem hiding this comment.
Ok, I have removed the "syncs" part. Please could you check if it works now?
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
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_centralized-configurations-analysis.adoc`:
- Line 20: The sentence fragment "For example, analysis profiles and custom
rulesets in the {ProductShortName} {WebName}." should be rewritten as a complete
sentence; locate the sentence that begins "For example, analysis profiles and
custom rulesets..." and change it to a full sentence such as "For example, you
can create, edit, and delete analysis profiles and custom rulesets in the
{ProductShortName} {WebName}." Ensure the revised sentence clearly ties these
examples to the preceding statement about creating, editing, and deleting custom
migration targets and configurations.
🪄 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: 43baf69c-eb3b-4193-8962-cb49fba043bc
📒 Files selected for processing (3)
assemblies/ui-guide/assembly_centralized-configurations-analysis.adocdocs/topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adocdocs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc
✅ Files skipped from review due to trivial changes (2)
- docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc
- docs/topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adoc
| [role="_abstract"] | ||
| Use standardized configurations across components of {ProductFirstRef} such as the {WebName}, {CLIName}, and the Visual Studio Code {PluginName} by using the centralized configuration management in {ProductFullName}. | ||
|
|
||
| As an Architect, you can create, edit, and delete custom migration targets and configurations. For example, analysis profiles and custom rulesets in the {ProductShortName} {WebName}. The analysis profiles contain the following details: |
There was a problem hiding this comment.
Clarify the sentence structure for the examples list.
Line 20 reads as a fragment (For example, analysis profiles and custom rulesets ...). Please rewrite as a complete sentence to improve readability.
✏️ Proposed wording
-As an Architect, you can create, edit, and delete custom migration targets and configurations. For example, analysis profiles and custom rulesets in the {ProductShortName} {WebName}. The analysis profiles contain the following details:
+As an Architect, you can create, edit, and delete custom migration targets and configurations, such as analysis profiles and custom rulesets in the {ProductShortName} {WebName}. The analysis profiles contain the following details:📝 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
| As an Architect, you can create, edit, and delete custom migration targets and configurations. For example, analysis profiles and custom rulesets in the {ProductShortName} {WebName}. The analysis profiles contain the following details: | |
| As an Architect, you can create, edit, and delete custom migration targets and configurations, such as analysis profiles and custom rulesets in the {ProductShortName} {WebName}. The analysis profiles contain the following details: |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@assemblies/ui-guide/assembly_centralized-configurations-analysis.adoc` at
line 20, The sentence fragment "For example, analysis profiles and custom
rulesets in the {ProductShortName} {WebName}." should be rewritten as a complete
sentence; locate the sentence that begins "For example, analysis profiles and
custom rulesets..." and change it to a full sentence such as "For example, you
can create, edit, and delete analysis profiles and custom rulesets in the
{ProductShortName} {WebName}." Ensure the revised sentence clearly ties these
examples to the preceding statement about creating, editing, and deleting custom
migration targets and configurations.
Collaborator
Author
|
@sshveta Please could you run through the updates in the PR? Thanks! |
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
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
5 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.
JIRA
Version
Preview
Summary by CodeRabbit