Skip to content

[April CQA] CQA fixes for the UI title (terminology, UI formatting, style cleanup)#361

Merged
mpershina merged 6 commits intomainfrom
UI-April
Apr 23, 2026
Merged

[April CQA] CQA fixes for the UI title (terminology, UI formatting, style cleanup)#361
mpershina merged 6 commits intomainfrom
UI-April

Conversation

@mpershina
Copy link
Copy Markdown
Collaborator

@mpershina mpershina commented Apr 20, 2026

Tracked under:

Preview: https://mpershina.github.io/Previews/MTA/UI-CQA.html

Summary by CodeRabbit

  • Documentation
    • Improved clarity, consistency, and typography across many UI procedures and guides (wording, punctuation, emphasis, apostrophes, trailing-whitespace and image alt-text fixes).
    • Clarified asset-generation, archetype, generator, target-profile, and application descriptions with concrete examples and streamlined phrasing.
    • Made questionnaire and assessment docs explicit about automated answers, tagging, and reporting behavior.
    • Refined guidance for credentials, repositories, analysis, Jira, tagging, and import/export workflows for clearer UI directions.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 20, 2026

📝 Walkthrough

Walkthrough

This PR applies textual and formatting edits across many MTA AsciiDoc UI guide files: typography fixes, wording refinements, image/alt-text adjustments, and clarifications of questionnaire/archetype/asset-generation descriptions. No code or public API entities were changed.

Changes

Cohort / File(s) Summary
Assembly UI guide — Asset generation & conceptual
assemblies/ui-guide/assembly_asset-generation-ui.adoc, assemblies/ui-guide/assembly_working-with-archetypes.adoc, assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc, assemblies/ui-guide/assembly_managing-applications.adoc
Rewrote and restructured explanatory text for asset-generation, archetypes, and custom questionnaires; standardized actor references to {ProductShortName}; adjusted examples and wording (JBoss EAP/OpenJDK/Git templates).
Assembly UI guide — Configuration & repos
assemblies/ui-guide/assembly_configuring-credentials.adoc, assemblies/ui-guide/assembly_configuring-repositories.adoc, assemblies/ui-guide/assembly_configuring-mta-instance.adoc
Typography/formatting changes: bolded credential labels, italicized repository types, replaced curly apostrophe and removed trailing whitespace.
Concept / Reference topics
docs/topics/mta-ui/con_assessment-module-features.adoc, docs/topics/mta-ui/con_mta-default-questionnaire.adoc, docs/topics/mta-ui/ref_custom-questionnaire-fields.adoc
Rephrased feature abstracts and questionnaire descriptions; tightened YAML/example wording and clarified questionnaire field semantics and thresholds.
Procedures — Analysis & profiles
docs/topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc, docs/topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adoc, docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc
Clarified UI references, Maven/credential guidance, upload instructions, automated-tagging notes, analysis scheduling, and Kubernetes provisioning phrasing; removed commented image lines.
Procedures — General UI wording & status
docs/topics/mta-ui/proc_adding-applications.adoc, docs/topics/mta-ui/proc_assessing-an-application.adoc, docs/topics/mta-ui/proc_creating-migration-waves.adoc, docs/topics/mta-ui/proc_creating-source-platform.adoc, docs/topics/mta-ui/proc_downloading-an-analysis-report.adoc, docs/topics/mta-ui/proc_reviewing-an-analysis-report.adoc, docs/topics/mta-ui/proc_reviewing-a-task-log.adoc
Small wording edits (e.g., "appears" → "is displayed"), whitespace cleanup, and punctuation/formatting tightening.
Procedures — Image/alt-text & commented images
docs/topics/mta-ui/proc_adding-source-platform-application.adoc, docs/topics/mta-ui/proc_configuring-asset-repository.adoc, docs/topics/mta-ui/proc_configuring-git-repos.adoc, docs/topics/mta-ui/proc_configuring-subversion-repos.adoc, docs/topics/mta-ui/proc_generating-discovery-manifest-web.adoc
Added alt text to image macros, removed commented-out image lines, and adjusted emphasis for controls (e.g., Select all).
Procedures — Credentials / Jira / connections
docs/topics/mta-ui/proc_configuring-jira-credentials.adoc, docs/topics/mta-ui/proc_creating-a-jira-connection.adoc, docs/topics/mta-ui/proc_creating-jira-issues-for-migration-wave.adoc
Reworded credential/connection save and verification text, consolidated instance-type credential notes, and revised deletion/verification phrasing and export labels.
Procedures — Tags & archetype review
docs/topics/mta-ui/proc_creating-a-tag.adoc, docs/topics/mta-ui/proc_creating-application-tags.adoc, docs/topics/mta-ui/proc_displaying-automated-tasks.adoc, docs/topics/mta-ui/proc_assessing-an-archetype.adoc, docs/topics/mta-ui/proc_reviewing-an-archetype.adoc, docs/topics/mta-ui/proc_reviewing-assessment-report.adoc
Terminology and grammar adjustments: category wording, apostrophe styles, explicit attribution of assessed/reviewed status to {ProductShortName}, and clarified multi-archetype behavior.
Procedures — Import / bulk ops
docs/topics/mta-ui/proc_importing-an-app-list.adoc, docs/topics/mta-ui/proc_generating-discovery-manifest-web.adoc
Rephrased import description; replaced ".csv" with "comma-separated values (CSV)"; minor control-label edits.
Misc minor edits
docs/topics/mta-ui/proc_configuring-target-profiles.adoc, plus assorted small wording/formatting fixes across many docs
Placeholder formatting adjustments, punctuation fixes, and trailing-whitespace/newline corrections across multiple procedure and assembly topics.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • anarnold97
  • Pkylas007

