Skip to content

[WIP] Modularize the Intro to MTA guide #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions assemblies/mta-intro/assembly_mta-tools.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
:_newdoc-version: 2.18.3
:_template-generated: 2025-04-16

ifdef::context[:parent-context-of-mta-tools: {context}]

:_mod-docs-content-type: ASSEMBLY

ifndef::context[]
[id="mta-tools"]
endif::[]
ifdef::context[]
[id="mta-tools_{context}"]
endif::[]
= The {ProductName} tools

:context: mta-tools

You can use the following {ProductFullName} tools for assistance in the various stages of your migration and modernization efforts:

ifdef::mta[]
* User interface
endif::[]

ifdef::mtr[]
* Web console
endif::[]

* {ProductName} Operator
* CLI
* IDE add-ons for the following applications:
** Eclipse
** Visual Studio Code, Visual Studio Codespaces, and Eclipse Che
** IntelliJ IDEA
* {MavenName}

Review the details of each tool to determine which tool is suitable for your project.


include::topics/mta-intro/con_the-mta-operator.adoc[leveloffset=+1]

include::topics/mta-intro/con_mta-user-interface.adoc[leveloffset=+1]

include::topics/mta-intro/con_mta-cli.adoc[leveloffset=+1]

include::topics/mta-intro/con_mta-ide-addons.adoc[leveloffset=+1]

ifdef::parent-context-of-mta-tools[:context: {parent-context-of-mta-tools}]
ifndef::parent-context-of-mta-tools[:!context:]

34 changes: 34 additions & 0 deletions assemblies/mta-intro/assembly_what-is-mta.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
:_newdoc-version: 2.18.3
:_template-generated: 2025-04-16

ifdef::context[:parent-context-of-what-is-mta: {context}]

:_mod-docs-content-type: ASSEMBLY

ifndef::context[]
[id="what-is-mta"]
endif::[]
ifdef::context[]
[id="what-is-mta_{context}"]
endif::[]
= What is the Migration Toolkit for Application

:context: what-is-mta

{ProductFullName} is a set of tools that you can use to accelerate large-scale application modernization efforts across hybrid cloud environments on Red Hat OpenShift. {ProductShortName} looks for common resources and known trouble spots when migrating applications. It provides a high-level view of the technologies used by the application. {ProductShortName} also generates a detailed report that evaluates a migration or modernization path. By using this report, you can estimate the effort required for large-scale projects and reduce the work involved.


By using the {ProductShortName}, you can perform the following tasks:

* Use the {ProductShortName} extensive default questionnaire to assess your applications, or create your own custom questionnaire to estimate the difficulty, time, and other resources needed to prepare an application for containerization. You can use the results of an assessment for discussions between stakeholders to determine which applications are suitable for containerization.
* Analyze applications by applying one or more sets of rules to each application. You can use these rules to determine which specific lines of the application must be modified before the application can be modernized.
* Examine application artifacts, including project source directories and application archives, and produce an HTML report that highlights areas that require changes.

include::topics/mta-intro/con_mta-features.adoc[leveloffset=+1]

include::topics/mta-intro/con_mta-rules.adoc[leveloffset=+1]


ifdef::parent-context-of-what-is-mta[:context: {parent-context-of-what-is-mta}]
ifndef::parent-context-of-what-is-mta[:!context:]

1 change: 1 addition & 0 deletions assemblies/mta-intro/topics
57 changes: 6 additions & 51 deletions docs/getting-started-guide/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,65 +14,20 @@ include::topics/templates/document-attributes.adoc[]
//Inclusive language statement
include::topics/making-open-source-more-inclusive.adoc[]

// == Introduction
include::assemblies/mta-intro/assembly_what-is-mta.adoc[leveloffset=+1]

// About the {IntroToMTABookName}
include::topics/mta-about-the-intro-to-mta-guide.adoc[leveloffset=+1]

// About the Toolkit
// Info included in the module above ^ include::topics/mta-what-is-the-toolkit.adoc[leveloffset=+1]
include::topics/mta-intro/con_mta-migration-paths.adoc[leveloffset=+1]

// Windup Features
include::topics/new-mta-features.adoc[leveloffset=+2]

// Windup Rules
include::topics/about-rules.adoc[leveloffset=+2]

//== Supported configurations

// Supported Migration Paths
include::topics/migration-paths.adoc[leveloffset=+1]

// Prerequisites
== Prerequisites for the {ProductName} installation

