Skip to content

MTA-6288 Centralized Configuration for UI#326

Open
Pkylas007 wants to merge 3 commits intomainfrom
mta-6288-centralized-config-ui-guide
Open

MTA-6288 Centralized Configuration for UI#326
Pkylas007 wants to merge 3 commits intomainfrom
mta-6288-centralized-config-ui-guide

Conversation

@Pkylas007
Copy link
Collaborator

@Pkylas007 Pkylas007 commented Mar 9, 2026

JIRA

Version

  • 8.1.0

Preview

Summary by CodeRabbit

  • Documentation
    • Added a new guide for centralized configurations analysis and profile management
    • Added procedures for configuring, running, and managing analysis profiles in the Migration UI
    • Updated target-profile creation docs to allow selecting analysis profiles and clarified deletion behavior
    • Updated custom migration targets docs with navigation changes and Technology Preview notes
    • Integrated centralized analysis guide into the web console documentation

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

coderabbitai bot commented Mar 9, 2026

Warning

Rate limit exceeded

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

⌛ 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: ea5635b6-6f17-496e-bd1b-469de8da3d69

📥 Commits

Reviewing files that changed from the base of the PR and between f77e032 and 6d04bb5.

📒 Files selected for processing (1)
  • assemblies/ui-guide/assembly_centralized-configurations-analysis.adoc
📝 Walkthrough

Walkthrough

Adds centralized configurations analysis documentation and related UI procedures: a new assembly, two new how‑to procedures (configure profile, run analysis), updates to target/custom migration procedures, and inclusion of the assembly in the web-console-guide master file.

Changes

Cohort / File(s) Summary
New Analysis Assembly
assemblies/ui-guide/assembly_centralized-configurations-analysis.adoc
Adds an assembly document with metadata, abstract, roles, Technology Preview notice, and includes for three analysis-related procedures.
Analysis Profile Procedures (new)
docs/topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adoc, docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc
Adds step‑by‑step guides: creating/configuring analysis profiles (sources, targets, scope, advanced rules) and running an analysis using a saved profile, including status tracking and report download notes.
Target/Custom Migration Procedure updates
docs/topics/mta-ui/proc_configuring-target-profiles.adoc, docs/topics/mta-ui/proc_creating-custom-migration-targets.adoc
Clarifies selection of analysis profiles during target profile creation, adds deletion behavior note, updates navigation context to Migration view, and marks Python/Node.js providers as Technology Preview.
Guide Integration
docs/web-console-guide/master.adoc
Replaces a commented include with an active include to the new centralized configurations analysis assembly.

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

  • mpershina
  • anarnold97

Poem

🐰 I nibble docs beneath the moon,

Profiles bloom and steps align soon.
Central configs, tidy and bright,
Migrators hop with pure delight. 🥕✨

🚥 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 accurately reflects the main purpose of the pull request: adding centralized configuration documentation for the UI, as evidenced by the new assembly file and multiple procedure files documenting analysis profiles and configuration workflows.
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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch mta-6288-centralized-config-ui-guide

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.

@Pkylas007
Copy link
Collaborator Author

Peer review is completed in #297 which is now closed.

Copy link

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

📥 Commits

Reviewing files that changed from the base of the PR and between a846fa9 and 2917c03.

📒 Files selected for processing (6)
  • assemblies/ui-guide/assembly_centralized-configurations-analysis.adoc
  • docs/topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adoc
  • docs/topics/mta-ui/proc_configuring-target-profiles.adoc
  • docs/topics/mta-ui/proc_creating-custom-migration-targets.adoc
  • docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc
  • docs/web-console-guide/master.adoc

Prabha Kylasamiyer Sundara Rajan 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>
Copy link

@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

🤖 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

📥 Commits

Reviewing files that changed from the base of the PR and between 2917c03 and f77e032.

📒 Files selected for processing (2)
  • docs/topics/mta-ui/proc_configuring-target-profiles.adoc
  • docs/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.
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

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.

@Pkylas007
Copy link
Collaborator Author

Pkylas007 commented Mar 9, 2026

@jortel @sjd78 @sshveta Could you review this PR, please?

@Pkylas007 Pkylas007 requested a review from sshveta March 11, 2026 03:20
@Pkylas007
Copy link
Collaborator Author

@jortel @sjd78 @sshveta Could you review this PR, please?

Hi folks, this is a gentle reminder to review this PR. Thanks much!

+
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*.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@sjd78 Can you please provide me with information on what enhanced details mean?

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.

1 participant