diff --git a/assemblies/mta-intro/assembly_mta-tools.adoc b/assemblies/mta-intro/assembly_mta-tools.adoc new file mode 100644 index 00000000..60e2f25a --- /dev/null +++ b/assemblies/mta-intro/assembly_mta-tools.adoc @@ -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:] + diff --git a/assemblies/mta-intro/assembly_what-is-mta.adoc b/assemblies/mta-intro/assembly_what-is-mta.adoc new file mode 100644 index 00000000..98f154f8 --- /dev/null +++ b/assemblies/mta-intro/assembly_what-is-mta.adoc @@ -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:] + diff --git a/assemblies/mta-intro/topics b/assemblies/mta-intro/topics new file mode 120000 index 00000000..9c652798 --- /dev/null +++ b/assemblies/mta-intro/topics @@ -0,0 +1 @@ +../../topics/ \ No newline at end of file diff --git a/docs/getting-started-guide/master.adoc b/docs/getting-started-guide/master.adoc index f1857938..17ae8045 100644 --- a/docs/getting-started-guide/master.adoc +++ b/docs/getting-started-guide/master.adoc @@ -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[] diff --git a/docs/topics/about-cli.adoc b/docs/topics/about-cli.adoc deleted file mode 100644 index f51ef8ad..00000000 --- a/docs/topics/about-cli.adoc +++ /dev/null @@ -1,14 +0,0 @@ -// 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} {CLINameTitle} - -The {CLIName} 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 {CLIName} includes a wide array of customization options. By using the {CLIName}, you can tune {ProductShortName} analysis options or integrate with external automation tools. - -ifndef::cli-guide[] -For more information about using the {CLIName}, see link:{ProductDocUserGuideURL}[_{UserCLIBookName}_]. -endif::cli-guide[] diff --git a/docs/topics/about-the-web-console.adoc b/docs/topics/about-the-web-console.adoc index 080fab56..5e9bfecd 100644 --- a/docs/topics/about-the-web-console.adoc +++ b/docs/topics/about-the-web-console.adoc @@ -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}"] = The {ProductShortName} {WebName} diff --git a/docs/topics/mta-intro/con_mta-cli.adoc b/docs/topics/mta-intro/con_mta-cli.adoc new file mode 100644 index 00000000..390f0026 --- /dev/null +++ b/docs/topics/mta-intro/con_mta-cli.adoc @@ -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]. diff --git a/docs/topics/new-mta-features.adoc b/docs/topics/mta-intro/con_mta-features.adoc similarity index 84% rename from docs/topics/new-mta-features.adoc rename to docs/topics/mta-intro/con_mta-features.adoc index 167ceaf1..a20d70ea 100644 --- a/docs/topics/new-mta-features.adoc +++ b/docs/topics/mta-intro/con_mta-features.adoc @@ -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. diff --git a/docs/topics/getting-started-about-ide-addons.adoc b/docs/topics/mta-intro/con_mta-ide-addons.adoc similarity index 58% rename from docs/topics/getting-started-about-ide-addons.adoc rename to docs/topics/mta-intro/con_mta-ide-addons.adoc index 53680f04..0f7f7bac 100644 --- a/docs/topics/getting-started-about-ide-addons.adoc +++ b/docs/topics/mta-intro/con_mta-ide-addons.adoc @@ -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] diff --git a/docs/topics/mta-intro/con_mta-installation-prerequisites.adoc b/docs/topics/mta-intro/con_mta-installation-prerequisites.adoc new file mode 100644 index 00000000..9f24a127 --- /dev/null +++ b/docs/topics/mta-intro/con_mta-installation-prerequisites.adoc @@ -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. \ No newline at end of file diff --git a/docs/topics/migration-paths.adoc b/docs/topics/mta-intro/con_mta-migration-paths.adoc similarity index 98% rename from docs/topics/migration-paths.adoc rename to docs/topics/mta-intro/con_mta-migration-paths.adoc index 4737b885..c942666f 100644 --- a/docs/topics/migration-paths.adoc +++ b/docs/topics/mta-intro/con_mta-migration-paths.adoc @@ -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: diff --git a/docs/topics/about-rules.adoc b/docs/topics/mta-intro/con_mta-rules.adoc similarity index 97% rename from docs/topics/about-rules.adoc rename to docs/topics/mta-intro/con_mta-rules.adoc index cc9f7eeb..3f32ee8f 100644 --- a/docs/topics/about-rules.adoc +++ b/docs/topics/mta-intro/con_mta-rules.adoc @@ -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: diff --git a/docs/topics/mta-intro/con_mta-user-interface.adoc b/docs/topics/mta-intro/con_mta-user-interface.adoc new file mode 100644 index 00000000..9b29083a --- /dev/null +++ b/docs/topics/mta-intro/con_mta-user-interface.adoc @@ -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]. \ No newline at end of file diff --git a/docs/topics/about-the-mta-operator.adoc b/docs/topics/mta-intro/con_the-mta-operator.adoc similarity index 53% rename from docs/topics/about-the-mta-operator.adoc rename to docs/topics/mta-intro/con_the-mta-operator.adoc index 6992d186..1405501b 100644 --- a/docs/topics/about-the-mta-operator.adoc +++ b/docs/topics/mta-intro/con_the-mta-operator.adoc @@ -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]. \ No newline at end of file diff --git a/docs/topics/get-involved.adoc b/docs/topics/ref_contributing-to-mta-development.adoc similarity index 66% rename from docs/topics/get-involved.adoc rename to docs/topics/ref_contributing-to-mta-development.adoc index 23d9a170..98fbaa79 100644 --- a/docs/topics/get-involved.adoc +++ b/docs/topics/ref_contributing-to-mta-development.adoc @@ -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: @@ -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. @@ -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!