include::topics/snippet_jdk-hardware-mac-prerequisites.adoc[]
include::topics/mta-intro/con_mta-installation-prerequisites.adoc[leveloffset=+1]

// At a later date, we may wish to add the following section, once it is revised: For tips on how to optimize performance, see link:{ProductDocUserGuideURL}#optimize_performance[Optimizing {ProductShortName} performance] in {ProductShortName} _{UserCLIBookName}_.

// About the Tools
include::topics/about-tools.adoc[leveloffset=+1]

//About the Operator
include::topics/about-the-mta-operator.adoc[leveloffset=+2]

// About the {WebNameTitle}
include::topics/about-the-web-console.adoc[leveloffset=+2]

// About the {CLIName}
include::topics/about-cli.adoc[leveloffset=+2]

// About the Addons
include::topics/getting-started-about-ide-addons.adoc[leveloffset=+2]
include::assemblies/mta-intro/assembly_mta-tools.adoc[leveloffset=+1]

// About the {MavenNameTitle}
// include::topics/about-maven.adoc[leveloffset=+2]

[appendix]
== Getting involved in the {ProductName} development

// Get Involved
include::topics/get-involved.adoc[leveloffset=+2]

=== Reporting issues

{ProductShortName} uses Jira as its issue tracking system. If you encounter an issue executing {ProductShortName}, submit a link:{JiraWindupURL}[Jira issue].

// Important Links
include::topics/important-links.adoc[leveloffset=+2]

//Appendix:
include::topics/ref_contributing-to-mta-development.adoc[leveloffset=+1]

// **********************************
// * Appendix: Revision Information *
// **********************************
include::topics/templates/revision-info.adoc[]
14 changes: 0 additions & 14 deletions docs/topics/about-cli.adoc

This file was deleted.

2 changes: 1 addition & 1 deletion docs/topics/about-the-web-console.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// * docs/web-console-guide/master.adoc

:_content-type: CONCEPT
[id="about-the-web-console_{context}"]
[id="the-mta-web-console_{context}"]
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This module will be deleted, the info is moved to assemblies/mta-intro

= The {ProductShortName} {WebName}


Expand Down
12 changes: 12 additions & 0 deletions docs/topics/mta-intro/con_mta-cli.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// Module included in the following assemblies:
//
// * docs/cli-guide/master.adoc
// * docs/getting-started-guide/master.adoc

:_content-type: CONCEPT
[id="about-cli_{context}"]
= The {ProductShortName} command-line interface

The {ProductShortName} CLI 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 {ProductShortName} CLI includes a wide array of customization options. By using the CLI, you can tune {ProductShortName} analysis options or integrate with external automation tools.

For more information about using the {ProductShortName} command-line interface, see link:https://docs.redhat.com/en/documentation/migration_toolkit_for_applications/7.2/html/cli_guide/index[CLI Guide].
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
// * docs/getting-started-guide/master.adoc

:_content-type: CONCEPT
[id="new-mta-features_{context}"]
[id="mta-features_{context}"]
= The {ProductShortName} features

{ProductFullName} provides the following features to simplify upgrades with more migration paths:

* *New application inventory and assessment modules* to assist organizations in managing, classifying, and tagging their applications while assessing application suitability for deployment in containers, including flagging potential risks for migration strategies.
* *Application inventory and assessment modules* to assist organizations in managing, classifying, and tagging their applications while assessing application suitability for deployment in containers, including flagging potential risks for migration strategies.

* *Full integration with source code and binary repositories* to automate the retrieval of applications for analysis along with proxy integration, including HTTP and HTTPS proxy configuration managed in the user interface.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,11 @@ You can use these add-on to perform the following tasks:
* Mark issues in the source code.
* Fix the issues by using the provided guidance.
* Use the automatic code replacement, if possible.


[role="_additional-resources"]
.Additional resources

* link:https://docs.redhat.com/en/documentation/migration_toolkit_for_applications/7.2/html/eclipse_plugin_guide/index[Eclipse Plugin Guide]
* link:https://docs.redhat.com/en/documentation/migration_toolkit_for_applications/7.2/html/visual_studio_code_extension_guide/index[Visual Studio Code Extension Guide]
* link:https://docs.redhat.com/en/documentation/migration_toolkit_for_applications/7.2/html/intellij_idea_plugin_guide/index[IntelliJ IDEA Plugin Guide]
21 changes: 21 additions & 0 deletions docs/topics/mta-intro/con_mta-installation-prerequisites.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
:_newdoc-version: 2.18.3
:_template-generated: 2025-04-16

