MTA-2744 - Rework MTA CLI section

.gitignore

@@ -4,4 +4,9 @@ html/
 */build/*
 Gemfile.lock
 */master.html
-.idea/
+.idea/
+.gitignore
+.DS_Store
+assets/.DS_Store
+docs/.DS_Store
+docs/topics/.DS_Store

docs/cli-guide/master.adoc

@@ -16,29 +16,26 @@ include::topics/making-open-source-more-inclusive.adoc[]
 
 == Introduction
 
-// About the {UserCLIBookName}
-include::topics/about-cli-guide.adoc[leveloffset=+2]
-
 // About {ProductName}
 include::topics/mta-what-is-the-toolkit.adoc[leveloffset=+2]
 
+// About the {CLINameTitle}
+include::topics/about-cli.adoc[leveloffset=+2]
+
+// About the {UserCLIBookName}
+include::topics/about-cli-guide.adoc[leveloffset=+2]
+
+// Supported migration paths
 include::topics/migration-paths.adoc[leveloffset=+3]
 
 For more information about use cases and migration paths, see the link:https://developers.redhat.com/products/mta/use-cases[{ProductShortName} for developers] web page.
 
-// About the {CLINameTitle}
-include::topics/about-cli.adoc[leveloffset=+2]
-
-== Installing and Running the CLI
 
 // Install the CLI
-include::topics/installing-cli-tool.adoc[leveloffset=+2]
-
-// CLI known issues
-include::topics/cli-tool-known-issues.adoc[leveloffset=+3]
+include::topics/installing-cli-tool.adoc[leveloffset=+1]
 
 // Run the CLI
-include::topics/mta-cli-run.adoc[leveloffset=+2]
+include::topics/mta-cli-run.adoc[leveloffset=+1]
 
 // Analyze application source code
 include::topics/mta-cli-analyze.adoc[leveloffset=+3]
@@ -52,11 +49,11 @@ include::topics/mta-cli-transform.adoc[leveloffset=+3]
 // Available OpenRewrite recipes
 include::topics/available-openrewrite-recipes.adoc[leveloffset=+4]
 
-// Access the Report
-include::topics/access-report.adoc[leveloffset=+2]
+// Reports
+include::topics/access-report.adoc[leveloffset=+1]
 
 // Review the Reports
-include::topics/mta-review-reports.adoc[leveloffset=+1]
+include::topics/mta-review-reports.adoc[leveloffset=+2]
 
 // Export the Report in CSV Format
 // include::topics/csv-export.adoc[leveloffset=+1]

docs/topics/about-cli-guide.adoc

@@ -6,4 +6,4 @@
 [id="about-cli-guide_{context}"]
 = About the {UserCLIBookName}
 
-This guide is for engineers, consultants, and others who want to use the {ProductName} ({ProductShortName}) to migrate Java applications or other components. It describes how to install and run the {CLIName}, review the generated reports, and take advantage of additional features.
+This guide is for programmers, engineers, consultants, and others who want to use the {ProductName} ({ProductShortName}) to migrate Java and Go applications, or other software components. It describes how to install and run the {CLIName}, review the generated reports, and take advantage of additional features.

docs/topics/about-cli.adoc

@@ -7,7 +7,7 @@
 [id="about-cli_{context}"]
 = The {ProductShortName} {CLINameTitle}
 
-The {CLIName} is a command-line tool in the {ProductName} that you can use to assess and prioritize migration and modernization efforts for applications. It provides numerous reports that highlight the analysis without using the other tools. The {CLIName} includes a wide array of customization options. By using the {CLIName}, you can tune {ProductShortName} analysis options or integrate with external automation tools.
+The {ProductName} {CLIName} is a command-line tool that you can use for assessing and managing your migration and modernization efforts for applications. It produces many reports that highlight the analysis without having to use the other tools. The {CLIName} includes a wide array of customization options, enabling you to tune the {ProductShortName} analysis options or integrate with external automation tools.
 
 ifndef::cli-guide[]
 For more information about using the {CLIName}, see link:{ProductDocUserGuideURL}[_{UserCLIBookName}_].

docs/topics/access-report.adoc

@@ -4,11 +4,11 @@
 
 :_content-type: PROCEDURE
 [id="access-report_{context}"]
-= Accessing reports
+= Reports
 
-When you run the {ProductName}, a report is generated in the `<OUTPUT_REPORT_DIRECTORY>` that you specify using the `--output` argument in the command line.
+{ProductShortName} {CLIName} analyzes the application and generates a report of the analysis results. The report is saved to the `<OUTPUT_REPORT_DIRECTORY>` that you specified in the `./ analyze` command, after the `--output` argument.
 
-The output directory contains the following files and subdirectories:
+Navigate to the directory and open the `<APPLICATION_NAME>-output` directory, which contains the following files and subdirectories:
 
 ----
 <OUTPUT_REPORT_DIRECTORY>/