"🐰
With paws on the keyboard so bright,
I hop through docs to make them right.
From commas, caps, to alt-text cheer,
I tidy guides, each line made clear.
Hooray — the docs now sparkle, dear!"

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: CQA (content quality assurance) fixes addressing terminology, UI formatting, and style cleanup across documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch UI-April

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.

Copy link
Copy Markdown
Contributor

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

🧹 Nitpick comments (3)
docs/topics/mta-ui/proc_adding-applications.adoc (1)

38-38: Consider matching inline emphasis for Git with surrounding labels.

Neighboring bullets use emphasized product/repository labels (*Subversion*), so *Git* here would keep the list stylistically uniform.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/topics/mta-ui/proc_adding-applications.adoc` at line 38, Change the
inline label `Git` to use the same emphasis styling as neighboring labels (i.e.,
replace `Git` with `*Git*`) so the bullet "** For Git: this might be any
reference; `commit-hash`, `branch` or `tag`." becomes "** For *Git*: this might
be any reference; `commit-hash`, `branch` or `tag`." to match the `*Subversion*`
style used elsewhere.
assemblies/ui-guide/assembly_working-with-archetypes.adoc (1)

20-20: Optional grammar polish for smoother readability.

Line 20 would read more naturally as “based on the archetype’s characteristics.”

📝 Suggested tweak
-An archetype is a group of applications with common characteristics. Criteria tags and the application taxonomy define application archetypes. Each archetype defines how the assessment module assesses the application based on archetype's characteristics. If an application's tags match an archetype's criteria tags, the system associates the application with that archetype.
+An archetype is a group of applications with common characteristics. Criteria tags and the application taxonomy define application archetypes. Each archetype defines how the assessment module assesses the application based on the archetype's characteristics. If an application's tags match an archetype's criteria tags, the system associates the application with that archetype.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@assemblies/ui-guide/assembly_working-with-archetypes.adoc` at line 20, Update
the sentence in assembly_working-with-archetypes.adoc that currently reads "the
assessment module assesses the application based on archetype's characteristics"
to include the definite article: change it to "the assessment module assesses
the application based on the archetype's characteristics" so the phrase reads
naturally; locate the sentence in the paragraph describing archetypes and
replace the phrase accordingly.
assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc (1)

58-58: Consider simplifying the example sentence structure.

The second sentence is quite long with parallel examples. While technically correct, breaking it into separate sentences could improve readability.

