Skip to content

Commit 6340026

Browse files
mpershinampershina
committed
Adding new procedures from MTA-3533
1 parent 24a9b77 commit 6340026

File tree

5 files changed

+182
-1
lines changed

5 files changed

+182
-1
lines changed

‎docs/eclipse-code-ready-studio-guide/master.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ include::topics/mta-what-is-the-toolkit.adoc[leveloffset=+2]
2727

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

30+
include::topics/installing-java-development-kit.adoc[leveloffset=+2]
31+
32+
include::topics/installing-eclipse.adoc[leveloffset=+2]
33+
34+
include::topics/adding-jboss-tools-dependencies-for-the-mta-plug-in.adoc[leveloffset=+2]
35+
36+
3037
include::topics/eclipse-installing-plugin.adoc[leveloffset=+2]
3138
:!eclipse-code-ready-studio-guide:
3239
:context: disconnected

‎docs/topics/adding-jboss-tools-dependencies-for-the-mta-plug-in.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2024-08-29
3+
:_mod-docs-content-type: PROCEDURE
4+
5+
[id="adding-jboss-tools-dependencies-for-the-mta-plug-in_{context}"]
6+
= Adding Jboss Tools dependencies for the {ProductShortName} plug-in
7+
8+
JBoss Tools dependencies are required by Eclipse during the {ProductFullName} plug-in installation process.
9+
10+
.Prerequisites
11+
12+
* 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:
13+
14+
* OpenJDK 11
15+
* OpenJDK 17
16+
* Oracle JDK 11
17+
* Oracle JDK 17
18+
* Eclipse Temurin™ JDK 11
19+
* Eclipse Temurin™ JDK 17
20+
21+
.Procedure
22+
23+
. Launch Eclipse.
24+
. From the menu bar, select *Help Install New Software*.
25+
. Add the JBoss Tools update website by specifying the `\https://download.jboss.org/jbosstools/photon/development/updates/` location.
26+

‎docs/topics/eclipse-installing-plugin.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,16 @@
99

1010
You need a connected environment to install the {PluginName}.
1111

12-
The {PluginName} has been tested with the Eclipse IDE for Java Enterprise Developers 2023-03.
12+
The {PluginName} has been tested with the Eclipse integrated development environment (IDE) for Java Enterprise Developers 2023-03.
1313

1414
.Prerequisites
1515

1616
include::snippet_jdk-hardware-mac-prerequisites.adoc[leveloffset=0]
1717

1818
* link:https://www.eclipse.org/downloads/packages/release/2023-03/r/eclipse-ide-java-developers[Eclipse IDE for Java Enterprise Developers 2023-03]
1919
* JBoss Tools, installed from the link:https://marketplace.eclipse.org/content/jboss-tools[Eclipse Marketplace]
20+
+
21+
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 MTA plug-in].
2022
* link:http://download.eclipse.org/mylyn/releases/latest[Mylyn SDK and frameworks], installed with Eclipse
2123

2224
[NOTE]

‎docs/topics/installing-eclipse.adoc

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2024-08-29
3+
:_mod-docs-content-type: PROCEDURE
4+
5+
[id="installing-eclipse_{context}"]
6+
= Installing Eclipse
7+
8+
Eclipse is an integrated development environment (IDE) that you can use to install the {ProductFullName} play-in used for migrating and modernizing applications.
9+
10+
.Prerequisites
11+
12+
* 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:
13+
14+
** OpenJDK 11
15+
** OpenJDK 17
16+
** Oracle JDK 11
17+
** Oracle JDK 17
18+
** Eclipse Temurin™ JDK 11
19+
** Eclipse Temurin™ JDK 17
20+
21+
.Procedure
22+
23+
. 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*.
24+
. Extract the `tar.gz` file:
25+
+
26+
[source,terminal,subs="attributes+"]
27+
----
28+
$ tar -xzf <file_name>.tar.gz
29+
----
30+
31+
. Optional: To make Eclipse available system-wide, move the extracted folder to the `/opt` directory:
32+
+
33+
[source,terminal,subs="attributes+"]
34+
----
35+
$ sudo mv eclipse /opt/eclipse
36+
----
37+
38+
. Optional: To make Eclipse launch from the command line, create a symbolic link to the executable:
39+
+
40+
[source,terminal,subs="attributes+"]
41+
----
42+
$ sudo ln -s /opt/eclipse/eclipse /usr/bin/eclipse
43+
----
44+
45+
. Optional: To launch Eclipse from you application menu, create a desktop entry:
46+
47+
.. Create a new `eclipse.desktop` file:
48+
+
49+
[source,terminal,subs="attributes+"]
50+
----
51+
sudo nano /usr/share/applications/eclipse.desktop
52+
----
53+
54+
.. Add the following content to the `eclipse.desktop` file:
55+
+
56+
[source,terminal,subs="attributes+"]
57+
----
58+
[Desktop Entry]
59+
Name=Eclipse IDE 2024-03
60+
Type=Application
61+
Exec=/opt/eclipse/eclipse
62+
Terminal=false
63+
Icon=/opt/eclipse/icon.xpm
64+
Comment=Intergrated DEvelopment Environment
65+
NoDisplay=false
66+
Categories=Development;IDE;
67+
Name[en]=Eclipse IDE 2024-03
68+
----

‎docs/topics/installing-java-development-kit.adoc

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2024-08-29
3+
:_mod-docs-content-type: PROCEDURE
4+
5+
[id="installing-java-development-kit_{context}"]
6+
= Installing Java Development Kit
7+
8+
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:
9+
10+
* OpenJDK 11
11+
* OpenJDK 17
12+
* Oracle JDK 11
13+
* Oracle JDK 17
14+
* Eclipse Temurin™ JDK 11
15+
* Eclipse Temurin™ JDK 17
16+
17+
.Procedure
18+
19+
. 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.
20+
+
21+
Note that you need to accept the Oracle license agreement to proceed.
22+
+
23+
Alternatively, you can download JDK by using the command-line interface:
24+
+
25+
[source,terminal,subs="attributes+"]
26+
----
27+
$ wget https://download.oracle.com/java/11/latest/<jdk-file>
28+
----
29+
30+
. Extract the `tar.gz` file:
31+
+
32+
[source,terminal,subs="attributes+"]
33+
----
34+
$ tar -xzf <jdk-file>
35+
----
36+
37+
. Optional: To make JDK available system-wide, move the extracted folder to the `/opt` directory:
38+
+
39+
[source,terminal,subs="attributes+"]
40+
----
41+
$ sudo mv <jdk-extracted-folder> /opt/<jdk-file>
42+
----
43+
44+
. Set up the `JAVA_HOME` environment variable and add the JDK `bin` directory to the `PATH` variable:
45+
46+
.. Open the `.bashrc` file:
47+
+
48+
[source,terminal,subs="attributes+"]
49+
----
50+
$ nano ~/.bashrc
51+
----
52+
53+
.. Add the following lines to the file:
54+
+
55+
[source,terminal,subs="attributes+"]
56+
----
57+
export JAVA_HOME=/opt/<jdk-file>
58+
export PATH=$PATH:$JAVA_HOME/bin
59+
----
60+
61+
.. Save the file and close it.
62+
.. To apply the new changes, reload the file:
63+
+
64+
[source,terminal,subs="attributes+"]
65+
----
66+
$ source ~/.bashrc
67+
----
68+
69+
70+
.Verification
71+
72+
* Use the `java --version` command to verify the installed JDK version:
73+
+
74+
[source,terminal,subs="attributes+"]
75+
----
76+
$ java --version
77+
----
78+

0 commit comments

Comments
 (0)