@@ -22,13 +22,13 @@ The output directory contains the following files and subdirectories:
 
 .Procedure
 
-. Obtain the path of the `index.html` file of your report from the output that appears after you run {ProductShortName}:
+. In the `<APPLICATION_NAME>-output` directory that you specified in the {ProductShortName} `./analyze` command, open the `index.html` file:
 +
 ----
 Report created: <OUTPUT_REPORT_DIRECTORY>/index.html
               Access it at this URL: file:///<OUTPUT_REPORT_DIRECTORY>/index.html
 ----
 
-. Open the `index.html` file by using a browser.
+. The `index.html` file opens in a browser by default.
 +
-The generated report is displayed.
+The browser window shows the generated report.

docs/topics/installing-cli-tool.adoc

@@ -7,8 +7,7 @@
 [id="installing-cli-tool_{context}"]
 = Installing the {CLINameTitle}
 
-You can install the {CLINameTitle} on Linux, Windows, or macOS operating systems.
-
+You can install the {ProductShortName} {CLINameTitle} on Linux, Windows, or macOS operating systems.
 
 .Prerequisites
 
@@ -24,24 +23,52 @@ Podman provides a command-line interface (CLI) familiar to anyone who has used t
 For more information on installing and using Podman, see link:https://podman.io/docs/installation[Podman installation instructions].
 ====
 
+.Installation options
+
+You can run either of the following two options to install {ProductShortName} {CLINameTitle}:
+
+* Downloading the appropriate {ProductShortName} {CLINameTitle} `.zip` file, according to your operating system, and installing by using the command line.
+* Running Podman on your computer and installing {ProductShortName} {CLIName} using Podman commands.
+
++
+[WARNING]
+====
+Although installation using Podman is possible, downloading and installing the {ProductShortName} {CLIName} `.zip` file is the preferred installation.
+====
+
+
 [id="installing-downloadable-cli-zip_{context}"]
 == Installing the {CLINameTitle} `.zip` file
 
 .Procedure
 
 To install using the downloadable `.zip` file:
 
-. Navigate to the link:{DevDownloadPageURL}[{ProductShortName} Download page] and download the OS-specific CLI file or the `src` file:
+. Navigate to the link:https://developers.redhat.com/products/mta/download[{ProductShortName} Download page] and download the OS-specific {ProductShortName} CLI file or the `mta-{ProductVersion}-cli-src` file:
+
++
+* Migration Toolkit {CLINameTitle} - {CLINameTitle} for Linux x86_64
+* Migration Toolkit {CLINameTitle} - {CLINameTitle} for Linux aarch64
+* Migration Toolkit {CLINameTitle} - {CLINameTitle} for macOS x86_64
+* Migration Toolkit {CLINameTitle} - {CLINameTitle} for macOS aarch64
+* Migration Toolkit {CLINameTitle} - {CLINameTitle} for Windows x86_64
+* Migration Toolkit {CLINameTitle} - {CLINameTitle} for Windows aarch64
+* Migration Toolkit {CLINameTitle} - {CLINameTitle} for {ProductShortName} source Code
+
 +
-* {ProductShortNameLower}-{ProductVersion}-cli-linux.zip
-* {ProductShortNameLower}-{ProductVersion}-cli-macos.zip
-* {ProductShortNameLower}-{ProductVersion}-cli-windows.zip
-* {ProductShortNameLower}-{ProductVersion}-cli-src.zip
+[NOTE]
+====
+Do not download and install the {ProductShortName} source code file if your computer runs one of the above operating systems.
+====
 
 . Extract the `.zip` file to a directory of your choice. The `.zip` file extracts a single binary, called *mta-cli*.
 +
 When you encounter `<{ProductShortName}_HOME>` in this guide, replace it with the actual path to your {ProductShortName} installation.
 
