Skip to content

Commit

Permalink
Adding new procedures to the Eclipse doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mpershina committed Sep 24, 2024
1 parent 12f9122 commit 6e44aea
Show file tree
Hide file tree
Showing 5 changed files with 185 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/eclipse-code-ready-studio-guide/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
include::topics/templates/document-attributes.adoc[]
:_content-type: ASSEMBLY
[id="eclipse-code-ready-studio-guide"]
= Eclipse Plugin Guide
= Eclipse Plugin Guide

//Inclusive language statement
include::topics/making-open-source-more-inclusive.adoc[]
Expand All @@ -27,6 +27,12 @@ include::topics/mta-what-is-the-toolkit.adoc[leveloffset=+2]

You can install the {PluginName} in a connected or a restricted network environment.

include::topics/installing-java-development-kit.adoc[leveloffset=+2]

include::topics/installing-eclipse.adoc[leveloffset=+2]

include::topics/adding-jboss-tools-dependencies-for-the-mta-plug-in.adoc[leveloffset=+2]

include::topics/eclipse-installing-plugin.adoc[leveloffset=+2]
:!eclipse-code-ready-studio-guide:
:context: disconnected
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
:_newdoc-version: 2.18.3
:_template-generated: 2024-09-24
:_mod-docs-content-type: PROCEDURE

[id="adding-jboss-tools-dependencies-for-the-mta-plug-in_{context}"]
= Adding Jboss Tools dependencies for the MTA plug-in

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.
5 changes: 5 additions & 0 deletions docs/topics/eclipse-installing-plugin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ 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]
Expand Down
68 changes: 68 additions & 0 deletions docs/topics/installing-eclipse.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
:_newdoc-version: 2.18.3
:_template-generated: 2024-09-24
:_mod-docs-content-type: PROCEDURE

[id="installing-eclipse_{context}"]
= Installing Eclipse

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 <file_name>.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
----
80 changes: 80 additions & 0 deletions docs/topics/installing-java-development-kit.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
:_newdoc-version: 2.18.3
:_template-generated: 2024-09-24
:_mod-docs-content-type: PROCEDURE

[id="installing-java-development-kit_{context}"]
= Installing Java Development Kit

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/<jdk-file>
----

. Extract the `tar.gz` file:
+
[source,terminal,subs="attributes+"]
----
$ tar -xzf <jdk-file>
----

. Optional: To make JDK available system-wide, move the extracted folder to the `/opt` directory:
+
[source,terminal,subs="attributes+"]
----
$ sudo mv <jdk-extracted-folder> /opt/<jdk-file>
----

. 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/<jdk-file>
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
----

0 comments on commit 6e44aea

Please sign in to comment.