:_mod-docs-content-type: CONCEPT

[id="mta-installation-prerequisites_{context}"]
= Prerequisites for the {ProductName} installation

The following are the prerequisites for the {ProductFullName} installation:

* Java Development Kit (JDK) is installed. {ProductShortName} supports the following JDKs:

** OpenJDK 11
** OpenJDK 17
** Oracle JDK 11
** Oracle JDK 17
** Eclipse Temurin™ JDK 11
** Eclipse Temurin™ JDK 17

* 8 GB RAM
* macOS installation: the value of `maxproc` must be `2048` or greater.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// * docs/getting-started-guide/master.adoc

:_content-type: CONCEPT
[id="migration-paths_{context}"]
[id="mta-migration-paths_{context}"]
= Supported {ProductName} migration paths

The {ProductName} ({ProductShortName}) supports the following migrations:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
// * docs/getting-started-guide/master.adoc

:_content-type: CONCEPT
[id="about-rules_{context}"]
[id="mta-rules_{context}"]
= The {ProductShortName} rules

The {ProductFullName} contains rule-based migration tools (analyzers) that you can use to analyze the application user interfaces (APIs), technologies, and architectures used by the applications you plan to migrate. {ProductShortName} analyzer rules use the following rule pattern:
Expand Down
14 changes: 14 additions & 0 deletions docs/topics/mta-intro/con_mta-user-interface.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
:_newdoc-version: 2.18.3
:_template-generated: 2025-04-16

:_mod-docs-content-type: CONCEPT

[id="mta-user-interface_{context}"]
= The {ProductShortName} user interface

By using the user interface (UI) for {ProductFullName}, you can perform the following tasks:

* Assess the risks involved in containerizing an application for hybrid cloud environments on Red Hat OpenShift.
* Analyze the changes that must be made in the code of an application to containerize the application.

For more information about the {ProductShortName} user interface, see link:https://docs.redhat.com/en/documentation/migration_toolkit_for_applications/7.2/html/user_interface_guide/index[User Interface Guide].
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
// * docs/wgetting-started-guide/master.adoc

:_content-type: CONCEPT
[id="about-the-mta-operator_{context}"]
[id="the-mta-operator_{context}"]
= The {ProductShortName} Operator

By using the {ProductName} Operator, you can install the {WebName} on OpenShift Container Platform versions {ocp-supported}.

For more information about the prerequisites for the {ProductShortName} Operator installation, see link:https://access.redhat.com/support/policy/updates/openshift_operators[OpenShift Operator Life Cycles].

For more information about installing the {ProductShortName} Operator, see link:https://docs.redhat.com/en/documentation/migration_toolkit_for_applications/7.2/html/user_interface_guide/mta-7-installing-web-console-on-openshift_user-interface-guide#installing-mta-operator-and-ui_user-interface-guide[Installing the Migration Toolkit for Applications Operator and the user interface].
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
// * docs/maven-guide/master.adoc

:_content-type: CONCEPT
[id="get-involved_{context}"]
= Contributing to the project
[id="contributing-to-mta-development_{context}"]
[appendix,id="contributing-to-mta-development"]
= Contributing to the {ProductShortName} project

To help the {ProductName} cover most application constructs and server configurations, including yours, you can help with any of the following items:

Expand All @@ -14,7 +15,7 @@ To help the {ProductName} cover most application constructs and server configura
* Identify application components and problem areas that might be difficult to migrate:
** Write a short description of the problem migration areas.
** Write a brief overview describing how to solve the problem in migration areas.
* Try {ProductName} on your application. Make sure to report any issues you meet.
* Try {ProductName} on your application. Make sure to report any issues you meet.{ProductShortName} uses Jira as its issue tracking system. If you encounter an issue executing {ProductShortName}, submit a link:{JiraWindupURL}[Jira issue].
* Contribute to the {ProductName} rules repository:
** Write a {ProductName} rule to identify or automate a migration process.
** Create a test for the new rule.
Expand All @@ -25,4 +26,12 @@ For more information, see link:{ProductDocRulesGuideURL}[_{RulesDevBookName}_].
** Create a core rule.
** Improve {ProductShortName} performance or efficiency.


[role="_additional-resources"]
.Additional resources

* link:https://developer.jboss.org/en/windup[{ProductShortName} forums]
* link:https://issues.redhat.com/projects/MTA/issues/MTA-4961?filter=allopenissues[Jira issues tracker]


Any level of involvement is greatly appreciated!