📝 Optional readability improvement
-The {ProductShortName} selects automated answers based on the tags existing on the application or archetype. For example, if an application or archetype has the `Runtime/Quarkus` tag, the {ProductShortName} automatically selects the `Quarkus` answer, and if an application or archetype has the `Runtime/Spring Boot` tag, the {ProductShortName} automatically selects the `Spring Boot` answer:
+The {ProductShortName} selects automated answers based on the tags existing on the application or archetype. For example, if an application or archetype has the `Runtime/Quarkus` tag, the {ProductShortName} automatically selects the `Quarkus` answer. Similarly, if an application or archetype has the `Runtime/Spring Boot` tag, the {ProductShortName} automatically selects the `Spring Boot` answer:
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc` at line 58, The
sentence demonstrating tag-to-answer mapping is long and hard to read; update
the paragraph that mentions {ProductShortName} and the examples with
`Runtime/Quarkus` → `Quarkus` and `Runtime/Spring Boot` → `Spring Boot` by
splitting the current long sentence into two shorter sentences (one stating that
{ProductShortName} selects answers based on tags, and a second that gives the
two examples separately or as two short clauses) to improve readability while
preserving the same examples and meaning.
🤖 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_asset-generation-ui.adoc`:
- Line 31: The target profile description repeats the same idea using both
“simultaneously” and “at the same time”; edit the sentence pair in the target
profile so only one of those phrases remains (e.g., keep “simultaneously” and
remove “at the same time” in the second sentence or vice versa) so the paragraph
reads cleanly and without redundancy.

In `@docs/topics/mta-ui/con_assessment-module-features.adoc`:
- Line 17: Remove the unnecessary comma in the sentence "The *Assessment* module
supports assessment questionnaires, relevant to one or more applications." by
editing that sentence in con_assessment-module-features.adoc (the line
containing "The *Assessment* module supports assessment questionnaires, relevant
to one or more applications.") to read without the comma after "questionnaires"
so it becomes "The *Assessment* module supports assessment questionnaires
relevant to one or more applications."

In `@docs/topics/mta-ui/proc_assessing-an-archetype.adoc`:
- Line 11: Fix the typo in the user-facing sentence "The {ProductShortName}
marks an archetype as assessed after ypu answer all required questionnaires." by
replacing "ypu" with "you" so the sentence reads "The {ProductShortName} marks
an archetype as assessed after you answer all required questionnaires." Update
this in the document content for
docs/topics/mta-ui/proc_assessing-an-archetype.adoc where that exact sentence
appears.

In `@docs/topics/mta-ui/proc_creating-a-jira-connection.adoc`:
- Around line 25-27: The text uses the variant "Jira Server/Data center" which
is inconsistent with other occurrences; standardize the UI term by replacing
that phrase (and any other variants like "Jira Server/Datacenter") with the
chosen canonical label "Jira Server/Data Center" in the document and across the
PR so the instance type list and all references use the exact same wording;
update the two bullets in the section (the selection line and the second bullet)
and any other occurrences of the old variant to the new canonical string.
- Line 37: The sentence in
docs/topics/mta-ui/proc_creating-a-jira-connection.adoc currently reads "click
the status to check the reason of the error"; update that phrase to "click the
status to check the reason for the error" (replace "reason of the error" with
"reason for the error") to fix the grammar in the “Not connected” verification
bullet.

In `@docs/topics/mta-ui/proc_downloading-an-analysis-report.adoc`:
- Line 23: Remove the trailing whitespace after the sentence "Click the
application row to open the application drawer." in the step text; locate that
exact step text in proc_downloading-an-analysis-report.adoc and trim the space
at the end so the line ends with "drawer." (no trailing space).

In `@docs/topics/mta-ui/proc_reviewing-an-analysis-report.adoc`:
- Line 15: The step string "Click the application row to open the application
drawer." in docs/topics/mta-ui/proc_reviewing-an-analysis-report.adoc contains a
trailing space; remove the extra whitespace at the end of that sentence so the
line ends exactly with "drawer." to ensure style consistency.

In `@docs/topics/mta-ui/proc_reviewing-an-archetype.adoc`:
- Line 29: Update the “Proposed Action” definition sentence to include the
missing linking verb: change "** *Proposed Action*: A proposed action required
to complete the migration or modernization of the archetype." to include "that
is required" (e.g., "** *Proposed Action*: A proposed action that is required to
complete the migration or modernization of the archetype.") so the sentence is
grammatical; modify the paragraph containing the "Proposed Action" text
accordingly.

