Skip to content

Commit 2a5358e

Browse files
author
Mariya Pershina
committed
CLI guide restrucures/rewrites
1 parent dd484d7 commit 2a5358e

25 files changed

+692
-288
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2025-03-17
3+
4+
ifdef::context[:parent-context-of-analyzing-applications-mta-cli: {context}]
5+
6+
:_mod-docs-content-type: ASSEMBLY
7+
8+
ifndef::context[]
9+
[id="analyzing-applications-mta-cli"]
10+
endif::[]
11+
ifdef::context[]
12+
[id="analyzing-applications-mta-cli_{context}"]
13+
endif::[]
14+
= Analyzing applications with {ProductShortName} CLI
15+
16+
:context: analyzing-applications-mta-cli
17+
18+
Depending on your scenario, you can use the {ProductFullName} {CLINameTitle} to run the analysis the following ways:
19+
20+
* Run the analysis against a single application.
21+
* Run the analysis against multiple applications:
22+
** In {ProductShortName} versions earlier than 7.1.0, you can enter a series of `--analyze` commands, each against an application and each generating a separate report. For more information, see xref:mta-cli-run-single-app_cli-guide[Running the {ProductShortName} {CLINameTitle} against an application].
23+
** In {ProductShortName} 7.1.0 and later, you can use the `--bulk` option to analyze multiple applications at once and generate a single report. Note that this feature is a Developer Preview feature only. For more information, see xref:mta-cli-run-multiple-apps_cli-guide[Running the {ProductShortName} {CLINameTitle} against multiple applications and generating a single report (Developer Preview)].
24+
25+
IMPORTANT: Starting from {ProductShortName} 7.2.0, you can run the application analysis in the containerless mode. Note that this option is set by default and is used automatically if all requirements are met. For more information, see xref:running-the-containerless-mta-cli_cli-guide[Running the containerless CLI].
26+
27+
28+
include::topics/proc_analyzing-single-app-with-mta-cli.adoc[leveloffset=+1]
29+
30+
include::topics/proc_analyzing-multiple-apps-with-mta-cli.adoc[leveloffset=+1]
31+
32+
include::topics/proc_running-the-containerless-mta-cli.adoc[leveloffset=+1]
33+
34+
include::topics/ref_mta-cli-analyze-flags.adoc[leveloffset=+1]
35+
36+
[role="_additional-resources"]
37+
38+
ifdef::parent-context-of-analyzing-applications-mta-cli[:context: {parent-context-of-analyzing-applications-mta-cli}]
39+
ifndef::parent-context-of-analyzing-applications-mta-cli[:!context:]
40+
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2025-04-09
3+
4+
ifdef::context[:parent-context-of-analyzing-multi-language-applications: {context}]
5+
6+
:_mod-docs-content-type: ASSEMBLY
7+
8+
ifndef::context[]
9+
[id="analyzing-multi-language-applications"]
10+
endif::[]
11+
ifdef::context[]
12+
[id="analyzing-multi-language-applications_{context}"]
13+
endif::[]
14+
= Analyzing multi-language applications
15+
16+
:context: analyzing-multi-language-applications
17+
18+
Starting from {ProductFullName} 7.1.0, you can run the application analysis on applications written in multiple languages.
19+
20+
IMPORTANT: Analyzing multi-language applications is only possible in container mode. You can use containerless analysis only for applications written in Java.
21+
22+
You can perform the multi-language application analysis either of the following ways:
23+
24+
* Select a supported language provider to run the analysis for.
25+
* Overwrite the existing supported language provider with your own unsupported language provider and then run the analysis for it.
26+
27+
include::topics/mta-cli-analyze-selected-provider.adoc[leveloffset=+1]
28+
29+
include::topics/mta-cli-analyze-unsupported-provider.adoc[leveloffset=+1]
30+
31+
32+
ifdef::parent-context-of-analyzing-multi-language-applications[:context: {parent-context-of-analyzing-multi-language-applications}]
33+
ifndef::parent-context-of-analyzing-multi-language-applications[:!context:]
34+
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2025-03-14
3+
4+
ifdef::context[:parent-context-of-installing-mta-cli: {context}]
5+
6+
:_mod-docs-content-type: ASSEMBLY
7+
8+
ifndef::context[]
9+
[id="installing-mta-cli"]
10+
endif::[]
11+
ifdef::context[]
12+
[id="installing-mta-cli_{context}"]
13+
endif::[]
14+
= Installing MTA CLI
15+
16+
:context: installing-mta-cli
17+
18+
You can install the {ProductFullName} command-line interface (CLI) on Linux, Windows, or macOS operating systems one of the following ways:
19+
20+
* Use the downloadable `.zip` file.
21+
* Use the Podman tool.
22+
23+
IMPORTANT: Downloading and installing the `.zip` file is the preferred way of installing the {ProductShortName} CLI.
24+
25+
NOTE: You can also install the CLI for use with Docker on Windows. Note, however, that this is a Developer Preview feature only.
26+
27+
// Move to the running the CLI section
28+
////
29+
[IMPORTANT]
30+
====
31+
Starting from {ProductShortName} 7.2.0, you can run the application analysis for Java applications in the containerless mode.
32+
33+
The containerless mode is set by default and is used automatically if all requirements are met. For more information, see xref:running-the-containerless-mta-cli_cli-guide[Running the containerless CLI].
34+
35+
However, if you want to analyze applications in languages other than Java or, for example, use xref:mta-cli-transform_cli-guide[transformation commands], you still need to use containers.
36+
====
37+
////
38+
39+
include::topics/mta-cli/proc_installing-cli-zip.adoc[leveloffset=+1]
40+
41+
include::topics/mta-cli/proc_installing-cli-with-podman.adoc[leveloffset=+1]
42+
43+
include::topics/proc_installing-cli-for-docker.adoc[leveloffset=+1]
44+
45+
46+
47+
ifdef::parent-context-of-installing-mta-cli[:context: {parent-context-of-installing-mta-cli}]
48+
ifndef::parent-context-of-installing-mta-cli[:!context:]
49+
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2025-04-08
3+
4+
ifdef::context[:parent-context-of-performing-transformation: {context}]
5+
6+
:_mod-docs-content-type: ASSEMBLY
7+
8+
ifndef::context[]
9+
[id="performing-transformation"]
10+
endif::[]
11+
ifdef::context[]
12+
[id="performing-transformation_{context}"]
13+
endif::[]
14+
= Performing a transformation with the {ProductShortName} CLI
15+
16+
17+
:context: performing-transformation
18+
19+
You can use transformation to perform the following actions:
20+
21+
* Transform Java applications source code by using the `transform openrewrite` command.
22+
* Convert XML rules to YAML rules by using the `transform rules` command.
23+
24+
IMPORTANT: Performing transformation requires the container runtime to be configured. For more information, see xref:installing-using-podman_cli-guide[Installing the CLI by using Podman].
25+
26+
27+
include::topics/proc_transforming-application-source-code.adoc[leveloffset=+1]
28+
29+
include::topics/ref_available-openrewrite-recipes.adoc[leveloffset=+1]
30+
31+
include::topics/proc_converting-xml-to-yaml.adoc[leveloffset=+1]
32+
33+
ifdef::parent-context-of-performing-transformation[:context: {parent-context-of-performing-transformation}]
34+
ifndef::parent-context-of-performing-transformation[:!context:]
35+

