Merge pull request migtools#21 from migtools/MTA-2688

[WIP] Document the ability to run providers selectively during analysis

Author: raoradhika

docs/cli-guide/master.adoc

@@ -80,6 +80,15 @@ include::topics/available-openrewrite-recipes.adoc[leveloffset=+4]
 // Access the Report
 include::topics/access-report.adoc[leveloffset=+2]
 
+// Multi-language application analysis
+include::topics/mta-cli-analyze-multi-lang-apps.adoc[leveloffset=+2]
+
+// Multi-language application analysis for the supported provider
+include::topics/mta-cli-analyze-selected-provider.adoc[leveloffset=+3]
+
+// Multi-language application analysis for the unsupported provider
+include::topics/mta-cli-analyze-unsupported-provider.adoc[leveloffset=+3]
+
 // Review the Reports
 include::topics/mta-review-reports.adoc[leveloffset=+1]
 

docs/topics/mta-cli-analyze-multi-lang-apps.adoc

@@ -0,0 +1,11 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2024-07-30
+:_mod-docs-content-type: PROCEDURE
+
+[id="mta-cli-analyze-multi-lang-apps_{context}"]
+= Analyzing multi-language applications with {CLIName}
+
+You can run the application analysis on applications written in multiple languages. You can perform the analysis either of the following ways:
+
+* Select the supported language provider to run the analysis for.
+* Override the existing supported language provider with your own unsupported language provider and run the analysis for this unsupported provider.

docs/topics/mta-cli-analyze-selected-provider.adoc

@@ -0,0 +1,32 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2024-07-25
+:_mod-docs-content-type: PROCEDURE
+
+[id="selecting-language-providers-for-analysis_{context}"]
+= Analyzing a multi-language application for the selected supported language provider
+
+When analyzing a multi-language application with {ProductFullName} {CLINameTitle}, you can explicitly set a supported language provider according to your application language to run the analysis for.
+
+
+.Prerequisites
+
+* You are running the latest version of {ProductShortName} {CLINameTitle}.
+
+
+.Procedure
+
+. List language providers supported for the analysis:
++
+[source,terminal,subs="attributes+"]
+----
+$ mta-cli analyze --list-providers
+----
+
+. Run the application analysis for the selected language provider:
++
+[source,terminal,subs="attributes+"]
+----
+$ mta-cli analyze --input <_path_to_the_source_repository_> --output <_path_to_the_output_directory_> --provider <_language_provider_> --rules <_path_to_custom_rules_>
+----
++
+Note that if you do not set the `--provider` option, the analysis might fail because it detects unsupported providers. The analysis will complete without `--provider` only if all discovered providers are supported.

docs/topics/mta-cli-analyze-unsupported-provider.adoc

@@ -0,0 +1,24 @@
+:_newdoc-version: 2.18.3
+:_template-generated: 2024-07-30
+:_mod-docs-content-type: PROCEDURE
+
+[id="mta-cli-analyze-unsupported-provider_{context}"]
+= Analyzing a multi-language application for an unsupported language provider
+
+When analyzing a multi-language application with {ProductFullName} {CLINameTitle}, you can run the analysis for an unsupported language provider. To do so, you must override an existing supported language provider with your own unsupported language provider by using the `--override-provider-settings` option. 
+
+IMPORTANT: You must create a configuration file for your unsupported language provider before overriding the supported provider.
+
+
+.Prerequisites
+
+* You created a configuration file for your unsupported language provider.
+
+.Procedure
+
+* Override an existing supported language provider with your unsupported provider:
++
+[source,terminal,subs="attributes+"]
+----
+$ mta-cli analyze --provider-override <path_to_configuration_file> --output=<path_to_the_output_directory> --rules <path_to_custom_rules>
+----