Skip to content
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
36 changes: 19 additions & 17 deletions docs/eclipse-code-ready-studio-guide/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -19,46 +19,48 @@ 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]

[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:
22 changes: 22 additions & 0 deletions docs/topics/mta-eclipse-plugin/about-ide-addons-eclipse.adoc
Original file line number Diff line number Diff line change
@@ -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::[]
Original file line number Diff line number Diff line change
@@ -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.

Original file line number Diff line number Diff line change
@@ -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.
====
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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.
55 changes: 55 additions & 0 deletions docs/topics/mta-eclipse-plugin/eclipse-installing-plugin.adoc
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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*.
Loading
Loading