assemblies/cli-guide/topics

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../topics/

docs/cli-guide/master-docinfo.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<title>CLI Guide</title>
22
<productname>{DocInfoProductName}</productname>
33
<productnumber>{DocInfoProductNumber}</productnumber>
4-
<subtitle>Learn how to use the {ProductName} {CLIName} to migrate your applications.</subtitle>
4+
<subtitle>Using the {ProductName} command-line interface to migrate applications.</subtitle>
55
<abstract>
6-
<para>This guide describes how to use the {ProductName} {CLIName} to simplify migration of Java applications.</para>
6+
<para>By using the {ProductName} command-line interface (CLI), you can assess and prioritize migration and modernization efforts for Java applications.</para>
77
</abstract>
88
<authorgroup>
99
<orgname>Red Hat Customer Content Services</orgname>

docs/cli-guide/master.adoc

Lines changed: 10 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -10,88 +10,29 @@ include::topics/templates/document-attributes.adoc[]
1010
:imagesdir: topics/images
1111
:context: cli-guide
1212
:cli-guide:
13-
13+
1414
//Inclusive language statement
1515
include::topics/making-open-source-more-inclusive.adoc[]
1616

17-
== Introduction
18-
19-
// About the {UserCLIBookName}
20-
include::topics/about-cli-guide.adoc[leveloffset=+2]
21-
22-
:FeatureName: .NET migration
23-
include::topics/developer-preview-feature.adoc[]
24-
25-
:FeatureName: Analyzing applications written in a language other than Java
26-
include::topics/developer-preview-feature.adoc[]
27-
28-
// About {ProductName}
29-
include::topics/mta-what-is-the-toolkit.adoc[leveloffset=+2]
30-
31-
include::topics/migration-paths.adoc[leveloffset=+3]
32-
33-
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.
17+
include::topics/mta-intro-to-the-cli.adoc[leveloffset=+1]
3418

