Skip to content

Commit cf77432

Browse files
author
Mariya Pershina
committed
More rewrites/restructures
1 parent eb819c1 commit cf77432

File tree

40 files changed

+688
-583
lines changed

40 files changed

+688
-583
lines changed

assemblies/cli-guide/assembly_analyzing-applications-mta-cli.adoc

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,27 +11,33 @@ endif::[]
1111
ifdef::context[]
1212
[id="analyzing-applications-mta-cli_{context}"]
1313
endif::[]
14-
= Analyzing applications with {ProductShortName} CLI
14+
= Analyzing Java applications with {ProductShortName} CLI
1515

1616
:context: analyzing-applications-mta-cli
1717

18-
Depending on your scenario, you can use the {ProductFullName} {CLINameTitle} to run the analysis the following ways:
18+
Depending on your scenario, you can use the {ProductFullName} {CLINameTitle} to perform the following actions:
1919

2020
* Run the analysis against a single application.
2121
* 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)].
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:analyzing-single-app-wth-mta-cli_analyzing-applications-mta-cli[Running the {ProductShortName} {CLINameTitle} against an application].
23+
** In {ProductShortName} version 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:analyzing-multiple-apps-with-mta-cli_analyzing-applications-mta-cli[Analyzing multiple applications].
2424
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].
25+
[IMPORTANT]
26+
====
27+
Starting from {ProductShortName} version 7.2.0, you can run the application analysis for Java applications in the containerless mode. Note that this option is set by default and is used automatically only if all requirements are met. For more information, see xref:running-the-containerless-mta-cli_analyzing-applications-mta-cli[Analyzing an application in the containerless mode].
2628
29+
However, if you want to analyze applications in languages other than Java or, for example, use xref:performing-transformation_cli-guide[transformation commands], you still need to use containers.
30+
====
2731

28-
include::topics/proc_analyzing-single-app-with-mta-cli.adoc[leveloffset=+1]
32+
{ProductShortName} CLI supports running source code and binary analysis by using `analyzer-lsp`. `analyzer-lsp` is a tool that evaluates rules by using language providers.
33+
34+
include::topics/mta-cli/proc_analyzing-single-app-with-mta-cli.adoc[leveloffset=+1]
2935

30-
include::topics/proc_analyzing-multiple-apps-with-mta-cli.adoc[leveloffset=+1]
36+
include::topics/mta-cli/proc_analyzing-multiple-apps-with-mta-cli.adoc[leveloffset=+1]
3137

32-
include::topics/proc_running-the-containerless-mta-cli.adoc[leveloffset=+1]
38+
include::topics/mta-cli/proc_running-the-containerless-mta-cli.adoc[leveloffset=+1]
3339

34-
include::topics/ref_mta-cli-analyze-flags.adoc[leveloffset=+1]
40+
include::topics/mta-cli/ref_mta-cli-analyze-flags.adoc[leveloffset=+1]
3541

3642
[role="_additional-resources"]
3743

assemblies/cli-guide/assembly_analyzing-multi-language-applications.adoc

