Merge pull request migtools#13 from migtools/MTA-3110_task-manager-UI

raoradhika · web-flow · commit 12e1190c4055 · 2024-08-14T17:56:32.000+05:30
[WIP] Adding the Task Manager info to the UI doc
diff --git a/docs/topics/mta-web-configuring-and-running-an-application-analysis.adoc b/docs/topics/mta-web-configuring-and-running-an-application-analysis.adoc
@@ -92,7 +92,9 @@ Analysis takes minutes to hours to run depending on the size of the application
 ====
 {ProductShortName} relies on Kubernetes scheduling capabilities to determine how many analyzer instances are created based on cluster capacity. If several applications are selected for analysis, by default, only one analyzer can be provisioned at a time. With more cluster capacity, more analysis processes can be executed in parallel.
 ====
-. When analysis is complete, click the *Report* link to see the results of the analysis.
-. Optional: Display the details of the analysis:
-.. Click the Options menu ({kebab}).
-.. Select *Analysis details*. You can choose either the YAML or JSON format.
+
+. Optional: To track the status of your active analysis task, open the *Task Manager* drawer by clicking the notifications button.
++
+Alternatively, hover over the application name to display the pop-over window.
+. When analysis is complete, to see its results, open the application drawer by clicking on the application name.
+
diff --git a/docs/topics/mta-web-controlling-task-order-with-task-manager.adoc b/docs/topics/mta-web-controlling-task-order-with-task-manager.adoc
@@ -0,0 +1,22 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2024-08-07
+:_mod-docs-content-type: PROCEDURE
+
+[id="mta-web-controlling-task-order-with-task-manager_{context}"]
+= Controlling the order of task execution
+
+You can use *Task Manager* to preempt a {ProductFullName} task you have scheduled for execution. 
+
+[NOTE]
+====
+You can enable *Preemption* on any scheduled task (not in the status of *Running*, *Succeeded*, or *Failed*). However, only lower-priority tasks are candidates to be preempted. When a higher-priority task is blocked by lower-priority tasks and has *Preemption* enabled, the low-priority tasks might be rescheduled so that the blocked higher-priority task might run. Therefore, it is only useful to enable *Preemption* on higher-priority tasks, for example, application analysis.
+====
+
+.Procedure
+
+. In the *Migration* view, click *Task Manager*.
+. Click the *Options* menu ({kebab}) for the selected task.
+. Depending on your scenario, complete one of the following steps:
+
+** To enable *Preemption* for the task, select *Enable preemption*. 
+** To disable *Preemption* for the task with enabled *Preemption*, select *Disable preemption*.
diff --git a/docs/topics/mta-web-controlling-tasks-with-task-manager.adoc b/docs/topics/mta-web-controlling-tasks-with-task-manager.adoc
@@ -0,0 +1,17 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2024-08-07
+:_mod-docs-content-type: PROCEDURE
+
+[id="mta-web-controlling-tasks-with-task-manager_{context}"]
+= Controlling {ProductShortName} tasks by using Task Manager
+
+*Task Manager* provides precise information about the {ProductFullName} tasks queued for execution. *Task Manager* handles the following types of tasks:
+
+* Application analysis
+* Language discovery
+* Technology discovery
+
+You can display task-related information either of the following ways:
+
+* To display active tasks, open the *Task Manager* drawer by clicking the notifications button.
+* To display all tasks, open the *Task Manager* page in the *Migration* view.
diff --git a/docs/topics/mta-web-downloading-an-analysis-report.adoc b/docs/topics/mta-web-downloading-an-analysis-report.adoc
@@ -6,15 +6,19 @@
 [id="mta-web-downloading-an-analysis-report_{context}"]
 = Downloading an analysis report
 
+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 about the contents of an {ProductShortName} analysis report, see link:{ProductDocUserGuideURL}#review-reports_cli-guide[Reviewing the reports].
+
 For your convenience, you can download analysis reports. Note that by default this option is disabled.
 
 .Procedure
 
 . In *Administration* view, click *General*.
 . Toggle the *Allow reports to be downloaded after running an analysis.*  switch.
 . Go to the *Migration* view and click *Application inventory*.
-. Open the page of the application for which you ran an analysis.
-. Click *Reports*.
+. Click on the application row to open the application drawer. 
+. Click the *Reports* tab.
 . Click either the *HTML* or *YAML* link:
 * By clicking the *HTML* link, you download the compressed `analysis-report-app-<application_name>.tar` file. Extracting this file creates a folder with the same name as the application.
 * By clicking the *YAML* link, you download the uncompressed `analysis-report-app-<application_name>.yaml` file.
diff --git a/docs/topics/mta-web-reviewing-a-task-log.adoc b/docs/topics/mta-web-reviewing-a-task-log.adoc
@@ -0,0 +1,16 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2024-08-01
+:_mod-docs-content-type: PROCEDURE
+
+[id="mta-web-reviewing-a-task-log_{context}"]
+= Reviewing a task log
+
+To find details and logs of a particular {ProductFullName} task, you can use the *Task Manager* page. 
+
+.Procedure
+
+. In the *Migration* view, click *Task Manager*.
+. Click the *Options* menu ({kebab}) for the selected task.
+. Click *Task details*.
++
+Alternatively, click on the task status in the *Status* column.
diff --git a/docs/topics/mta-web-reviewing-an-analysis-report.adoc b/docs/topics/mta-web-reviewing-an-analysis-report.adoc
@@ -4,16 +4,16 @@
 
 :_content-type: PROCEDURE
 [id="mta-web-reviewing-an-analysis-report_{context}"]
-= Reviewing an analysis report
+= Reviewing analysis details
 
-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 about the contents of an {ProductShortName} analysis report, see link:{ProductDocUserGuideURL}#review-reports_cli-guide[Reviewing the reports].
+You can display the activity log of the analysis. The activity log contains such analysis details as, for example, analysis steps.
 
 .Procedure
 
 . In the *Migration* view, click *Application inventory*.
-. Expand the application with a completed analysis.
-. Click *Reports*.
-. Click the dependencies or source links.
-. Click the tabs to review the report.
+. Click on the application row to open the application drawer. 
+. Click the *Reports* tab.
+. Click *View analysis details* for the activity log of the analysis.
+. Optional: For issues and dependencies found during the analysis, click the *Details* tab in the application drawer and click *Issues* or *Dependencies*.
++
+Alternatively, open the *Issues* or *Dependencies* page in the *Migration* view.
diff --git a/docs/web-console-guide/master.adoc b/docs/web-console-guide/master.adoc
@@ -213,9 +213,13 @@ include::topics/proc_deleting-an-archetype.adoc[leveloffset=+3]
 
 include::topics/proc_analyzing-an-application.adoc[leveloffset=+2]
 include::topics/mta-web-configuring-and-running-an-application-analysis.adoc[leveloffset=+3]
+
 //include::topics/proc_displaying-the-analysis-details.adoc[leveloffset=+3]
 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-controlling-tasks-with-task-manager.adoc[leveloffset=+2]
+include::topics/mta-web-reviewing-a-task-log.adoc[leveloffset=+3]
+include::topics/mta-web-controlling-task-order-with-task-manager.adoc[leveloffset=+3]
 
 // include::topics/mta-web-creating-custom-migration-targets.adoc[leveloffset=+2]
 
