diff --git a/docs/eclipse-code-ready-studio-guide/master.adoc b/docs/eclipse-code-ready-studio-guide/master.adoc index 1e1a3cf8..6bd0d18e 100644 --- a/docs/eclipse-code-ready-studio-guide/master.adoc +++ b/docs/eclipse-code-ready-studio-guide/master.adoc @@ -9,7 +9,7 @@ :IDEName: Eclipse :mta: include::topics/templates/document-attributes.adoc[] -:_content-type: ASSEMBLY +:_mod-content-type: ASSEMBLY [id="eclipse-code-ready-studio-guide"] = Eclipse Plugin Guide @@ -19,34 +19,34 @@ include::topics/making-open-source-more-inclusive.adoc[] [id="introduction_{context}"] == Introduction -include::topics/about-ide-addons.adoc[leveloffset=+2] -include::topics/mta-what-is-the-toolkit.adoc[leveloffset=+2] +include::topics/mta-eclipse-plugin/about-ide-addons-eclipse.adoc[leveloffset=+2] +include::topics/mta-eclipse-plugin/what-is-the-toolkit-eclipse.adoc[leveloffset=+2] [id="installing-plugin_{context}"] == Installing the {PluginName} You can install the {PluginName} in a connected or a restricted network environment. -include::topics/installing-java-development-kit.adoc[leveloffset=+2] +include::topics/mta-eclipse-plugin/installing-java-development-kit-eclipse.adoc[leveloffset=+2] -include::topics/installing-eclipse.adoc[leveloffset=+2] +include::topics/mta-eclipse-plugin/installing-eclipse-new.adoc[leveloffset=+2] -include::topics/adding-jboss-tools-dependencies-for-the-mta-plug-in.adoc[leveloffset=+2] +include::topics/mta-eclipse-plugin/adding-jboss-tools-dependencies-for-the-mta-plug-in-eclipse.adoc[leveloffset=+2] -include::topics/eclipse-installing-plugin.adoc[leveloffset=+2] +include::topics/mta-eclipse-plugin/eclipse-installing-plugin-eclipse.adoc[leveloffset=+2] -include::topics/eclipse-accessing-tools.adoc[leveloffset=+2] +include::topics/mta-eclipse-plugin/eclipse-accessing-tools-eclipse.adoc[leveloffset=+2] [id="analyzing-projects-with-plugin_{context}"] == Analyzing your projects with the {PluginName} You can analyze your projects with the {PluginName} by creating a run configuration, running an analysis, and then reviewing and resolving migration issues detected by the {PluginName}. -include::topics/eclipse-configuring-run.adoc[leveloffset=+2] -include::topics/eclipse-analyzing-projects.adoc[leveloffset=+2] -include::topics/eclipse-reviewing-issues.adoc[leveloffset=+2] -include::topics/eclipse-resolving-issues.adoc[leveloffset=+2] +include::topics/mta-eclipse-plugin/eclipse-configuring-run-eclipse.adoc[leveloffset=+2] +include::topics/mta-eclipse-plugin/eclipse-analyzing-projects-eclipse.adoc[leveloffset=+2] +include::topics/mta-eclipse-plugin/eclipse-reviewing-issues-eclipse.adoc[leveloffset=+2] +include::topics/mta-eclipse-plugin/eclipse-resolving-issues-eclipse.adoc[leveloffset=+2] // TODO: Uncomment when uninstalling works and this is ready // include::topics/plugin-uninstall.adoc[leveloffset=+1] @@ -54,11 +54,13 @@ include::topics/eclipse-resolving-issues.adoc[leveloffset=+2] [id="managing-rules_{context}"] == Managing rules -The {PluginName} comes with a core set of *System* rules for analyzing projects and identifying migration and modernization issues. +The {PluginName} includes a core set of *System* rules for analyzing projects and identifying migration and modernization issues. You can create and import custom rulesets. -include::topics/eclipse-viewing-rules.adoc[leveloffset=+2] -include::topics/eclipse-creating-custom-ruleset.adoc[leveloffset=+2] -include::topics/eclipse-importing-custom-ruleset.adoc[leveloffset=+2] -include::topics/eclipse-submitting-ruleset.adoc[leveloffset=+2] +include::topics/mta-eclipse-plugin/eclipse-viewing-rules-eclipse.adoc[leveloffset=+2] +include::topics/mta-eclipse-plugin/eclipse-creating-custom-ruleset-eclipse.adoc[leveloffset=+2] +include::topics/mta-eclipse-plugin/eclipse-importing-custom-ruleset-eclipse.adoc[leveloffset=+2] +include::topics/mta-eclipse-plugin/eclipse-submitting-ruleset-eclipse.adoc[leveloffset=+2] + +:!eclipse-code-ready-studio-guide: \ No newline at end of file diff --git a/docs/topics/mta-eclipse-plugin/about-ide-addons-eclipse.adoc b/docs/topics/mta-eclipse-plugin/about-ide-addons-eclipse.adoc new file mode 100644 index 00000000..5db54b6a --- /dev/null +++ b/docs/topics/mta-eclipse-plugin/about-ide-addons-eclipse.adoc @@ -0,0 +1,22 @@ +// Module included in the following assemblies: +// +// * docs/vs-code-extension-guide/master.adoc +// * docs/intellij-idea-plugin-guide/master.adoc +// * docs/eclipse-code-ready-guide/master.adoc + +:_mod-docs-content-type: CONCEPT +[id="about-ide-addons_{context}"] += About the {ProductShortName} {AddonType} for {IDEName} + +[role="_abstract"] +You can migrate and modernize applications by using the {ProductName} ({ProductShortName}) {AddonType} for {IDEName}. + +The {ProductShortName} {AddonType} analyzes your projects using customizable rulesets, marks issues in the source code, provides guidance to fix the issues, and offers automatic code replacement, if possible. + +ifdef::vsc-extension-guide[] +The {ProductShortName} extension is also compatible with Visual Studio Codespaces, the Microsoft cloud-hosted development environment. +endif::[] + +ifdef::idea-plugin-guide[] +The {AddonType} supports both the Community Edition and the Ultimate version of {IDEName}. +endif::[] diff --git a/docs/topics/mta-eclipse-plugin/adding-jboss-tools-dependencies-for-the-mta-plug-in-eclipse.adoc b/docs/topics/mta-eclipse-plugin/adding-jboss-tools-dependencies-for-the-mta-plug-in-eclipse.adoc new file mode 100644 index 00000000..df7c86cd --- /dev/null +++ b/docs/topics/mta-eclipse-plugin/adding-jboss-tools-dependencies-for-the-mta-plug-in-eclipse.adoc @@ -0,0 +1,27 @@ +:_newdoc-version: 2.18.3 +:_template-generated: 2024-08-29 +:_mod-docs-content-type: PROCEDURE + +[id="adding-jboss-tools-dependencies-for-the-mta-plug-in_{context}"] += Adding JBoss Tools dependencies for the {ProductShortName} plug-in + +[role="_abstract"] +JBoss Tools dependencies are required by Eclipse during the {ProductFullName} plug-in installation process. + +.Prerequisites + +* You have the Java Development Kit (JDK) installed on your system. For more information, see xref:installing-java-development-kit_eclipse-code-ready-studio-guide[Installing Java Development Kit]. {ProductShortName} supports the following JDKs: + +* OpenJDK 11 +* OpenJDK 17 +* Oracle JDK 11 +* Oracle JDK 17 +* Eclipse Temurin™ JDK 11 +* Eclipse Temurin™ JDK 17 + +.Procedure + +. Launch Eclipse. +. From the menu bar, select *Help Install New Software*. +. Add the JBoss Tools update website by specifying the `\https://download.jboss.org/jbosstools/photon/development/updates/` location. + diff --git a/docs/topics/mta-eclipse-plugin/eclipse-accessing-tools-eclipse.adoc b/docs/topics/mta-eclipse-plugin/eclipse-accessing-tools-eclipse.adoc new file mode 100644 index 00000000..bfb5d70a --- /dev/null +++ b/docs/topics/mta-eclipse-plugin/eclipse-accessing-tools-eclipse.adoc @@ -0,0 +1,34 @@ +// Module included in the following assemblies: +// +// * docs/eclipse-code-ready-studio-guide/master.adoc + +:_content-type: PROCEDURE +[id="eclipse-accessing-tools_{context}"] += Accessing the {ProductShortName} tools + +[role="_abstract"] +You can access the {PluginName} tools in the *{ProductShortName}* perspective. + +.Prerequisites + +* You must restart the Eclipse IDE after installing the {PluginName}. + +.Procedure + +. Click *Window* -> *Perspective* -> *Open Perspective* -> *Other*. +. Select *{ProductShortName}* and click *OK*. ++ +The following components are displayed: + +* *Issue Explorer* displays the migration issues identified by the {PluginName}. +* *{ProductShortName} Server* is a separate process that analyzes projects, flags migration issues, and generates reports. ++ +You can start, stop, and view the status of the {ProductShortName} server in the *Issue Explorer*. + +* *Issue Details* displays detailed information about a selected issue, including the hint, severity, and any additional resources. +* *{ProductShortName} Report* is an HTML report generated by the {PluginName}. From the report landing page you can navigate to detailed reports, such as Application Details, Issues, and Dependencies. ++ +[NOTE] +==== +The report is not generated by default. You must select the *Generate Report* option in the run configuration. +==== diff --git a/docs/topics/mta-eclipse-plugin/eclipse-analyzing-projects-eclipse.adoc b/docs/topics/mta-eclipse-plugin/eclipse-analyzing-projects-eclipse.adoc new file mode 100644 index 00000000..02ebabef --- /dev/null +++ b/docs/topics/mta-eclipse-plugin/eclipse-analyzing-projects-eclipse.adoc @@ -0,0 +1,18 @@ +// Module included in the following assemblies: +// +// * docs/eclipse-code-ready-studio-guide/master.adoc + +:_content-type: PROCEDURE +[id="eclipse-analyzing-projects_{context}"] += Analyzing projects + +[role="_abstract"] +You can analyze your projects by running the {PluginName} with a saved run configuration. + +.Procedure + +. In the *{ProductShortName}* perspective, click the *Run* button (image:run_exc.png[Run button]) and select a run configuration. ++ +The {PluginName} analyzes your projects. The *Issue Explorer* displays migration issues that are detected with the ruleset. + +. When you have finished analyzing your projects, stop the {ProductShortName} server in the *Issue Explorer* to conserve memory. diff --git a/docs/topics/mta-eclipse-plugin/eclipse-configuring-run-eclipse.adoc b/docs/topics/mta-eclipse-plugin/eclipse-configuring-run-eclipse.adoc new file mode 100644 index 00000000..ac042134 --- /dev/null +++ b/docs/topics/mta-eclipse-plugin/eclipse-configuring-run-eclipse.adoc @@ -0,0 +1,36 @@ +// Module included in the following assemblies: +// +// * docs/eclipse-code-ready-studio-guide/master.adoc + +:_content-type: PROCEDURE +[id="eclipse-configuring-run_{context}"] += Creating a run configuration + +[role="_abstract"] +You can create a run configuration in the *Issue Explorer*. A run configuration specifies the project to analyze, migration path, and additional options. + +You can create multiple run configurations. Each run configuration must have a unique name. + +.Prerequisite + +* You must import your projects into the Eclipse IDE. + +.Procedure + +. In the *Issue Explorer*, click the {ProductShortName} icon (image:Product_Icon-Migration_Toolkit-RGB.png[{ProductShortName} button]) to create a run configuration. +. On the *Input* tab, complete the following fields: +.. Select a migration path. +.. Beside the *Projects* field, click *Add* and select one or more projects. +.. Beside the *Packages* field, click *Add* and select one or more the packages. ++ +[NOTE] +==== +Specifying the packages for analysis reduces the run time. If you do not select any packages, all packages in the project are scanned. +==== + +. On the *Options* tab, you can select *Generate Report* to generate an HTML report. The report is displayed in the *Report* tab and saved as a file. ++ +Other options are displayed. See link:{ProductDocUserGuideURL}#cli-args_cli-guide[About {ProductShortName} command-line arguments] in the _{UserCLIBookName}_ for details. + +. On the *Rules* tab, you can select custom rulesets that you have imported or created for the {PluginName}. +. Click *Run* to start the analysis. diff --git a/docs/topics/eclipse-creating-custom-ruleset.adoc b/docs/topics/mta-eclipse-plugin/eclipse-creating-custom-ruleset-eclipse.adoc similarity index 98% rename from docs/topics/eclipse-creating-custom-ruleset.adoc rename to docs/topics/mta-eclipse-plugin/eclipse-creating-custom-ruleset-eclipse.adoc index acfae9d2..b0cb05f1 100644 --- a/docs/topics/eclipse-creating-custom-ruleset.adoc +++ b/docs/topics/mta-eclipse-plugin/eclipse-creating-custom-ruleset-eclipse.adoc @@ -6,6 +6,7 @@ [id="eclipse-creating-custom-ruleset_{context}"] = Creating a custom ruleset +[role="_abstract"] You can create a custom ruleset in the *{ProductShortName}* perspective. See the link:{ProductDocRulesGuideURL}[_{RulesDevBookName}_] to learn more about creating custom XML rules. diff --git a/docs/topics/mta-eclipse-plugin/eclipse-importing-custom-ruleset-eclipse.adoc b/docs/topics/mta-eclipse-plugin/eclipse-importing-custom-ruleset-eclipse.adoc new file mode 100644 index 00000000..3178ac00 --- /dev/null +++ b/docs/topics/mta-eclipse-plugin/eclipse-importing-custom-ruleset-eclipse.adoc @@ -0,0 +1,24 @@ +// Module included in the following assemblies: +// +// * docs/eclipse-code-ready-studio-guide/master.adoc + +:_content-type: PROCEDURE +[id="eclipse-importing-custom-ruleset_{context}"] += Importing a custom ruleset + +[role="_abstract"] +You can import a custom ruleset into the {PluginName} to analyze your projects. + +.Prerequisites + +* Custom ruleset file with a `.windup.xml` extension. ++ +See the link:{ProductDocRulesGuideURL}[_{RulesDevBookName}_] for information about creating rulesets. + +.Procedure + +. Click the *Rulesets* tab. +. Click the Import Ruleset icon (image:import-repository.png[Import ruleset icon]). +. Browse to and select the XML rule file to import. ++ +The custom ruleset is displayed when you expand *Custom* on the *Rulesets* tab. diff --git a/docs/topics/mta-eclipse-plugin/eclipse-installing-plugin-eclipse.adoc b/docs/topics/mta-eclipse-plugin/eclipse-installing-plugin-eclipse.adoc new file mode 100644 index 00000000..ef4c61be --- /dev/null +++ b/docs/topics/mta-eclipse-plugin/eclipse-installing-plugin-eclipse.adoc @@ -0,0 +1,56 @@ +// Module included in the following assemblies: +// +// * docs/eclipse-code-ready-studio-guide/master.adoc + +:_content-type: PROCEDURE + +[id="eclipse-installing-plugin_{context}"] += Installing in a connected environment + +[role="_abstract"] +You need a connected environment to install the {PluginName}. + +The {PluginName} has been tested with the Eclipse integrated development environment (IDE) for Java Enterprise Developers 2023-03. + +.Prerequisites + +include::snippet_jdk-hardware-mac-prerequisites-eclipse.adoc[leveloffset=0] + +* link:https://www.eclipse.org/downloads/packages/release/2023-03/r/eclipse-ide-java-developers[Eclipse IDE for Java Enterprise Developers 2023-03] +* JBoss Tools, installed from the link:https://marketplace.eclipse.org/content/jboss-tools[Eclipse Marketplace] ++ +[IMPORTANT] +==== +You must also add JBoss Tools dependencies that are required by Eclipse during the {ProductShortName} plug-in installation process. For more information, see xref:adding-jboss-tools-dependencies-for-the-mta-plug-in_eclipse-code-ready-studio-guide[Adding JBoss Tools dependencies for the {ProductShortName} plug-in]. +==== +* link:http://download.eclipse.org/mylyn/releases/latest[Mylyn SDK and frameworks], installed with Eclipse + +[NOTE] +==== +Eclipse is pre-configured for Java 17, and the plugin operates directly with Java 17. + +You can also run the plugin with Java 11, which requires setting the JRE version to Java 11 when creating up a new Eclipse project or importing an existing one. See step 6 below. +==== + +.Procedure + +. Launch Eclipse. +. From the menu bar, select *Help* -> *Install New Software*. +. Next to the *Work with* field, click *Add*. +. In the *Name* field, enter `{ProductShortName}`. +. In the *Location* field, enter +ifdef::mtr[] +`https://marketplace.eclipse.org/content/migration-toolkit-runtimes-mtr` and click *OK*. +endif::[] +ifdef::mta[] +`https://marketplace.eclipse.org/content/migration-toolkit-applications-mta` and click *OK*. +endif::[] +. Select the Java version to use. +** If using Java 11, in the *JRE* list, select *JavaSE 11*. +** If using Java 17, leave the *JRE* selection unchanged. + +[start=7] +. Select all the *JBoss Tools - {ProductShortName}* check boxes and click *Next*. +. Review the installation details and click *Next*. +. Accept the terms of the license agreement and click *Finish*. +. Restart Eclipse. diff --git a/docs/topics/mta-eclipse-plugin/eclipse-installing-plugin.adoc b/docs/topics/mta-eclipse-plugin/eclipse-installing-plugin.adoc new file mode 100644 index 00000000..7daa5d5d --- /dev/null +++ b/docs/topics/mta-eclipse-plugin/eclipse-installing-plugin.adoc @@ -0,0 +1,55 @@ +// Module included in the following assemblies: +// +// * docs/eclipse-code-ready-studio-guide/master.adoc + +:_content-type: PROCEDURE + +[id="eclipse-installing-plugin_{context}"] += Installing in a connected environment + +You need a connected environment to install the {PluginName}. + +The {PluginName} has been tested with the Eclipse integrated development environment (IDE) for Java Enterprise Developers 2023-03. + +.Prerequisites + +include::snippet_jdk-hardware-mac-prerequisites.adoc[leveloffset=0] + +* link:https://www.eclipse.org/downloads/packages/release/2023-03/r/eclipse-ide-java-developers[Eclipse IDE for Java Enterprise Developers 2023-03] +* JBoss Tools, installed from the link:https://marketplace.eclipse.org/content/jboss-tools[Eclipse Marketplace] ++ +[IMPORTANT] +==== +You must also add JBoss Tools dependencies that are required by Eclipse during the {ProductShortName} plug-in installation process. For more information, see xref:adding-jboss-tools-dependencies-for-the-mta-plug-in_eclipse-code-ready-studio-guide[Adding JBoss Tools dependencies for the {ProductShortName} plug-in]. +==== +* link:http://download.eclipse.org/mylyn/releases/latest[Mylyn SDK and frameworks], installed with Eclipse + +[NOTE] +==== +Eclipse is pre-configured for Java 17, and the plugin operates directly with Java 17. + +You can also run the plugin with Java 11, which requires setting the JRE version to Java 11 when creating up a new Eclipse project or importing an existing one. See step 6 below. +==== + +.Procedure + +. Launch Eclipse. +. From the menu bar, select *Help* -> *Install New Software*. +. Next to the *Work with* field, click *Add*. +. In the *Name* field, enter `{ProductShortName}`. +. In the *Location* field, enter +ifdef::mtr[] +`https://marketplace.eclipse.org/content/migration-toolkit-runtimes-mtr` and click *OK*. +endif::[] +ifdef::mta[] +`https://marketplace.eclipse.org/content/migration-toolkit-applications-mta` and click *OK*. +endif::[] +. Select the Java version to use. +** If using Java 11, in the *JRE* list, select *JavaSE 11*. +** If using Java 17, leave the *JRE* selection unchanged. + +[start=7] +. Select all the *JBoss Tools - {ProductShortName}* check boxes and click *Next*. +. Review the installation details and click *Next*. +. Accept the terms of the license agreement and click *Finish*. +. Restart Eclipse. diff --git a/docs/topics/mta-eclipse-plugin/eclipse-resolving-issues-eclipse.adoc b/docs/topics/mta-eclipse-plugin/eclipse-resolving-issues-eclipse.adoc new file mode 100644 index 00000000..51828767 --- /dev/null +++ b/docs/topics/mta-eclipse-plugin/eclipse-resolving-issues-eclipse.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * docs/eclipse-code-ready-studio-guide/master.adoc + +:_content-type: PROCEDURE +[id="eclipse-resolving-issues_{context}"] += Resolving issues + +[role="_abstract"] +You can resolve issues detected by the {PluginName} by performing one of the following actions: + +* You can double-click the issue to open it in an editor and edit the source code. ++ +The issue displays a Stale icon (image:stale_issue.gif[Stale]) until the next time you run the {PluginName}. +* You can right-click the issue and select *Mark as Fixed*. +* If the issue displays a Quick Fix icon (image:quickfix_error.png[Mandatory with quick fix] image:quickfix_info.png[Optional with quick fix] image:quickfix_warning.png[Warning with quick fix]), you can right-click the issue and select *Preview Quick Fix* and then *Apply Quick Fix*. diff --git a/docs/topics/mta-eclipse-plugin/eclipse-reviewing-issues-eclipse.adoc b/docs/topics/mta-eclipse-plugin/eclipse-reviewing-issues-eclipse.adoc new file mode 100644 index 00000000..54d1358f --- /dev/null +++ b/docs/topics/mta-eclipse-plugin/eclipse-reviewing-issues-eclipse.adoc @@ -0,0 +1,37 @@ +// Module included in the following assemblies: +// +// * docs/eclipse-code-ready-studio-guide/master.adoc + +:_content-type: PROCEDURE +[id="eclipse-reviewing-issues_{context}"] += Reviewing issues + +[role="_abstract"] +You can review issues identified by the {PluginName}. + +.Procedure + +. Click *Window* -> *Show View* -> *Issue Explorer*. +. Optional: Filter the issues by clicking the Options menu {kebab}, selecting *Group By* and an option. ++ +image::mta_group_by.png[Issue Explorer "Group By" options] + +. Right-click and select *Issue Details* to view information about the issue, including its severity and how to address it. ++ +The following icons indicate the severity and state of an issue: ++ +.Issue icons +[cols="20%a,80%",options="header",] +|==== +|Icon |Description +|image::error.png[Mandatory] |The issue must be fixed for a successful migration. +|image::info.gif[Optional] |The issue is optional to fix for migration. +|image::warning.png[Warning] |The issue might need to be addressed during migration. +|image::fixedIssue.gif[Resolved] |The issue was resolved. +|image::stale_issue.gif[Stale] |The issue is stale. The code marked as an issue was modified since the last time that {ProductShortName} identified it as an issue. +|image::quickfix_error.png[Mandatory with quick fix] |A quick fix is available for this issue, which is mandatory to fix for a successful migration. +|image::quickfix_info.png[Optional with quick fix] |A quick fix is available for this issue, which is optional to fix for migration. +|image::quickfix_warning.png[Warning with quick fix] |A quick fix is available for this issue, which may potentially be an issue during migration. +|==== + +. Double-click an issue to open the associated line of code in an editor. diff --git a/docs/topics/mta-eclipse-plugin/eclipse-submitting-ruleset-eclipse.adoc b/docs/topics/mta-eclipse-plugin/eclipse-submitting-ruleset-eclipse.adoc new file mode 100644 index 00000000..b0acdd62 --- /dev/null +++ b/docs/topics/mta-eclipse-plugin/eclipse-submitting-ruleset-eclipse.adoc @@ -0,0 +1,23 @@ +// Module included in the following assemblies: +// +// * docs/eclipse-code-ready-studio-guide/master.adoc + +:_content-type: PROCEDURE +[id="eclipse-submitting-ruleset_{context}"] += Submitting a custom ruleset + +[role="_abstract"] +You can submit your custom ruleset for inclusion in the official {ProductShortName} rule repository. This allows your custom rules to be reviewed and included in subsequent releases of {ProductShortName}. + +.Procedure + +. Click the *Rulesets* tab. +. Click the Arrow icon (image:plugin-dropdown.png[Dropdown]) and select *Submit Ruleset*. +. Complete the following fields: + +* *Summary*: Describe the purpose of the rule. This becomes the title of the submission. +* *Code Sample*: Enter an example of the source code that the rule should run against. +* *Description*: Enter a brief description of the rule. + +. Click *Choose Files* and select the ruleset file. +. Click *Submit*. diff --git a/docs/topics/mta-eclipse-plugin/eclipse-viewing-rules-eclipse.adoc b/docs/topics/mta-eclipse-plugin/eclipse-viewing-rules-eclipse.adoc new file mode 100644 index 00000000..6af0f18a --- /dev/null +++ b/docs/topics/mta-eclipse-plugin/eclipse-viewing-rules-eclipse.adoc @@ -0,0 +1,22 @@ +// Module included in the following assemblies: +// +// * docs/eclipse-code-ready-studio-guide/master.adoc + +:_content-type: PROCEDURE +[id="plugin-viewing-rules_{context}"] += Viewing rules + +[role="_abstract"] +You can view system and custom rules, if any, for the {PluginName}. + +.Prerequisites + +* To view system rules, the {ProductShortName} server must be running. + +.Procedure + +. Click the *Rulesets* tab. +. Expand *System* to view system rulesets or *Custom* to view custom rulesets. +. Expand a ruleset. +. Double-click a rule to open it in a viewer. +. Click the *Source* tab to view the XML source of the rule. diff --git a/docs/topics/mta-eclipse-plugin/installing-eclipse-new.adoc b/docs/topics/mta-eclipse-plugin/installing-eclipse-new.adoc new file mode 100644 index 00000000..2ef51116 --- /dev/null +++ b/docs/topics/mta-eclipse-plugin/installing-eclipse-new.adoc @@ -0,0 +1,69 @@ +:_newdoc-version: 2.18.3 +:_template-generated: 2024-08-29 +:_mod-docs-content-type: PROCEDURE + +[id="installing-eclipse_{context}"] += Installing Eclipse + +[role="_abstract"] +Eclipse is an integrated development environment (IDE) that you can use to install the {ProductFullName} plug-in used for migrating and modernizing applications. + +.Prerequisites + +* You have the Java Development Kit (JDK) installed on your system. For more information, see xref:installing-java-development-kit_eclipse-code-ready-studio-guide[Installing Java Development Kit]. {ProductShortName} supports the following JDKs: + +** OpenJDK 11 +** OpenJDK 17 +** Oracle JDK 11 +** Oracle JDK 17 +** Eclipse Temurin™ JDK 11 +** Eclipse Temurin™ JDK 17 + +.Procedure + +. From the link:https://www.eclipse.org/downloads/packages/release/2024-03/r[Eclipse download page], download the required Eclipse IDE `tar.gz` file, for example, *Eclipse IDE for Java Developers*. +. Extract the `tar.gz` file: ++ +[source,terminal,subs="attributes+"] +---- +$ tar -xzf .tar.gz +---- + +. Optional: To make Eclipse available system-wide, move the extracted folder to the `/opt` directory: ++ +[source,terminal,subs="attributes+"] +---- +$ sudo mv eclipse /opt/eclipse +---- + +. Optional: To make Eclipse launch from the command line, create a symbolic link to the executable: ++ +[source,terminal,subs="attributes+"] +---- +$ sudo ln -s /opt/eclipse/eclipse /usr/bin/eclipse +---- + +. Optional: To launch Eclipse from you application menu, create a desktop entry: + +.. Create a new `eclipse.desktop` file: ++ +[source,terminal,subs="attributes+"] +---- +sudo nano /usr/share/applications/eclipse.desktop +---- + +.. Add the following content to the `eclipse.desktop` file: ++ +[source,terminal,subs="attributes+"] +---- +[Desktop Entry] +Name=Eclipse IDE 2024-03 +Type=Application +Exec=/opt/eclipse/eclipse +Terminal=false +Icon=/opt/eclipse/icon.xpm +Comment=Intergrated DEvelopment Environment +NoDisplay=false +Categories=Development;IDE; +Name[en]=Eclipse IDE 2024-03 +---- \ No newline at end of file diff --git a/docs/topics/mta-eclipse-plugin/installing-java-development-kit-eclipse.adoc b/docs/topics/mta-eclipse-plugin/installing-java-development-kit-eclipse.adoc new file mode 100644 index 00000000..f2178322 --- /dev/null +++ b/docs/topics/mta-eclipse-plugin/installing-java-development-kit-eclipse.adoc @@ -0,0 +1,82 @@ +:_newdoc-version: 2.18.3 +:_template-generated: 2024-08-29 +:_mod-docs-content-type: PROCEDURE + +[id="installing-java-development-kit_{context}"] += Installing Java Development Kit + +[role="_abstract"] +You must have the Java Development Kit (JDK) installed on your system prior to installing the Eclipse integrated development environment (IDE). {ProductFullName} supports the following JDKs: + +* OpenJDK 11 +* OpenJDK 17 +* Oracle JDK 11 +* Oracle JDK 17 +* Eclipse Temurin™ JDK 11 +* Eclipse Temurin™ JDK 17 + +.Procedure + +. From the link:https://www.oracle.com/java/technologies/downloads/#java11[Oracle JDK download page], download the JDK `tar.gz` file suitable for your system. ++ +[NOTE] +==== +You need to accept the Oracle license agreement to proceed. +==== ++ +Alternatively, you can download JDK by using the command-line interface: ++ +[source,terminal,subs="attributes+"] +---- +$ wget https://download.oracle.com/java/11/latest/ +---- + +. Extract the `tar.gz` file: ++ +[source,terminal,subs="attributes+"] +---- +$ tar -xzf +---- + +. Optional: To make JDK available system-wide, move the extracted folder to the `/opt` directory: ++ +[source,terminal,subs="attributes+"] +---- +$ sudo mv /opt/ +---- + +. Set up the `JAVA_HOME` environment variable and add the JDK `bin` directory to the `PATH` variable: + +.. Open the `.bashrc` file: ++ +[source,terminal,subs="attributes+"] +---- +$ nano ~/.bashrc +---- + +.. Add the following lines to the file: ++ +[source,terminal,subs="attributes+"] +---- +export JAVA_HOME=/opt/ +export PATH=$PATH:$JAVA_HOME/bin +---- + +.. Save the file and close it. +.. To apply the new changes, reload the file: ++ +[source,terminal,subs="attributes+"] +---- +$ source ~/.bashrc +---- + + +.Verification + +* Use the `java --version` command to verify the installed JDK version: ++ +[source,terminal,subs="attributes+"] +---- +$ java --version +---- + diff --git a/docs/topics/mta-eclipse-plugin/snippet_jdk-hardware-mac-prerequisites-eclipse.adoc b/docs/topics/mta-eclipse-plugin/snippet_jdk-hardware-mac-prerequisites-eclipse.adoc new file mode 100644 index 00000000..3fa128de --- /dev/null +++ b/docs/topics/mta-eclipse-plugin/snippet_jdk-hardware-mac-prerequisites-eclipse.adoc @@ -0,0 +1,13 @@ +:_mod-docs-content-type: SNIPPET + +The following are the prerequisites for the {ProductFullName} installation: + +* Java Development Kit (JDK) is installed. {ProductShortName} supports the following JDKs: + +** Oracle JDK 17 or later +** Eclipse Temurin™ JDK 17 or later +** OpenJDK 17 or later + +* 8 GB of RAM is required for {ProductShortName}. + +* macOS installation: the value of `maxproc` must be `2048` or greater. diff --git a/docs/topics/mta-eclipse-plugin/what-is-the-toolkit-eclipse.adoc b/docs/topics/mta-eclipse-plugin/what-is-the-toolkit-eclipse.adoc new file mode 100644 index 00000000..9f87dd41 --- /dev/null +++ b/docs/topics/mta-eclipse-plugin/what-is-the-toolkit-eclipse.adoc @@ -0,0 +1,48 @@ +// Module included in the following assemblies: +// +// * docs/getting-started-guide-mtr/master.adoc +// * docs/cli-guide-mtr/master.adoc +// * docs/intellij-idea-plugin-guide-mtr/master.adoc +// * docs/maven-guide-mtr/master.adoc +// * docs/eclipse-code-ready-studio-guide-mtr/master.adoc +// * docs/web-console-guide-mtr/master.adoc +// * docs/plugin-guide-mtr/master.adoc +:_mod-docs-content-type: CONCEPT + +[[about_mta]] +[id="what-is-the-toolkit_{context}"] += About the {ProductName} + +[role="_abstract"] +The {ProductName} ({ProductShortName}) is an extensible and customizable rule-based tool that simplifies the migration and modernization of Java applications. + +== What is the {ProductName}? + +The {ProductName} ({ProductShortName}) is an extensible and customizable rule-based tool that simplifies the migration and modernization of Java applications. + +{ProductShortName} examines application artifacts, including project source directories and application archives, and then produces an HTML report highlighting areas needing changes. {ProductShortName} supports many migration paths, including the following examples: + +* Upgrading to the latest release of Red Hat JBoss Enterprise Application Platform +* Migrating from Oracle WebLogic or IBM WebSphere Application Server to Red Hat JBoss Enterprise Application Platform +* Containerizing applications and making them cloud-ready +* Migrating from Java Spring Boot to Quarkus +* Updating from Oracle JDK to OpenJDK +* Upgrading from OpenJDK 8 to OpenJDK 11 +* Upgrading from OpenJDK 11 to OpenJDK 17 +* Upgrading from OpenJDK 17 to OpenJDK 21 +* Migrating EAP Java applications to Azure +* Migrating Spring Boot Java applications to Azure + +For more information about use cases and migration paths, see the link:https://developers.redhat.com/products/{LC_PSN}/use-cases[{ProductShortName} for developers] web page. + +== How does the {ProductName} simplify migration? + +The {ProductName} 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} generates a detailed report evaluating a migration or modernization path. This report can help you to estimate the effort required for large-scale projects and to reduce the work involved. + +ifndef::getting-started-guide[] +== How do I learn more? + +See the link:{ProductDocIntroToMTAGuideURL}[Introduction to the {DocInfoProductName}] to learn more about the features, supported configurations, system requirements, and available tools in the {ProductName}. +endif::getting-started-guide[]