Lines changed: 0 additions & 34 deletions
This file was deleted.
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-nonjava-applications"]
10+
endif::[]
11+
ifdef::context[]
12+
[id="analyzing-nonjava-applications_{context}"]
13+
endif::[]
14+
= Analyzing applications written in languages other than Java
15+
16+
:context: analyzing-nonjava-applications
17+
18+
Starting from {ProductFullName} version 7.1.0, you can run the application analysis on applications written in languages other than Java. You can perform the analysis either of the following ways:
19+
20+
* Select a supported language provider to run the analysis for.
21+
* Overwrite the existing supported language provider with your own unsupported language provider and then run the analysis for it.
22+
23+
24+
IMPORTANT: Analyzing applications written in languages other than Java is only possible in container mode. You can use containerless CLI only for Java applications. For more information, see xref:running-the-containerless-mta-cli_analyzing-applications-mta-cli[Analyzing an application in containerless mode].
25+
26+
27+
include::topics/mta-cli/proc_analyze-selected-provider.adoc[leveloffset=+1]
28+
29+
include::topics/mta-cli/proc_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: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2025-05-28
3+
4+
ifdef::context[:parent-context-of-generating-assets: {context}]
5+
6+
:_mod-docs-content-type: ASSEMBLY
7+
8+
ifndef::context[]
9+
[id="generating-assets"]
10+
endif::[]
11+
ifdef::context[]
12+
[id="generating-assets_{context}"]
13+
endif::[]
14+
= Generating platform assets for application deployment
15+
16+
:context: generating-assets
17+
18+
Starting from {ProductShortName} version 7.3.0, you can use the `discover` and `generate` commands in containerless mode to automatically generate the manifests needed to deploy a Cloud Foundry (CF) application in the {ocp-short}:
19+
20+
* The `discover` command generates the discovery manifest in the YAML format from the CF application manifest. The discovery manifest preserves the specifications found in the CF manifest that define the metadata, runtime, and platform configurations.
21+
* The `generate` command generates the deployment manifest for {ocp} deployments by using the discovery manifest. The deployment manifest is generated by using a templating engine, such as Helm, that converts the discovery manifest into a Kubernetes-native format. You can also use this command to generate non-Kubernetes manifests, such as a Dockerfile or a configuration file.
22+
23+
Generating deployment assets has the following benefits:
24+
25+
* Generating the Kubernetes and non-Kubernetes deployment manifests.
26+
* Generating deployment manifests by using familiar template engines, for example, Helm, that are widely used for Kubernetes deployments.
27+
* Adhering to Kubernetes best practices when preparing the deployment manifest by using Helm templates.
28+
29+
:FeatureName: Generating platform assets for application deployment
30+
include::topics/snippets/developer-preview-admonition.adoc[]
31+
32+
.Prerequisites
33+
34+
* You have Cloud Foundry (v3) as a source platform.
35+
* You have {ocp-short} as a target platform.
36+
* You have {ProductShortName} {CLIName} version 7.3.0 installed.
37+
38+
39+
include::topics/mta-cli/proc_generating-discovery-manifest.adoc[leveloffset=+1]
40+
41+
include::topics/mta-cli/proc_generating-deployment-manifest.adoc[leveloffset=+1]
42+
43+
include::topics/mta-cli/ref_discover-generate-command-options.adoc[leveloffset=+1]
44+
45+
include::topics/mta-cli/ref_assets-generation-example.adoc[leveloffset=+1]
46+
47+
48+
49+
ifdef::parent-context-of-generating-assets[:context: {parent-context-of-generating-assets}]
50+
ifndef::parent-context-of-generating-assets[:!context:]
51+

assemblies/cli-guide/assembly_installing-mta-cli.adoc

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,33 +15,15 @@ endif::[]
1515

1616
:context: installing-mta-cli
1717

18-
You can install the {ProductFullName} command-line interface (CLI) on Linux, Windows, or macOS operating systems one of the following ways:
18+
You can install the {ProductFullName} command-line interface (CLI) on Linux, Windows, or macOS operating systems.
1919

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-
////
20+
NOTE: You can also install the CLI for use with Docker on Windows. Note, however, that this is a Developer Preview feature only.
3821

3922
include::topics/mta-cli/proc_installing-cli-zip.adoc[leveloffset=+1]
4023

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]
24+
include::topics/mta-cli/proc_installing-cli-for-docker.adoc[leveloffset=+1]
4425

26+
//NEEDS TO BE REWRITTEN YET include::topics/mta-cli/installing-mta-disconnected-environment.adoc[leveloffset=+2]
4527

4628

4729
ifdef::parent-context-of-installing-mta-cli[:context: {parent-context-of-installing-mta-cli}]

assemblies/cli-guide/assembly_performing-transformation.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ You can use transformation to perform the following actions:
2121
* Transform Java applications source code by using the `transform openrewrite` command.
2222
* Convert XML rules to YAML rules by using the `transform rules` command.
2323
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].
24+
IMPORTANT: Performing transformation requires the container runtime to be configured.
2525

2626

27-
include::topics/proc_transforming-application-source-code.adoc[leveloffset=+1]
27+
include::topics/mta-cli/proc_transforming-application-source-code.adoc[leveloffset=+1]
2828

