Skip to content

Commit

Permalink
Merge pull request #819 from sbeskin-redhat/MTA_2071_Assessment_report
Browse files Browse the repository at this point in the history
MTA-2071: Document the Assessment Report tab
  • Loading branch information
sbeskin-redhat authored Feb 14, 2024
2 parents 4f83208 + af8dffe commit 8e246ee
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 9 deletions.
Binary file added docs/topics/images/mta-assessment-report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 7 additions & 6 deletions docs/topics/mta-web-reviewing-an-analysis-report.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@
[id="mta-web-reviewing-an-analysis-report_{context}"]
= Reviewing an analysis report

An {ProductShortName} analysis report contains a variety of sections, including a listing of the technologies used by the application, the dependencies of the application, and the lines of code that must be changed to successfully migrate or modernize the application.
An {ProductShortName} analysis report contains a number of sections, including a listing of the technologies used by the application, the dependencies of the application, and the lines of code that must be changed to successfully migrate or modernize the application.

For more information on the contents of an {ProductShortName} analysis report, see the link:{ProductDocUserGuideURL}#review-reports_cli-guide[Reviewing the reports].
For more information on the contents of an {ProductShortName} analysis report, see link:{ProductDocUserGuideURL}#review-reports_cli-guide[Reviewing the reports]

.Procedure

. In *Migration* view, click *Reports*.
. In the *Current landscape* pane, select *All questionnaires* or a single questionnaire from the drop-down list to see an overview of the risk distribution (High, Medium, Low, Unassessed/Unknown).
. In the *Identified risks* pane, filter the report results by selecting a component from the drop-down list (Questionnaire, Section, Question, Answer, Risk), and select an item from the resulting filter drop down list.
. You can also sort the results by clicking a column heading (Questionnaire, Section, Question, Answer, Risk).
1. In *Migration* view, click *Application inventory*.
2. Expand the application with a completed analysis.
3. Click *Reports*.
4. Click the dependencies or source links.
5. Click the tabs to review the report.
30 changes: 30 additions & 0 deletions docs/topics/mta-web-viewing-an-assessment-report.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// Module included in the following assemblies:
//
// * docs/web-console-guide/master.adoc

:_content-type: PROCEDURE
[id="mta-web-viewing-an-assessment-report_{context}"]
= Viewing an assessment report

An {ProductShortName} assessment report displays an aggregated assessement of the data obtained from multiple questionnaires for multiple applications.

.Procedure

. To view an assessment report, in *Migration* view, in the menu on the left, click *Reports*.
+
The aggregated assessment report for all aplications is displayed.
+
image::mta-assessment-report.png[Assessment report]
+
* To display a report on the data from a particular questionnaire, select the required questionnaire from a drop-down list of all questionnaires in the *Current landscape* pane of the report. By default, all questionnaires are selected.
* In the *Identified risks* pane of the report, you can sort the displayed list by application name, level of risk, questionnaire, questionnaire section, question, and answer.
* To display a report for a specific application:
.. Click the link in the *Applications* column in the *Identified risks* pane of the report.
+
The *Application inventory* page opens. The applications included in the link are displayed as a list .
.. Click the required application.
+
The *Assessment* side drawer opens.
+
** To see the assessed risk level for the application, open the *Details* tab.
** To see the details of the assessment, open the *Reviews* tab.
5 changes: 2 additions & 3 deletions docs/web-console-guide/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -143,14 +143,13 @@ include::topics/mta-delete-questionnaire.adoc[leveloffset=+4]
include::topics/mta-web-assessment-module.adoc[leveloffset=+3]

include::topics/mta-web-run-assessment.adoc[leveloffset=+4]
include::topics/mta-web-viewing-an-assessment-report.adoc[leveloffset=+4]

// include::topics/mta-web-skipping-assessment-of-apps.adoc[leveloffset=+3]


include::topics/mta-web-tagging-an-application.adoc[leveloffset=+2]

include::topics/mta-web-reviewing-an-analysis-report.adoc[leveloffset=+2]

include::topics/mta-web-reviewing-apps.adoc[leveloffset=+2]

include::topics/mta-web-review-tab.adoc[leveloffset=+2]
Expand All @@ -160,7 +159,7 @@ include::topics/mta-web-archetypes.adoc[leveloffset=+2]


include::topics/mta-web-configuring-and-running-an-application-analysis.adoc[leveloffset=+2]

include::topics/mta-web-reviewing-an-analysis-report.adoc[leveloffset=+3]
include::topics/mta-web-downloading-an-analysis-report.adoc[leveloffset=+3]

include::topics/mta-web-creating-custom-migration-targets.adoc[leveloffset=+2]
Expand Down

0 comments on commit 8e246ee

Please sign in to comment.