In `@docs/topics/mta-ui/proc_reviewing-assessment-report.adoc`:
- Line 11: The second sentence ("You can use this report to view aggregated data
from multiple application questionnaires for different applications.") is
repetitive; update it to remove duplication by replacing "multiple application
questionnaires for different applications" with a simpler phrase such as
"questionnaires for multiple applications" (so the sentence reads: "You can use
this report to view aggregated data from questionnaires for multiple
applications.") — locate and edit that sentence in
proc_reviewing-assessment-report.adoc (search for the exact sentence) and make
the replacement to improve readability.

In `@docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc`:
- Line 36: The last sentence in the paragraph uses the AsciiDoc attribute
without a preceding space ("the{ProductShortName}"); update that sentence to
insert a space before the {ProductShortName} attribute so it reads "the
{ProductShortName}" to correct spacing around the attribute reference.

In `@docs/topics/mta-ui/ref_custom-questionnaire-fields.adoc`:
- Line 49: In the `name` field description you have a duplicated article ("the
the"); edit the sentence to remove the extra "the" so it reads correctly (for
example: "A name of the section." or "The name of the section.") in the `name`
description entry.
- Line 37: Update the `unknown` threshold bullet so its wording matches the
other threshold descriptions: replace “The numeric of unknown answers allowed in
the questionnaire before the {ProductShortName} marks the risk level as
unknown.” with a grammatically correct phrase such as “The number of unknown
answers allowed in the questionnaire before the {ProductShortName} marks the
risk level as unknown.”; ensure this change is made in the `unknown` threshold
description entry so style and tone match the other bullets.

---

Nitpick comments:
In `@assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc`:
- Line 58: The sentence demonstrating tag-to-answer mapping is long and hard to
read; update the paragraph that mentions {ProductShortName} and the examples
with `Runtime/Quarkus` → `Quarkus` and `Runtime/Spring Boot` → `Spring Boot` by
splitting the current long sentence into two shorter sentences (one stating that
{ProductShortName} selects answers based on tags, and a second that gives the
two examples separately or as two short clauses) to improve readability while
preserving the same examples and meaning.

In `@assemblies/ui-guide/assembly_working-with-archetypes.adoc`:
- Line 20: Update the sentence in assembly_working-with-archetypes.adoc that
currently reads "the assessment module assesses the application based on
archetype's characteristics" to include the definite article: change it to "the
assessment module assesses the application based on the archetype's
characteristics" so the phrase reads naturally; locate the sentence in the
paragraph describing archetypes and replace the phrase accordingly.

In `@docs/topics/mta-ui/proc_adding-applications.adoc`:
- Line 38: Change the inline label `Git` to use the same emphasis styling as
neighboring labels (i.e., replace `Git` with `*Git*`) so the bullet "** For Git:
this might be any reference; `commit-hash`, `branch` or `tag`." becomes "** For
*Git*: this might be any reference; `commit-hash`, `branch` or `tag`." to match
the `*Subversion*` style used elsewhere.
🪄 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: e6b31898-ab28-4d93-96fe-0196e0e97f98

📥 Commits

Reviewing files that changed from the base of the PR and between c7fe7bf and 1ee0d59.

📒 Files selected for processing (37)
  • assemblies/ui-guide/assembly_asset-generation-ui.adoc
  • assemblies/ui-guide/assembly_configuring-credentials.adoc
  • assemblies/ui-guide/assembly_configuring-mta-instance.adoc
  • assemblies/ui-guide/assembly_configuring-repositories.adoc
  • assemblies/ui-guide/assembly_managing-applications.adoc
  • assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc
  • assemblies/ui-guide/assembly_working-with-archetypes.adoc
  • docs/topics/mta-ui/con_assessment-module-features.adoc
  • docs/topics/mta-ui/con_mta-default-questionnaire.adoc
  • docs/topics/mta-ui/proc_adding-applications.adoc
  • docs/topics/mta-ui/proc_adding-source-platform-application.adoc
  • docs/topics/mta-ui/proc_assessing-an-application.adoc
  • docs/topics/mta-ui/proc_assessing-an-archetype.adoc
  • docs/topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc
  • docs/topics/mta-ui/proc_configuring-asset-repository.adoc
  • docs/topics/mta-ui/proc_configuring-git-repos.adoc
  • docs/topics/mta-ui/proc_configuring-jira-credentials.adoc
  • docs/topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adoc
  • docs/topics/mta-ui/proc_configuring-subversion-repos.adoc
  • docs/topics/mta-ui/proc_configuring-target-profiles.adoc
  • docs/topics/mta-ui/proc_creating-a-jira-connection.adoc
  • docs/topics/mta-ui/proc_creating-a-tag.adoc
  • docs/topics/mta-ui/proc_creating-application-tags.adoc
  • docs/topics/mta-ui/proc_creating-jira-issues-for-migration-wave.adoc
  • docs/topics/mta-ui/proc_creating-migration-waves.adoc
  • docs/topics/mta-ui/proc_creating-source-platform.adoc
  • docs/topics/mta-ui/proc_defining-an-archetype.adoc
  • docs/topics/mta-ui/proc_displaying-automated-tasks.adoc
  • docs/topics/mta-ui/proc_downloading-an-analysis-report.adoc
  • docs/topics/mta-ui/proc_generating-discovery-manifest-web.adoc
  • docs/topics/mta-ui/proc_importing-an-app-list.adoc
  • docs/topics/mta-ui/proc_reviewing-a-task-log.adoc
  • docs/topics/mta-ui/proc_reviewing-an-analysis-report.adoc
  • docs/topics/mta-ui/proc_reviewing-an-archetype.adoc
  • docs/topics/mta-ui/proc_reviewing-assessment-report.adoc
  • docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc
  • docs/topics/mta-ui/ref_custom-questionnaire-fields.adoc
💤 Files with no reviewable changes (2)
  • docs/topics/mta-ui/proc_configuring-git-repos.adoc
  • docs/topics/mta-ui/proc_configuring-subversion-repos.adoc

Comment thread assemblies/ui-guide/assembly_asset-generation-ui.adoc Outdated
Comment thread docs/topics/mta-ui/con_assessment-module-features.adoc Outdated
Comment thread docs/topics/mta-ui/proc_assessing-an-archetype.adoc Outdated
Comment thread docs/topics/mta-ui/proc_creating-a-jira-connection.adoc Outdated
Comment thread docs/topics/mta-ui/proc_creating-a-jira-connection.adoc Outdated
Comment thread docs/topics/mta-ui/proc_reviewing-an-archetype.adoc Outdated
Comment thread docs/topics/mta-ui/proc_reviewing-assessment-report.adoc
Comment thread docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc Outdated
Comment thread docs/topics/mta-ui/ref_custom-questionnaire-fields.adoc Outdated
Comment thread docs/topics/mta-ui/ref_custom-questionnaire-fields.adoc Outdated
Comment thread assemblies/ui-guide/assembly_asset-generation-ui.adoc Outdated
Comment thread assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc Outdated
Comment thread assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc Outdated
Comment thread assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc Outdated
Comment thread docs/topics/mta-ui/con_assessment-module-features.adoc Outdated
Comment thread docs/topics/mta-ui/proc_adding-applications.adoc Outdated
Comment thread docs/topics/mta-ui/proc_adding-applications.adoc Outdated
Comment thread docs/topics/mta-ui/proc_adding-applications.adoc Outdated
Comment thread docs/topics/mta-ui/proc_adding-applications.adoc Outdated
Comment thread docs/topics/mta-ui/proc_adding-applications.adoc Outdated
Comment thread docs/topics/mta-ui/proc_adding-source-platform-application.adoc Outdated
Comment thread docs/topics/mta-ui/proc_assessing-an-application.adoc Outdated
Comment thread docs/topics/mta-ui/proc_assessing-an-archetype.adoc Outdated
Comment thread docs/topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc Outdated
Comment thread docs/topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc Outdated
Comment thread docs/topics/mta-ui/proc_creating-jira-issues-for-migration-wave.adoc Outdated
Comment thread docs/topics/mta-ui/proc_creating-a-jira-connection.adoc Outdated
Comment thread docs/topics/mta-ui/proc_creating-source-platform.adoc Outdated
Comment thread docs/topics/mta-ui/proc_defining-an-archetype.adoc Outdated
Comment thread docs/topics/mta-ui/proc_downloading-an-analysis-report.adoc Outdated
Comment thread docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc Outdated
Reverting active voice back to passive where it makes more sense + other minor wording/markup fixes
Copy link
Copy Markdown
Contributor

@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

🧹 Nitpick comments (1)
assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc (1)

58-58: Minor readability tweak: “tags that exist on”.

Consider replacing “tags existing on” with “tags that exist on” for smoother prose.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc` at line 58,
Replace the awkward phrase "tags existing on" in the sentence starting "The
{ProductShortName} selects automated answers..." with the smoother wording "tags
that exist on"; specifically update the occurrence of the fragment `tags
existing on` to `tags that exist on` so the sentence reads naturally while
keeping the surrounding examples (e.g., `Runtime/Quarkus`, `Runtime/Spring
Boot`) unchanged.
🤖 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_creating-jira-issues-for-migration-wave.adoc`:
- Line 14: The introduction contains a duplicated sentence ("You can use a
migration wave to automatically create a separate Jira issue for each assigned
application.") — remove the redundant occurrence so only one instance remains
before the field list; locate that exact sentence in
docs/topics/mta-ui/proc_creating-jira-issues-for-migration-wave.adoc and delete
the duplicate (keep the one that reads naturally with the surrounding lines and
preserve the following line "The {ProductShortName} automatically populates the
following fields for each issue:").

---

Nitpick comments:
In `@assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc`:
- Line 58: Replace the awkward phrase "tags existing on" in the sentence
starting "The {ProductShortName} selects automated answers..." with the smoother
wording "tags that exist on"; specifically update the occurrence of the fragment
`tags existing on` to `tags that exist on` so the sentence reads naturally while
keeping the surrounding examples (e.g., `Runtime/Quarkus`, `Runtime/Spring
Boot`) unchanged.
🪄 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: 09a001fc-c3ff-4348-8132-d30785003193

📥 Commits

Reviewing files that changed from the base of the PR and between 1ee0d59 and 59d859d.

📒 Files selected for processing (16)
  • assemblies/ui-guide/assembly_asset-generation-ui.adoc
  • assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc
  • docs/topics/mta-ui/con_assessment-module-features.adoc
  • docs/topics/mta-ui/proc_adding-applications.adoc
  • docs/topics/mta-ui/proc_adding-source-platform-application.adoc
  • docs/topics/mta-ui/proc_assessing-an-application.adoc
  • docs/topics/mta-ui/proc_assessing-an-archetype.adoc
  • docs/topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc
  • docs/topics/mta-ui/proc_creating-a-jira-connection.adoc
  • docs/topics/mta-ui/proc_creating-jira-issues-for-migration-wave.adoc
  • docs/topics/mta-ui/proc_creating-source-platform.adoc
  • docs/topics/mta-ui/proc_defining-an-archetype.adoc
  • docs/topics/mta-ui/proc_downloading-an-analysis-report.adoc
  • docs/topics/mta-ui/proc_reviewing-an-analysis-report.adoc
  • docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc
  • docs/topics/mta-ui/ref_custom-questionnaire-fields.adoc
✅ Files skipped from review due to trivial changes (8)
  • docs/topics/mta-ui/proc_assessing-an-application.adoc
  • docs/topics/mta-ui/proc_downloading-an-analysis-report.adoc
  • docs/topics/mta-ui/proc_reviewing-an-analysis-report.adoc
  • docs/topics/mta-ui/proc_assessing-an-archetype.adoc
  • docs/topics/mta-ui/proc_creating-source-platform.adoc
  • docs/topics/mta-ui/proc_adding-applications.adoc
  • assemblies/ui-guide/assembly_asset-generation-ui.adoc
  • docs/topics/mta-ui/ref_custom-questionnaire-fields.adoc
🚧 Files skipped from review as they are similar to previous changes (5)
  • docs/topics/mta-ui/proc_defining-an-archetype.adoc
  • docs/topics/mta-ui/proc_adding-source-platform-application.adoc
  • docs/topics/mta-ui/con_assessment-module-features.adoc
  • docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc
  • docs/topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc

Comment thread assemblies/ui-guide/assembly_working-with-archetypes.adoc Outdated
Comment thread assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc Outdated
Comment thread docs/topics/mta-ui/proc_creating-jira-issues-for-migration-wave.adoc Outdated
@mpershina mpershina changed the title [April CQA] CQA fixes for the UI title (terminology,. UI formatting, style cleanup) [April CQA] CQA fixes for the UI title (terminology, UI formatting, style cleanup) Apr 23, 2026
Copy link
Copy Markdown
Contributor

@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

♻️ Duplicate comments (2)
docs/topics/mta-ui/proc_reviewing-an-archetype.adoc (1)

29-29: ⚠️ Potential issue | 🟡 Minor

Add the missing linking verb in the “Proposed Action” definition.

Line 29 is still ungrammatical; it needs “that is required.”

✏️ Suggested edit
-** *Proposed Action*: A proposed action required to complete the migration or modernization of the archetype.
+** *Proposed Action*: A proposed action that is required to complete the migration or modernization of the archetype.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/topics/mta-ui/proc_reviewing-an-archetype.adoc` at line 29, Update the
definition for the "** *Proposed Action*" entry by inserting the missing linking
verb so the sentence reads naturally; change "A proposed action required to
complete the migration or modernization of the archetype." to "A proposed action
that is required to complete the migration or modernization of the archetype."
This edit should be applied to the line containing the "** *Proposed Action*"
definition.
docs/topics/mta-ui/proc_creating-a-jira-connection.adoc (1)

25-28: ⚠️ Potential issue | 🟡 Minor

Standardize "Data Center" capitalization for consistency.

Lines 25 and 28 use "Jira Server/Data center" (lowercase 'c') but should use "Jira Server/Data Center" (capital 'C') to maintain consistent terminology throughout the documentation.

✏️ Suggested edits
-* Select either the *Jira Cloud* or *Jira Server/Data center* instance type.
+* Select either the *Jira Cloud* or *Jira Server/Data Center* instance type.
 * Select credentials from the list:
 ** If you selected *Jira Cloud* as the instance type, the list displays only *Basic Auth* credentials.
-** If you selected *Jira Server/Data center* as an instance type, the list displays both *Basic Auth* and *Token Bearer* credentials.
+** If you selected *Jira Server/Data Center* as an instance type, the list displays both *Basic Auth* and *Token Bearer* credentials.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/topics/mta-ui/proc_creating-a-jira-connection.adoc` around lines 25 -
28, Update the phrasing "Jira Server/Data center" to "Jira Server/Data Center"
for consistent capitalization in the two bullets that reference the instance
type (the line that reads "Select either the *Jira Cloud* or *Jira Server/Data
center* instance type." and the line that begins "** If you selected *Jira
Server/Data center* as an instance type, the list displays both *Basic Auth* and
*Token Bearer* credentials.**"); search and replace any other occurrences of
"Jira Server/Data center" in the document to the standardized "Jira Server/Data
Center".
🧹 Nitpick comments (1)
docs/topics/mta-ui/proc_creating-a-jira-connection.adoc (1)

34-34: Consider simplifying "established and authorized" to match verification bullets.

The phrase "ensure that you established and authorized the connection" introduces both concepts, but the verification bullets below only check the connection status (Connected vs Not connected). For consistency, consider simplifying to "ensure that you established the connection" or keep as-is if the Connected status implicitly confirms authorization.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/topics/mta-ui/proc_creating-a-jira-connection.adoc` at line 34, Replace
the phrase "established and authorized the connection" with a simpler,
consistent wording that matches the verification bullets—e.g., change "ensure
that you established and authorized the connection" to "ensure that you
established the connection" (or "ensure the connection is established") so the
line aligns with the subsequent *Connected* vs *Not connected* checks; update
the text surrounding the existing sentence containing "established and
authorized" accordingly.
🤖 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_creating-a-jira-connection.adoc`:
- Line 12: Update the Jira connection restriction text in
proc_creating-a-jira-connection.adoc to explicitly tell users how to satisfy it:
state that before removing a Jira connection they must remove or resolve the
corresponding Jira issues in Jira itself (for example by deleting them or
transitioning/closing them per their Jira workflow), and add a short
cross-reference to proc_creating-jira-issues-for-migration-wave.adoc explaining
unlinking vs. deleting so readers know unlinking an application is not
sufficient; mention any recommended steps (manual delete or close) and where to
find more info.

---

Duplicate comments:
In `@docs/topics/mta-ui/proc_creating-a-jira-connection.adoc`:
- Around line 25-28: Update the phrasing "Jira Server/Data center" to "Jira
Server/Data Center" for consistent capitalization in the two bullets that
reference the instance type (the line that reads "Select either the *Jira Cloud*
or *Jira Server/Data center* instance type." and the line that begins "** If you
selected *Jira Server/Data center* as an instance type, the list displays both
*Basic Auth* and *Token Bearer* credentials.**"); search and replace any other
occurrences of "Jira Server/Data center" in the document to the standardized
"Jira Server/Data Center".

In `@docs/topics/mta-ui/proc_reviewing-an-archetype.adoc`:
- Line 29: Update the definition for the "** *Proposed Action*" entry by
inserting the missing linking verb so the sentence reads naturally; change "A
proposed action required to complete the migration or modernization of the
archetype." to "A proposed action that is required to complete the migration or
modernization of the archetype." This edit should be applied to the line
containing the "** *Proposed Action*" definition.

---

Nitpick comments:
In `@docs/topics/mta-ui/proc_creating-a-jira-connection.adoc`:
- Line 34: Replace the phrase "established and authorized the connection" with a
simpler, consistent wording that matches the verification bullets—e.g., change
"ensure that you established and authorized the connection" to "ensure that you
established the connection" (or "ensure the connection is established") so the
line aligns with the subsequent *Connected* vs *Not connected* checks; update
the text surrounding the existing sentence containing "established and
authorized" 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: 127b3962-fa58-4473-a190-050d8992e63c

📥 Commits

Reviewing files that changed from the base of the PR and between 59d859d and 572163a.

📒 Files selected for processing (16)
  • assemblies/ui-guide/assembly_asset-generation-ui.adoc
  • assemblies/ui-guide/assembly_configuring-mta-instance.adoc
  • assemblies/ui-guide/assembly_configuring-repositories.adoc
  • assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc
  • assemblies/ui-guide/assembly_working-with-archetypes.adoc
  • docs/topics/mta-ui/proc_adding-applications.adoc
  • docs/topics/mta-ui/proc_configuring-git-repos.adoc
  • docs/topics/mta-ui/proc_configuring-maven-repo.adoc
  • docs/topics/mta-ui/proc_configuring-subversion-repos.adoc
  • docs/topics/mta-ui/proc_creating-a-business-service.adoc
  • docs/topics/mta-ui/proc_creating-a-jira-connection.adoc
  • docs/topics/mta-ui/proc_creating-a-stakeholder.adoc
  • docs/topics/mta-ui/proc_creating-a-tag.adoc
  • docs/topics/mta-ui/proc_creating-jira-issues-for-migration-wave.adoc
  • docs/topics/mta-ui/proc_reviewing-an-archetype.adoc
  • docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc
✅ Files skipped from review due to trivial changes (11)
  • docs/topics/mta-ui/proc_creating-a-business-service.adoc
  • docs/topics/mta-ui/proc_configuring-git-repos.adoc
  • assemblies/ui-guide/assembly_configuring-repositories.adoc
  • assemblies/ui-guide/assembly_configuring-mta-instance.adoc
  • docs/topics/mta-ui/proc_configuring-maven-repo.adoc
  • docs/topics/mta-ui/proc_configuring-subversion-repos.adoc
  • assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc
  • docs/topics/mta-ui/proc_creating-a-tag.adoc
  • docs/topics/mta-ui/proc_adding-applications.adoc
  • docs/topics/mta-ui/proc_creating-a-stakeholder.adoc
  • assemblies/ui-guide/assembly_working-with-archetypes.adoc
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/topics/mta-ui/proc_creating-jira-issues-for-migration-wave.adoc
  • docs/topics/mta-ui/proc_running-an-analysis-using-profile.adoc

Comment thread docs/topics/mta-ui/proc_creating-a-jira-connection.adoc
Copy link
Copy Markdown
Collaborator

@anarnold97 anarnold97 left a comment

Choose a reason for hiding this comment

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

LGTM

@anarnold97
Copy link
Copy Markdown
Collaborator

@mpershina - no substantive content changes, so i think you can merge. thanks

@mpershina mpershina merged commit 5f14c0d into main Apr 23, 2026
1 of 2 checks passed
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.

2 participants