+. Copy or save the `mta-cli` binary on Linux, `darwin-mta-cli on macOS, or `mta-cli.exe` on Windows, to a known directory.
++
+Continue to xref:cli-run_cli-guide[Running the CLI] to run the CLI command.
+
 
 [id="installing-using-podman_{context}"]
 == Installing the {CLINameTitle} using Podman
@@ -60,10 +87,19 @@ To install using `podman pull`:
 [source,terminal]
 ----
 podman login registry.redhat.io
+----
+
+. Enter your `Username` and `Password`.
++
+[source,terminal]
+---- 
 Username: <username>
 Password: <***********>
 ----
-. Issue:
++
+If your `Username` and `Password` are correct, the terminal line should show `Login Succeeded!`.
+
+. Copy the binary `PATH` for system-wide use.
 +
 [source,terminal]
 ----

docs/topics/migration-paths.adoc

@@ -26,6 +26,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
 |Spring Boot in Red Hat Runtimes
 |Quarkus 
 |Open Liberty
+|Azure App Service
 
 |Oracle WebLogic Server
 |{icon-check}
@@ -36,6 +37,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
 |-
 |-
 |-
+|-
 
 |IBM WebSphere Application Server
 |{icon-check}
@@ -46,6 +48,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
 |-
 |-
 |{icon-check}
+|-
 
 |JBoss EAP 4
 |{icon-x} footnoteref:[note2,Although {ProductShortName} does not currently provide rules for this migration path, Red Hat Consulting can assist with migration from any source platform to JBoss EAP 7.]
@@ -55,6 +58,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
 |-
 |-
 |-
+|-
 
 |JBoss EAP 5
 |{icon-check}
@@ -65,6 +69,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
 |-
 |-
 |-
+|-
 
 |JBoss EAP 6
 |{icon-check}
@@ -75,6 +80,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
 |-
 |-
 |-
+|-
 
 |JBoss EAP 7
 |{icon-check}
@@ -85,6 +91,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
 |-
 |{icon-check}
 |-
+|-
 
 |Thorntail
 |{icon-check} footnoteref:[note3,Requires JBoss Enterprise Application Platform expansion pack 2 (EAP XP 2)]
@@ -95,6 +102,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
 |-
 |-
 |-
+|-
 
 |Oracle JDK
 |-
@@ -105,6 +113,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
 |-
 |-
 |-
+|-
 
 |Camel 2
 |-
@@ -115,6 +124,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
 |-
 |-
 |-
+|-
 
 |Spring Boot
 |-
@@ -125,6 +135,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
 |{icon-check}
 |{icon-check}
 |-
+|-
 
 |Any Java application
 |-
@@ -135,6 +146,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
 |-
 |-
 |-
+|-
 
 |Any Java EE application
 |-
@@ -145,4 +157,16 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
 |-
 |-
 |-
+|-
+
+|Azure
+|-
+|-
+|-
+|-
+|-
+|-
+|-
+|-
+|{icon-check}
 |===

docs/topics/mta-cli-run.adoc

@@ -4,15 +4,15 @@
 
 :_content-type: PROCEDURE
 [id="cli-run_{context}"]
-= Running the {CLINameTitle}
+// = Running the {CLINameTitle}
 
 You can run {ProductShortName} against your application.
 
 .Procedure
 
 . Open a terminal and navigate to the `<{ProductShortName}_HOME>/` directory.
 
-. Execute the `{mta-cli}` script, or `{mta-cli}.exe` for Windows, and specify the appropriate arguments:
+. Run the `{mta-cli}` script, or `{mta-cli}.exe` for Windows, or darwin-{mta-cli} for macOS, and specify the appropriate arguments:
 
 +
 [source,terminal,subs="attributes+"]

docs/topics/mta-review-reports.adoc

@@ -17,12 +17,12 @@ $ <{ProductShortName}_HOME>/bin/{mta-cli} --input /home/username/{mta-cli}-sourc
 ----
 endif::cli-guide[]
 
-Use a browser to open the `index.html` file located in the report output directory. This opens a landing page that lists the applications that were processed.  Each row contains a high-level overview of the story points, number of incidents, and technologies encountered in that application.
+Use a browser to open the `index.html` file located in the report output directory. This opens a landing page that lists the applications that were processed. Each row contains a high-level overview of the story points, number of incidents, and technologies encountered in that application.
 
 .Application list
 image::3-1-applications.png[Application list]
 
-NOTE: The incidents and estimated story points change as new rules are added to {ProductShortName}. The values here may not match what you see when you test this application.
+NOTE: The incidents and estimated story points change as new rules are added to {ProductShortName}. The values here might not match what you see when you test this application.
 
 The following table lists all of the reports and pages that can be accessed from this main {ProductShortName} landing page. Click the name of the application, *jee-example-app-1.0.0.ear*, to view the application report.
 
@@ -78,7 +78,7 @@ The top navigation bar lists the various reports that contain additional details
 | Provides a concise summary of all issues that require attention.
 
 | Application details
-| Provides a detailed overview of all resources found within the application that may need attention during the migration.
+| Provides a detailed overview of all resources found within the application that might need attention during the migration.
 
 | Technologies
 | Displays all embedded libraries grouped by functionality, allowing you to quickly view the technologies used in each application.
@@ -141,7 +141,7 @@ This report includes details about every issue that was raised by the selected m
 .Issues report
 image::3-4-issues-report.png[Issues report]
 
-Each reported issue may be expanded, by clicking on the title, to obtain additional details. The following information is provided.
+Each reported issue can be expanded, by clicking on the title, to obtain additional details. The following information is provided.
 
 * A list of files where the incidents occurred, along with the number of incidents within each file. If the file is a Java source file, then clicking the filename will direct you to the corresponding Source report.
 * A detailed description of the issue. This description outlines the problem, provides any known solutions, and references supporting documentation regarding either the issue or resolution.