Skip to content

Commit 14d2da1

Browse files
author
Mariya Pershina
committed
More modifications from the SME review
1 parent cf77432 commit 14d2da1

23 files changed

+216
-502
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ endif::[]
1111
ifdef::context[]
1212
[id="analyzing-applications-mta-cli_{context}"]
1313
endif::[]
14-
= Analyzing Java applications with {ProductShortName} CLI
14+
= Analyzing Java applications with {ProductShortName} command-line interface
1515

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ endif::[]
1111
ifdef::context[]
1212
[id="analyzing-nonjava-applications_{context}"]
1313
endif::[]
14-
= Analyzing applications written in languages other than Java
14+
= Analyzing applications written in languages other than Java with {ProductShortName} command-line interface
1515

1616
:context: analyzing-nonjava-applications
1717

assemblies/cli-guide/assembly_generating-assets.adoc

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,20 @@ endif::[]
1717

1818
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}:
1919

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.
20+
* Use the `discover` command to generate 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+
* Use the `generate` command to generate 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+
:FeatureName: Generating platform assets for application deployment
24+
include::topics/snippets/developer-preview-admonition.adoc[]
25+
26+
.Benefits of generating deployment assets
2227

2328
Generating deployment assets has the following benefits:
2429

2530
* Generating the Kubernetes and non-Kubernetes deployment manifests.
2631
* Generating deployment manifests by using familiar template engines, for example, Helm, that are widely used for Kubernetes deployments.
2732
* Adhering to Kubernetes best practices when preparing the deployment manifest by using Helm templates.
2833
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.
3734
3835
3936
include::topics/mta-cli/proc_generating-discovery-manifest.adoc[leveloffset=+1]

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ endif::[]
1111
ifdef::context[]
1212
[id="installing-mta-cli_{context}"]
1313
endif::[]
14-
= Installing MTA CLI
14+
= Installing {ProductShortName} command-line interface
1515

1616
:context: installing-mta-cli
1717

@@ -21,9 +21,9 @@ NOTE: You can also install the CLI for use with Docker on Windows. Note, however
2121

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

24-
include::topics/mta-cli/proc_installing-cli-for-docker.adoc[leveloffset=+1]
24+
include::topics/mta-cli/proc_installing-mta-disconnected-environment.adoc[leveloffset=+1]
2525

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

2828

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

assemblies/cli-guide/assembly_performing-transformation.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ endif::[]
1111
ifdef::context[]
1212
[id="performing-transformation_{context}"]
1313
endif::[]
14-
= Performing a transformation with the {ProductShortName} CLI
14+
= Performing a transformation with the {ProductShortName} command-line interface
1515

1616

1717
:context: performing-transformation
@@ -22,14 +22,18 @@ You can use transformation to perform the following actions:
2222
* Convert XML rules to YAML rules by using the `transform rules` command.
2323
2424
IMPORTANT: Performing transformation requires the container runtime to be configured.
25-
25+
2626

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

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

31+
include::topics/mta-cli/ref_openrewrite-command-options.adoc[leveloffset=+1]
32+
3133
include::topics/mta-cli/proc_converting-xml-to-yaml.adoc[leveloffset=+1]
3234

35+
include::topics/mta-cli/ref_rules-command-options.adoc[leveloffset=+1]
36+
3337
ifdef::parent-context-of-performing-transformation[:context: {parent-context-of-performing-transformation}]
3438
ifndef::parent-context-of-performing-transformation[:!context:]
3539

assemblies/cli-guide/assembly_reviewing-analysis-reports.adoc

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,15 @@ endif::[]
1111
ifdef::context[]
1212
[id="reviewing-analysis-reports_{context}"]
1313
endif::[]
14-
= Reviewing analysis reports
14+
= Reviewing an analysis report
1515

1616
:context: reviewing-analysis-reports
1717

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
18+
After analyzing an application, you can access an analysis report to check the details of the entire application migration effort.
2819

20+
include::topics/mta-cli/proc_accessing-analysis-report.adoc[leveloffset=+1]
2921

22+
include::topics/mta-cli/ref_analysis-report-sections.adoc[leveloffset=+1]
3023

3124

3225
ifdef::parent-context-of-reviewing-analysis-reports[:context: {parent-context-of-reviewing-analysis-reports}]

docs/cli-guide/assemblies

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

docs/cli-guide/master.adoc

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,9 @@ include::assemblies/cli-guide/assembly_analyzing-applications-mta-cli.adoc[level
2424

2525
include::assemblies/cli-guide/assembly_analyzing-nonjava-applications.adoc[leveloffset=+1]
2626

27-
include::assemblies/cli-guide/assembly_performing-transformation.adoc[leveloffset=+1]
27+
include::assemblies/cli-guide/assembly_reviewing-analysis-reports.adoc[leveloffset=+1]
2828

29-
//REWRITE FIRST (very much outdated)include::topics/access-report.adoc[leveloffset=+2]
30-
//include::topics/mta-review-reports.adoc[leveloffset=+1]
31-
// include::topics/csv-export.adoc[leveloffset=+1]
32-
// include::topics/mavenize.adoc[leveloffset=+1]
29+
include::assemblies/cli-guide/assembly_performing-transformation.adoc[leveloffset=+1]
3330

3431
include::assemblies/cli-guide/assembly_generating-assets.adoc[leveloffset=+1]
3532

docs/topics/access-report.adoc

Lines changed: 0 additions & 34 deletions
This file was deleted.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
:_newdoc-version: 2.18.5
2+
:_template-generated: 2025-06-18
3+
:_mod-docs-content-type: PROCEDURE
4+
5+
[id="accessing-analysis-report_{context}"]
6+
= Accessing an analysis report
7+
8+
When you run an application analysis, a report is generated in the output directory that you specify by using the `--output` argument in the command line.
9+
10+
.Procedure
11+
12+
* Copy the path of the `index.html` file from the analysis output and paste it in a browser of your choice:
13+
+
14+
[subs="+quotes"]
15+
----
16+
Report created: _<output_report_directory>_/index.html
17+
Access it at this URL: file:///_<output_report_directory>_/index.html
18+
----
19+
+
20+
Alternatively, press *Ctrl* and click on the path of the `index.html` file.

0 commit comments

Comments
 (0)