29-
include::topics/ref_available-openrewrite-recipes.adoc[leveloffset=+1]
29+
include::topics/mta-cli/ref_available-openrewrite-recipes.adoc[leveloffset=+1]
3030

31-
include::topics/proc_converting-xml-to-yaml.adoc[leveloffset=+1]
31+
include::topics/mta-cli/proc_converting-xml-to-yaml.adoc[leveloffset=+1]
3232

3333
ifdef::parent-context-of-performing-transformation[:context: {parent-context-of-performing-transformation}]
3434
ifndef::parent-context-of-performing-transformation[:!context:]
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-05-28
3+
4+
ifdef::context[:parent-context-of-reference-material: {context}]
5+
6+
:_mod-docs-content-type: ASSEMBLY
7+
8+
ifndef::context[]
9+
[id="reference-material"]
10+
endif::[]
11+
ifdef::context[]
12+
[id="reference-material_{context}"]
13+
[appendix,id="reference-material"]
14+
endif::[]
15+
= Reference material
16+
17+
:context: reference-material
18+
19+
The following is information that you might find useful when using the {ProductFullName} CLI.
20+
21+
// {ProductShortName} Command-line Arguments
22+
//include::topics/mta-cli-args.adoc[leveloffset=+2]
23+
24+
// Added in 4.3.0: list of supported Tech Tags
25+
include::topics/ref_mta-tech-tags.adoc[leveloffset=+1]
26+
27+
// Rule Story Points
28+
include::assembly_rule-story-points.adoc[leveloffset=+1]
29+
30+
31+
32+
ifdef::parent-context-of-reference-material[:context: {parent-context-of-reference-material}]
33+
ifndef::parent-context-of-reference-material[:!context:]
34+
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-10
3+
4+
ifdef::context[:parent-context-of-reviewing-analysis-reports: {context}]
5+
6+
:_mod-docs-content-type: ASSEMBLY
7+
8+
ifndef::context[]
9+
[id="reviewing-analysis-reports"]
10+
endif::[]
11+
ifdef::context[]
12+
[id="reviewing-analysis-reports_{context}"]
13+
endif::[]
14+
= Reviewing analysis reports
15+
16+
:context: reviewing-analysis-reports
17+
18+
When you run an application analysis, the {ProductFullName} CLI generates an analysis report in the output directory that you specify by using the `--output` argument in the `mta-cli analyze` command.
19+
20+
The output directory contains the following files and subdirectories:
21+
22+
* analysis.log
23+
* dependencies.yaml
24+
* output.yaml
25+
* shim.log
26+
* static-report
27+
* static-report.log
28+
29+
30+
31+
32+
ifdef::parent-context-of-reviewing-analysis-reports[:context: {parent-context-of-reviewing-analysis-reports}]
33+
ifndef::parent-context-of-reviewing-analysis-reports[:!context:]
34+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2025-05-28
3+
4+
ifdef::context[:parent-context-of-rule-story-points: {context}]
5+
6+
:_mod-docs-content-type: ASSEMBLY
7+
8+
ifndef::context[]
9+
[id="rule-story-points"]
10+
endif::[]
11+
ifdef::context[]
12+
[id="rule-story-points_{context}"]
13+
endif::[]
14+
= Rule story points
15+
16+
:context: rule-story-points
17+
18+
_Story points_ are an abstract metric commonly used in Agile software development to estimate the level of effort required to implement a feature or change.
19+
20+
The {ProductName} uses story points to express the level of effort needed to migrate particular application constructs, and the application as a whole. It does not necessarily translate to man-hours, but the value must be consistent across tasks.
21+
22+
include::topics/ref_effort-level-estimation.adoc[leveloffset=+1]
23+
24+
include::topics/ref_migration-tasks-categories.adoc[leveloffset=+1]
25+
26+
27+
ifdef::parent-context-of-rule-story-points[:context: {parent-context-of-rule-story-points}]
28+
ifndef::parent-context-of-rule-story-points[:!context:]
29+

0 commit comments

Comments
 (0)