MTA-6288 Centralized configuration in the MTA web console#297
Closed
MTA-6288 Centralized configuration in the MTA web console#297
Conversation
Pkylas007
force-pushed
the
mta-6288-centralized-config-ui
branch
from
007720a to
5233cf5
Compare
Contributor
|
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 documentation and UI guidance for a new Analysis Profile feature (Technology Preview), including three new procedural topics, updates to related procedures and assemblies, and master index inclusion for centralized configurations analysis. Components synchronize profiles from the Hub; analyses can be run using saved profiles. Changes
Sequence Diagram(s)sequenceDiagram
participant UI as Migration UI
participant Hub as Central Hub
participant Analyzer as Analyzer Cluster / Task Manager
participant Storage as Reports / Repository
UI->>Hub: Create/Save Analysis Profile
Hub-->>UI: Confirm saved
note right of Hub: Profiles stored and versioned
Analyzer->>Hub: Periodic sync (pull profiles)
Hub-->>Analyzer: Return latest profiles
UI->>Analyzer: Run analysis using selected profile
Analyzer->>Analyzer: Schedule task (Task Manager)
Analyzer-->>UI: Status updates (Scheduled → In-progress → Completed)
Analyzer->>Storage: Store Reports (HTML/YAML)
UI->>Storage: Request/Download report
Storage-->>UI: Deliver report (permission-checked)
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 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 |
![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: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/topics/web-console/proc_configuring-target-profiles.adoc (1)
18-18:⚠️ Potential issue | 🟡 MinorFix grammar for plural subject. The sentence should read “appear,” not “appears.”
✏️ Suggested fix
-The *Target profiles for <archetype-name>* appears. +The *Target profiles for <archetype-name>* appear.
🤖 Fix all issues with AI agents
In `@assemblies/ui-guide/assembly_centralized-configurations-analysis.adoc`:
- Line 20: There's a double space in the sentence "delete custom migration
targets and configurations."—replace the two spaces between "delete" and
"custom" with a single space so it reads "delete custom migration targets and
configurations." (Search for the exact phrase "delete custom migration targets
and configurations." to locate and fix.)
In
`@docs/topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc`:
- Line 84: Update the UI label in the sentence that currently reads "Set target"
to match the earlier label "Set targets" so the text is consistent; locate the
sentence in the docs content that mentions "*Set target* tab" and change the
emphasized label to "*Set targets* tab" (the surrounding sentence referencing
the Custom Rules tab and uploading custom rule files should remain unchanged).
In `@docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc`:
- Line 29: The inline TODO comment must be removed and replaced with a clear
user-facing description for the “Enable enhanced analysis details” option:
locate the inline TODO in the proc_running-an-analysis-using-profile document
near the option label "Enable enhanced analysis details", delete the TODO marker
and insert a concise explanation of what the option does (when enabled, what
extra data or UI changes appear, any performance or privacy tradeoffs, and
default behavior), and ensure the text uses the same tone/formatting as
surrounding options and includes any relevant prerequisites or toggles
referenced by the document.
| [role="_abstract"] | ||
| Centralized configuration management allows organizations to use standardized configurations across components of {ProductFirstRef} such as the {WebName}, {CLIName}, and the Visual Studio Code {PluginName}. | ||
|
|
||
| This feature allows Architects to 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: |
Contributor
There was a problem hiding this comment.
Fix double space.
✏️ Suggested fix
-This feature allows Architects to create, edit, and delete custom migration targets and configurations.
+This feature allows Architects to create, edit, and delete custom migration targets and configurations.📝 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
| This feature allows Architects to 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: | |
| This feature allows Architects to 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
In `@assemblies/ui-guide/assembly_centralized-configurations-analysis.adoc` at
line 20, There's a double space in the sentence "delete custom migration
targets and configurations."—replace the two spaces between "delete" and
"custom" with a single space so it reads "delete custom migration targets and
configurations." (Search for the exact phrase "delete custom migration targets
and configurations." to locate and fix.)
shdeshpa07
reviewed
Feb 11, 2026
Collaborator
shdeshpa07
left a comment
shdeshpa07
left a comment
There was a problem hiding this comment.
LGTM barring a few comments. I would encourage to re-visit the short descriptions for a re-write where ever applicable. This is needed for DITA compliance. Ihave linked the resources in a comment. Great work overall. Thanks!
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In
`@docs/topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc`:
- Around line 9-10: The abstract sentence "A a migrator, can analyze more than
one application at a time against more than one transformation target in the
same analysis." is ungrammatical; replace it with a clear phrasing such as "A
migrator can analyze more than one application at a time against more than one
transformation target in the same analysis." to remove the duplicated article
and restore proper sentence structure.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In
`@docs/topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc`:
- Line 87: Update the documentation entry for the bullet "Enable enhanced
analysis details" by adding a one- or two-sentence explanation directly after
that line describing what "enhanced analysis details" includes (e.g., more
verbose diagnostics, deeper trace/span data, or additional metrics), when to
enable it (e.g., during debugging, root-cause analysis, or when you need
detailed telemetry), and the trade-off (e.g., increased data volume or
performance overhead); reference the exact option string "Enable enhanced
analysis details" so readers can find it in the UI and keep the wording concise
and user-focused.
- Around line 77-78: Add short explanatory sentences under the headings
"Additional target labels" and "Additional source labels" describing their
purpose and usage (e.g., that "Additional target labels" are custom labels
applied to target artifacts to refine selection or grouping during analysis, and
"Additional source labels" mark input/source components for filtering or
reporting), mirror the style used for "Excluded rules labels", and include a
brief example or common use case to clarify how a user would supply these
labels.
🧹 Nitpick comments (3)
docs/topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc (3)
34-34: Clarify article usage in the second sentence.The phrase "for an analysis" is slightly ambiguous. Consider changing to "for the analysis" (referring to this specific analysis) or "for each analysis" (if applicable to multiple analyses) for better clarity.
✏️ Suggested improvement
-. Select *Manual selection* in the *Mode* section for the analysis. You can provide a unique configuration for an analysis. +. Select *Manual selection* in the *Mode* section for the analysis. You can provide a unique configuration for the analysis.
67-67: Consider aligning formatting with other scope options.The "Exclude packages" option has a different structure than the other scope options (lines 64-66). The other options are described as selections, while this one begins with instructions about toggling. Consider rephrasing for consistency with the list structure above.
✏️ Suggested improvement
-* Exclude packages. If you toggle this option on, type the name of the package and click *Add*. +* Exclude specific packages. Toggle this option on, then type the name of each package to exclude and click *Add*.
85-85: Consider breaking up the lengthy note for improved readability.The note at line 85 covers multiple concepts (standard rules, custom targets, unsupported languages, custom rule uploads, and validation) in a single long sentence. While technically accurate, breaking this into smaller, focused notes or a short bulleted list could improve readability and help users quickly find relevant information.
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Pkylas007
force-pushed
the
mta-6288-centralized-config-ui
branch
from
2e3b62f to
8490205
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/topics/mta-ui/proc_configuring-target-profiles.adoc (1)
27-27: Clarify the download constraint to avoid misinterpretation.“The profile configuration can be downloaded … only if you select the profile from this list” reads like a hard product limitation but doesn’t explain why or where in the UI. Consider tightening the wording so it’s unambiguous (e.g., “CLI download is available only for profiles selected here” or “CLI download is disabled unless a profile is selected”).
🤖 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, Reword the ambiguous sentence so it clearly states the download precondition and the mechanism: replace “You can download this profile configuration from the {ProductShortName} {CLIName} only if you select the profile from this list.” with a concise statement such as “The {CLIName} can download the profile configuration only for profiles selected from this list,” or “CLI download is disabled unless you first select a profile from this list,” ensuring the wording appears in the same paragraph that begins “(Optional) Select an analysis profile…” to clarify the UI location and the download constraint.
🤖 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 pronoun; update the sentence to
include "you" so it reads "As a Migrator, you can use these profiles to perform
an application analysis." to correct the grammar in the
assembly_centralized-configurations-analysis.adoc content.
In
`@docs/topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc`:
- Line 91: Update the "Enable enhanced analysis details" bullet to include a
concise description of what it does, when to use it, and any trade-offs: explain
that "Enable enhanced analysis details" turns on more verbose diagnostics (e.g.,
additional metrics, deeper code insights and extended stack traces), recommend
enabling it for complex apps or troubleshooting when standard analysis is
insufficient, and warn about potential impacts (longer analysis time and higher
CPU/memory usage); place this text inline or as a short sub-bullet beneath the
"Enable enhanced analysis details" item so readers immediately see purpose, use
cases, and performance implications.
---
Duplicate comments:
In `@assemblies/ui-guide/assembly_centralized-configurations-analysis.adoc`:
- Line 20: Fix the double space in the sentence that currently reads "delete
custom migration targets" by replacing the two spaces between "delete" and
"custom" with a single space so it reads "delete custom migration targets";
update the sentence in the assembly_centralized-configurations-analysis.adoc
content where the phrase appears (look for the exact string "delete custom
migration targets") to ensure consistent spacing.
---
Nitpick comments:
In `@docs/topics/mta-ui/proc_configuring-target-profiles.adoc`:
- Line 27: Reword the ambiguous sentence so it clearly states the download
precondition and the mechanism: replace “You can download this profile
configuration from the {ProductShortName} {CLIName} only if you select the
profile from this list.” with a concise statement such as “The {CLIName} can
download the profile configuration only for profiles selected from this list,”
or “CLI download is disabled unless you first select a profile from this list,”
ensuring the wording appears in the same paragraph that begins “(Optional)
Select an analysis profile…” to clarify the UI location and the download
constraint.
| .. Custom rules | ||
| .. Rule labels to include or exclude rules for an analysis | ||
|
|
||
| As a Migrator, can use these profiles to perform an application analysis. |
Contributor
There was a problem hiding this comment.
Fix the grammar: add missing subject pronoun.
The sentence "As a Migrator, can use these profiles" is missing the subject pronoun "you".
✏️ Proposed fix
-As a Migrator, can use these profiles to perform an application analysis.
+As a Migrator, you can use these profiles to perform an application analysis.📝 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 a Migrator, can use these profiles to perform an application analysis. | |
| As a Migrator, you can use these profiles to perform an application analysis. |
🤖 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 30, The sentence "As a Migrator, can use these profiles to perform an
application analysis." is missing the subject pronoun; update the sentence to
include "you" so it reads "As a Migrator, you can use these profiles to perform
an application analysis." to correct the grammar in the
assembly_centralized-configurations-analysis.adoc content.
| NOTE: Analysis engines use standard rules for a comprehensive set of migration targets. However, if the target is not included, is a customized framework, or the application is written in a language that is not supported, for example, Ruby, you can add custom rules by skipping the target selection in the Set Target tab and uploading custom rule files in the Custom Rules tab. Only custom rule files that are uploaded manually are validated. | ||
| NOTE: Analysis engines use standard rules for a comprehensive set of migration targets. However, if the target is not included, is a customized framework, or the application is written in a language that is not supported, for example, Ruby, you can add custom rules by skipping the target selection in the *Set targets* tab. Upload custom rule files in the Custom Rules tab. Only custom rule files that are uploaded manually are validated. | ||
| + | ||
| * Enable enhanced analysis details. |
Contributor
There was a problem hiding this comment.
Add explanation for the "Enable enhanced analysis details" option.
This option is listed without any description of its purpose, what it enables, or when users should enable it. Users need to understand what "enhanced analysis details" provides and any trade-offs (e.g., increased analysis time or resource usage).
Consider adding a brief explanation such as:
- What enhanced details are included (e.g., more verbose diagnostics, additional metrics, deeper code insights)
- When to enable it (e.g., for complex applications, troubleshooting, or when standard analysis is insufficient)
- Any performance or resource implications
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc`
at line 91, Update the "Enable enhanced analysis details" bullet to include a
concise description of what it does, when to use it, and any trade-offs: explain
that "Enable enhanced analysis details" turns on more verbose diagnostics (e.g.,
additional metrics, deeper code insights and extended stack traces), recommend
enabling it for complex apps or troubleshooting when standard analysis is
insufficient, and warn about potential impacts (longer analysis time and higher
CPU/memory usage); place this text inline or as a short sub-bullet beneath the
"Enable enhanced analysis details" item so readers immediately see purpose, use
cases, and performance implications.
Collaborator
Author
|
@sjd78 Please could you review this PR? |
Collaborator
Author
|
@sjd78 Could you review this PR, please? |
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Pkylas007
force-pushed
the
mta-6288-centralized-config-ui
branch
from
8ad1c06 to
f152537
Compare
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.
JIRA
Version
Preview
Summary by CodeRabbit
New Features
Documentation