35-
// About the {CLINameTitle}
36-
include::topics/about-cli.adoc[leveloffset=+2]
19+
include::topics/mta-migration-paths.adoc[leveloffset=+1]
3720

38-
== Installing and Running the CLI
39-
40-
// Install the CLI
41-
include::topics/installing-cli-tool.adoc[leveloffset=+2]
21+
include::assemblies/cli-guide/assembly_installing-mta-cli.adoc[leveloffset=+1]
4222

4323
// Install in disconnected environment
4424
include::topics/installing-mta-disconnected-environment.adoc[leveloffset=+2]
4525

46-
// CLI known issues
47-
include::topics/cli-tool-known-issues.adoc[leveloffset=+3]
48-
49-
[id="running-cli"]
50-
=== Running the CLI
51-
52-
Depending on your scenario, you can use the {ProductFullName} {CLINameTitle} to run the analysis in the following ways:
53-
54-
* Run the analysis against a single application.
55-
* Run the analysis against multiple applications:
56-
** In {ProductShortName} versions earlier than 7.1.0, you can enter a series of `--analyze` commands, each against an application and each generating a separate report. For more information, see xref:mta-cli-run-single-app_cli-guide[Running the {ProductShortName} {CLINameTitle} against an application].
57-
** In {ProductShortName} 7.1.0 and later, you can use the `--bulk` option to analyze multiple applications at once and generate a single report. Note that this feature is a Developer Preview feature only. For more information, see xref:mta-cli-run-multiple-apps_cli-guide[Running the {ProductShortName} {CLINameTitle} against multiple applications and generating a single report (Developer Preview)].
26+
include::assemblies/cli-guide/assembly_analyzing-applications-mta-cli.adoc[leveloffset=+1]
5827

59-
//:FeatureName: Running the {CLINameTitle} against one or more applications
60-
//include::topics/developer-preview-feature.adoc[]
28+
include::assemblies/cli-guide/assembly_analyzing-multi-language-applications.adoc[leveloffset=+1]
6129

62-
IMPORTANT: Starting from {ProductShortName} 7.2.0, you can run the application analysis in the containerless mode. Note that this option is set by default and is used automatically if all requirements are met. For more information, see xref:running-the-containerless-mta-cli_cli-guide[Running the containerless CLI].
30+
include::assemblies/cli-guide/assembly_performing-transformation.adoc[leveloffset=+1]
6331

64-
// Run the CLI
65-
include::topics/mta-cli-run-single-app.adoc[leveloffset=+3]
66-
67-
include::topics/mta-cli-run-multiple-apps.adoc[leveloffset=+3]
68-
69-
// Analyze application source code
70-
include::topics/mta-cli-analyze.adoc[leveloffset=+3]
71-
72-
include::topics/proc_running-the-containerless-mta-cli.adoc[leveloffset=+3]
73-
74-
// Transform XML rules to YAML
75-
include::topics/mta-cli-transform.adoc[leveloffset=+3]
76-
77-
// Use OpenRewrite recipes
78-
// include::topics/mta-using-openrewrite-recipes.adoc[leveloffset=+3]
79-
80-
// Available OpenRewrite recipes
81-
include::topics/available-openrewrite-recipes.adoc[leveloffset=+4]
8232

8333
// Access the Report
8434
include::topics/access-report.adoc[leveloffset=+2]
8535

86-
// Multi-language application analysis
87-
include::topics/mta-cli-analyze-multi-lang-apps.adoc[leveloffset=+2]
88-
89-
// Multi-language application analysis for the supported provider
90-
include::topics/mta-cli-analyze-selected-provider.adoc[leveloffset=+3]
91-
92-
// Multi-language application analysis for the unsupported provider
93-
include::topics/mta-cli-analyze-unsupported-provider.adoc[leveloffset=+3]
94-
9536
// Review the Reports
9637
include::topics/mta-review-reports.adoc[leveloffset=+1]
9738

@@ -107,6 +48,9 @@ include::topics/mta-optimize-performance.adoc[leveloffset=+1]
10748
// Configure {ProductShortName} to Exclude Files and Packages
10849
// include::topics/mta-exclude-files-and-packages.adoc[leveloffset=+2]
10950

51+
// CLI known issues
52+
include::topics/cli-tool-known-issues.adoc[leveloffset=+3]
53+
11054
[appendix]
11155
== Reference material
11256

docs/topics/about-cli-guide.adoc

Lines changed: 0 additions & 9 deletions
This file was deleted.

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

Lines changed: 0 additions & 32 deletions
This file was deleted.

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

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)