Skip to content

Commit eb819c1

Browse files
author
Mariya Pershina
committed
resolve conflicts
2 parents 2a5358e + 441ee69 commit eb819c1

File tree

51 files changed

+2111
-638
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+2111
-638
lines changed

README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,31 @@
11

2-
# Windup Documentation
2+
# MTA documentation
33

4-
This repository contains the files for Windup documentation.
4+
Migration Toolkit for Applications (MTA) is a set of tools that can be used to accelerate large-scale application modernization efforts across hybrid cloud environments on Red Hat OpenShift.
55

6-
[Windup](https://github.com/windup/windup) is an automated application migration and assessment tool.
6+
This repository contains the files for MTA documentation.
77

8-
For developer-focused documentation, see the [Windup wiki](https://github.com/windup/windup/wiki).
8+
## Contributing to MTA documentation
99

10-
## Contributing to Windup documentation
11-
12-
This project is [Apache 2.0 licensed](LICENSE) and accepts contributions via
13-
GitHub pull requests.
10+
This project is [Apache 2.0 licensed](LICENSE) and accepts contributions via GitHub pull requests.
1411

1512
See the [Contributors Guide](CONTRIBUTING.adoc) for details.
1613

1714
## Reporting a documentation bug
1815

1916
To report a Windup documentation issue, submit a Jira issue on the [Windup project page]]{JiraWindupURL} with the *Component* field set to *Documentation*.
2017

21-
## Repository Structure
18+
## Repository structure
2219

23-
This repository uses the following directory structure:
20+
This repository has the following directory structure:
2421

2522
```
2623
.
27-
├── CONTRIBUTING.adoc (Guide for how to contribute to this repository)
24+
├── CONTRIBUTING.adoc (Instructions on how to contribute to this repository)
2825
├── README.md (This file)
2926
├── topics (Symbolic link to docs/topics/)
3027
└── docs/ (Contains all the asciidoc topics and top level content spec)
31-
├── GUIDE_NAME/
28+
├── guide_name/
3229
│   ├── master.adoc (Base AsciiDoc file for this guide)
3330
│   ├── master-docinfo.xml (Metadata about this guide)
3431
│   └── topics (Symbolic link to docs/topics/)
@@ -39,7 +36,7 @@ This repository uses the following directory structure:
3936
│   ├── document-attributes.adoc (Stores attributes used across guides)
4037
│   ├── revision-info.adoc (Revision timestamp to be added to all guides)
4138
└── *.adoc (AsciiDoc files used across guides)
42-
```
39+
```
4340

4441
## Code of conduct
4542

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>Using the {ProductName} command-line interface to migrate applications.</subtitle>
4+
<subtitle>Using the {ProductName} command-line interface to migrate your applications</subtitle>
55
<abstract>
6-
<para>By using the {ProductName} command-line interface (CLI), you can assess and prioritize migration and modernization efforts for Java applications.</para>
6+
<para>By using the {ProductFullName} command-line interface (CLI), you can assess and prioritize migration and modernization efforts for applications written in different languages. You can use the CLI to customize {ProductShortName} analysis options or integrate with external automation tools.</para>
77
</abstract>
88
<authorgroup>
99
<orgname>Red Hat Customer Content Services</orgname>

docs/cli-guide/master.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,18 @@ include::topics/mta-review-reports.adoc[leveloffset=+1]
4242
// Mavenize Your Application
4343
// include::topics/mavenize.adoc[leveloffset=+1]
4444

45+
//Generating platform Assets for application deployment
46+
include::topics/mta-cli-generate-assets.adoc[leveloffset=+1]
47+
48+
//Generating the discovery manifest
49+
include::topics/mta-cli-generate-discovery-manifest.adoc[leveloffset=+2]
50+
51+
//Generating the deployment manifest
52+
include::topics/mta-cli-generate-deployment-manifest.adoc[leveloffset=+2]
53+
54+
//Generate asset for a Java application
55+
include::topics/mta-cli-generate-deployment-asset-example.adoc[leveloffset=+2]
56+
4557
// Optimize {ProductShortName} Performance
4658
include::topics/mta-optimize-performance.adoc[leveloffset=+1]
4759

docs/release-notes/master.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,23 @@ include::topics/making-open-source-more-inclusive.adoc[]
1818

1919
{ProductFullName} {DocInfoProductNumber} accelerates large-scale application modernization efforts across hybrid cloud environments on {ocp-first}. This solution provides insight throughout the adoption process, at both the portfolio and application levels: inventory, assess, analyze, and manage applications for faster migration to {ocp-short} through the user interface (UI) and command-line interface (CLI).
2020

21+
[id="mta-7-3-0"]
22+
== {ProductShortName} 7.3.0
23+
24+
include::topics/ref_new-features-7-3-0.adoc[leveloffset=+2]
25+
26+
include::topics/ref_fixed-issues-7-3-0.adoc[leveloffset=+2]
27+
28+
include::topics/ref_known-issues-7-3-0.adoc[leveloffset=+2]
29+
30+
31+
[id="mta-7-2-2"]
32+
== {ProductShortName} 7.2.2
33+
34+
include::topics/ref_resolved-issues-7-2-2.adoc[leveloffset=+2]
35+
36+
include::topics/ref_known-issues-7-2-2.adoc[leveloffset=+2]
37+
2138
[id="mta-7-2-1"]
2239
== {ProductShortName} 7.2.1
2340

docs/rules-development-guide/master.adoc

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,68 @@ include::topics/about-rules.adoc[leveloffset=+2]
3131

3232
Each analyzer rule is a set of instructions that are used to analyze source code and detect issues that are problematic for migration.
3333

34-
The analyzer parses user-provided rules, applies them to applications' source code, and generates issues for matched rules. A collection of one or more rules forms a ruleset. Creating rulesets provides a way of organizing multiple rules that achieve a common goal. The analyzer CLI takes rulesets as input arguments.
34+
The analyzer parses user-provided rules, applies them to applications' source code, and generates issues for matched rules.
35+
36+
A collection of one or more rules forms a ruleset. Creating rulesets provides a way of organizing multiple rules that achieve a common goal.
37+
38+
The analyzer CLI takes rulesets as input arguments.
39+
3540

3641
include::topics/yaml-rule-structure-syntax.adoc[leveloffset=+2]
3742

43+
include::topics/yaml-rule-labels.adoc[leveloffset=+2]
44+
3845
[id="creating-basic-yaml-rules_{context}"]
3946
=== Creating a basic YAML rule
4047

4148
This section describes how to create a basic {ProductShortName} YAML rule. This assumes that you already have {ProductShortName} installed. See the {ProductShortName} {ProductDocUserGuideURL}[_{UserCLIBookName}_] for installation instructions.
4249

4350
include::topics/create-basic-yaml-rule-template.adoc[leveloffset=+3]
4451

52+
include::topics/yaml-rule-categories.adoc[leveloffset=+3]
53+
54+
include::topics/yaml-rule-actions.adoc[leveloffset=+3]
55+
56+
include::topics/yaml-rule-conditions.adoc[leveloffset=+3]
57+
58+
include::topics/yaml-tag-actions.adoc[leveloffset=+3]
59+
60+
include::topics/yaml-message-actions.adoc[leveloffset=+3]
61+
62+
include::topics/yaml-rule-hyperlinks.adoc[leveloffset=+3]
63+
64+
include::topics/yaml-provider-conditions.adoc[leveloffset=+3]
65+
66+
include::topics/yaml-builin-provider.adoc[leveloffset=+4]
67+
68+
include::topics/yaml-java-provider.adoc[leveloffset=+4]
69+
70+
include::topics/yaml-java-locations.adoc[leveloffset=+4]
71+
72+
include::topics/yaml-annotation-inspection.adoc[leveloffset=+4]
73+
74+
include::topics/yaml-go-provider.adoc[leveloffset=+4]
75+
76+
include::topics/yaml-dotnet-provider.adoc[leveloffset=+4]
77+
78+
include::topics/yaml-condition-patterns.adoc[leveloffset=+3]
79+
80+
include::topics/yaml-custom-variables.adoc[leveloffset=+3]
81+
82+
include::topics/yaml-logical-conditions.adoc[leveloffset=+3]
83+
84+
include::topics/yaml-and-condition.adoc[leveloffset=+4]
85+
86+
include::topics/yaml-or-condition.adoc[leveloffset=+4]
87+
88+
include::topics/yaml-chaining-condition-variables.adoc[leveloffset=+4]
89+
90+
include::topics/yaml-chaining-java-provider.adoc[leveloffset=+5]
91+
92+
include::topics/yaml-rulesets.adoc[leveloffset=+3]
93+
94+
95+
4596
include::topics/create-basic-yaml-ruleset-template.adoc[leveloffset=+3]
4697

4798
include::topics/create-yaml-rule.adoc[leveloffset=+3]

docs/topics/create-yaml-rule.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ _Example_
173173
when:
174174
java.referenced:
175175
location: PACKAGE
176-
pattern: org.jboss.*
176+
pattern: org.jboss*
177177
----
178178

179179
. Create an `AND` or `OR` condition

docs/topics/installing-cli-tool.adoc

Lines changed: 46 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,27 +11,59 @@ You can install the {CLINameTitle} on Linux, Windows, or macOS operating systems
1111

1212
[IMPORTANT]
1313
====
14-
Starting from {ProductShortName} 7.2.0, you can run the application analysis for Java applications in the containerless mode.
14+
15+
Starting from {ProductShortName} 7.2.0, you can run the application analysis for Java applications in the containerless mode.
1516
1617
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].
1718
1819
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.
1920
====
2021

21-
.Prerequisites
22+
.Prerequisites for containerized CLI
23+
24+
The following are the prerequisites for the {ProductFullName} CLI installation (container):
2225

2326
* Red Hat Container Registry Authentication for `registry.redhat.io`. Red Hat distributes container images from `registry.redhat.io`, which requires authentication. For more details, see link:https://access.redhat.com/RegistryAuthentication[Red Hat Container Registry Authentication].
2427

28+
* link:https://podman.io/[Podman] must be installed.
29+
30+
* 8 GB of RAM is required for the {ProductShortName} {CLIName}.
31+
32+
.Prerequisites for containerless CLI
33+
34+
The following are the prerequisites if you want to to run {ProductShortName} {CLIName} as in xref:running-the-containerless-mta-cli_cli-guide[containerless CLI] mode:
35+
36+
* Java Development Kit (JDK) is installed.
37+
+
38+
{ProductShortName} supports the following JDKs:
39+
40+
** Oracle JDK 17 or later
41+
** Eclipse Temurin™ JDK 17 or later
42+
** OpenJDK 17 or later
43+
+
44+
If you install OpenJDK on {op-system-base-full} or Fedora, the JDK requires a compiler provided by the `devel` package to also be installed, as having only the Java Runtime (JRE) installed causes issues during analysis. For more information about installing Red Hat build of OpenJDK 17 on {op-system-base-full}, see link:https://docs.redhat.com/en/documentation/red_hat_build_of_openjdk/17/html-single/installing_and_using_red_hat_build_of_openjdk_17_on_rhel/index#installing-jre-on-rhel-using-archive_openjdk[Installing Red Hat build of OpenJDK on RHEL by using yum].
45+
46+
* You must set the `JAVA_HOME` and the `PATH` environment variables.
47+
48+
* Maven 3.9.9 installed, and the bin directory is added to the `PATH` environment variable. Setting the path and environment variables depends on the operating system you are using. For more information about installing Maven, see link:https://maven.apache.org/install.html[Apache Maven installation].
49+
50+
* macOS installation requires:
51+
52+
** The value of `maxproc` must be `2048` or greater.
53+
2554
[id="installing-downloadable-cli-zip_{context}"]
2655
== Installing the {CLINameTitle} `.zip` file
2756

2857
.Procedure
2958

3059
. Navigate to the link:{DevDownloadPageURL}[{ProductShortName} Download page] and download the OS-specific CLI file or the `src` file:
3160
+
32-
* {ProductShortNameLower}-{ProductVersion}-cli-linux.zip
33-
* {ProductShortNameLower}-{ProductVersion}-cli-macos.zip
34-
* {ProductShortNameLower}-{ProductVersion}-cli-windows.zip
61+
* {ProductShortNameLower}-{ProductVersion}-cli-linux-amd64.zip
62+
* {ProductShortNameLower}-{ProductVersion}-cli-linux-arm64.zip
63+
* {ProductShortNameLower}-{ProductVersion}-cli-darwin-amd64.zip
64+
* {ProductShortNameLower}-{ProductVersion}-cli-darwin-arm64.zip
65+
* {ProductShortNameLower}-{ProductVersion}-cli-windows-amd64.zip
66+
* {ProductShortNameLower}-{ProductVersion}-cli-windows-arm64.zip
3567
* {ProductShortNameLower}-{ProductVersion}-cli-src.zip
3668

3769
. Extract the `.zip` file to the `.kantra` directory inside your `$HOME` directory. The `.zip` file extracts the *mta-cli* binary, along with other required directories and files.
@@ -42,7 +74,12 @@ When you encounter `<{ProductShortName}_HOME>` in this guide, replace it with th
4274
[id="installing-using-podman_{context}"]
4375
== Installing the {CLINameTitle} by using Podman
4476

45-
You can install the {CLINameTitle} using `podman pull`.
77+
You can install the containerized {CLINameTitle} using `podman pull`.
78+
79+
[NOTE]
80+
====
81+
You cannot install the containerless {CLINameTitle} using Podman as this procedure does not include pulling and unpacking the dependencies that are included in the `.zip` file.
82+
====
4683

4784
.Prerequisites
4885

@@ -195,17 +232,16 @@ Server: Docker Desktop 4.32.0 (157355)
195232
----
196233
PS C:\Users\<your_user_name>> $env:PODMAN_BIN="C:\Windows\system32\docker.exe"
197234
----
198-
199235
. Set the `DOTNET_PROVIDER_IMG` environment variable to use the upstream `dotnet-external-provider`:
200236
+
201237
[source,powershell]
202238
----
203-
PS C:\Users\<your_user_name>> $env:DOTNET_PROVIDER_IMG="quay.io/konveyor/dotnet-external-provider:v0.5.0"
239+
PS C:\Users\<your_user_name>> $env:DOTNET_PROVIDER_IMG="registry.redhat.io/mta/mta-dotnet-external-provider-rhel9:7.1.0"
204240
----
205-
206241
. Set the `RUNNER_IMG` environment variable to use the upstream image:
207242
+
208243
[source,powershell]
209244
----
210-
PS C:\Users\<your_user_name>> $env:RUNNER_IMG="quay.io/konveyor/kantra:v0.5.0"
245+
# double-check reference
246+
PS C:\Users\<your_user_name>> $env:RUNNER_IMG="registry.redhat.io/mta/mta-cli-rhel9:7.1.0"
211247
----

docs/topics/mavenize.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ The root POM is also configured to use the link:https://maven.repository.redhat.
7979
[discrete]
8080
=== BOM file
8181

82-
The Bill of Materials (BOM) file is generated in the directory ending in `-bom`. For the example `jee-example-app-1.0.0.ear` application, the BOM file can be found at `/path/to/output/mavenized/jee-example-app/jee-example-app-bom/pom.xml`. The purpose of this BOM is to have the versions of third-party dependencies used by the project defined in one place. For more information on using a BOM, see the link:https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html[Introduction to the dependency mechanism] section of the Apache Maven documentation.
82+
The Bill of Materials (BOM) file is generated in the directory ending in `-bom`. For the example `jee-example-app-1.0.0.ear` application, the BOM file can be found at `/path/to/output/mavenized/jee-example-app/jee-example-app-bom/pom.xml`. The purpose of this BOM is to have the versions of third-party dependencies used by the project defined in one place. For more information on using a BOM, see the link:https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Bill_of_Materials_.28BOM.29_POMs[Introduction to the dependency mechanism] section of the Apache Maven documentation.
8383

8484
The following dependencies are listed in the BOM for the example `jee-example-app-1.0.0.ear` application
8585

0 commit comments

Comments
 (0)