Merge pull request migtools#19 from vsodhi/MTA-3102-app-insights

MTA-3102-app insights section added

Author: raoradhika

docs/topics/images/mta-cli-guide-app-insights.png

@@ -77,6 +77,9 @@ The top navigation bar lists the various reports that contain additional details
 | Issues
 | Provides a concise summary of all issues that require attention.
 
+| Insights
+| Provides information about the technologies used in the application and their usage in the code. However, these Insights do not impact the migration.
+
 | Application details
 | Provides a detailed overview of all resources found within the application that may need attention during the migration.
 
@@ -152,6 +155,62 @@ image::3-5-expanded-issue.png[Expanded rule in the issues report]
 
 Issues are sorted into four categories by default. Information on these categories is available at ask Category.
 
+
+=== Insights
+
+:FeatureName: Insights
+include::snippets/technology-preview-admonition.adoc[]
+
+Previously, a violation generated by a rule with zero effort was listed as an issue in the static report. This is now listed as an insight instead. Issues are generated by general rules, whereas string tags are generated by tagging rules. String tags indicate the presence of a technology but do not show the code location. With the introduction of Insights, you can see the technology used in the application along with its usage in the code.
+
+For example, a rule searching for deprecated API usage in the code that does not impact the current migration but can be tracked and fixed when needed in the future.
+
+Unlike issues, insights do not need to be fixed for a successful migration. They are generated by any rule that doesn't have a positive effort value and category assigned. They might have a message and tag.
+
+[NOTE]
+=====
+Insights are generated automatically if applicable or present. Currently, {ProductShortName} supports generating Insights when application anaylsis is done using CLI.
+=====
+
+You can view Insights under the *Insights* tab in the static report.
+
+image::mta-cli-guide-app-insights.png[Insights tab in the Static report]
+
+.Example: Insights generated by a tagging rule with undefined effort
+
+[source,terminal]
+----
+- customVariables: []
+  description: Embedded library - Apache Wicket
+  labels:
+  - konveyor.io/include=always
+  links: []
+  ruleID: mvc-01000
+  tag:
+  - Apache Wicket
+  - Embedded library - Apache Wicket
+  when:
+    builtin.file:
+      pattern: .*wicket.*\.jar
+----
+
+.Example: Insights generated by a non-tagging rule with zero effort
+
+[source,terminal]
+----
+- category: potential
+  customVariables: []
+  description: RESTful Web Services @Context annotation has been deprecated
+  effort: 0
+  message: Future versions of this API will no longer support `@Context` and related
+    types such as `ContextResolver`.
+  ruleID: jakarta-ws-rs-00001
+  when:
+    java.referenced:
+      location: ANNOTATION
+      pattern: jakarta.ws.rs.core.Context
+----
+
 === Application details report
 
 Access this report from the dashboard by clicking the *Application Details* link.

docs/topics/mta-review-reports.adoc

@@ -0,0 +1 @@
+../../snippets