Skip to content

Commit 1f455a0

Browse files
apinnickapinnick
committed
reorganized the installation procedures.
1 parent c83c012 commit 1f455a0

File tree

7 files changed

+165
-160
lines changed

7 files changed

+165
-160
lines changed

‎docs/cli-guide/master.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ include::topics/about-cli.adoc[leveloffset=+2]
2525
== Getting started
2626

2727
// Install the CLI
28-
include::topics/installing-web-console.adoc[leveloffset=+2]
28+
include::topics/installing-web-console-or-cli-tool.adoc[leveloffset=+2]
2929

3030
// Run the CLI
3131
include::topics/execute.adoc[leveloffset=+2]

‎docs/maven-guide/master.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ include::topics/about-maven.adoc[leveloffset=+2]
2727
== Getting started
2828

2929
// Installing the {MavenNameTitle}
30-
include::topics/installing-web-console.adoc[leveloffset=+2]
30+
include::topics/installing-plugin.adoc[leveloffset=+2]
3131

3232
// Run the {MavenNameTitle}
3333
include::topics/maven-run.adoc[leveloffset=+2]

‎docs/plugin-guide/master.adoc‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ include::topics/what-is-the-toolkit.adoc[leveloffset=+2]
2525
include::topics/about-plugin.adoc[leveloffset=+2]
2626

2727
// Install the IDE Plugin
28-
include::topics/installing-web-console.adoc[leveloffset=+1]
28+
include::topics/installing-plugin.adoc[leveloffset=+1]
2929
:!plugin-guide:
3030

31-
:context: plugin-guide-offline
32-
:plugin-guide-offline:
33-
include::topics/installing-web-console.adoc[leveloffset=+1]
34-
:!plugin-guide-offline:
31+
:context: disconnected
32+
:disconnected:
33+
include::topics/installing-plugin.adoc[leveloffset=+1]
34+
:!disconnected:
3535

3636
:plugin-guide:
3737
// Access the {ProductShortName} IDE Tools

‎docs/topics/installing-plugin.adoc‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/maven-guide/master.adoc
4+
// * docs/plugin-guide/master.adoc
5+
6+
ifdef::maven-guide[]
7+
[id="installing-maven-plugin_{context}"]
8+
= Installing the {MavenNameTitle}
9+
10+
You can install the {MavenName} in your local Maven repository.
11+
endif::[]
12+
ifdef::plugin-guide[]
13+
[id="installing-ide-plugin-connected-environment_{context}"]
14+
= Installing the {PluginName} in a connected environment
15+
16+
You can install the {PluginName} for Eclipse or Red Hat CodeReady Studio in a connected environment.
17+
18+
The {PluginName} has been tested with Eclipse 2020-09 and Red Hat CodeReady Studio 12.15.
19+
endif::[]
20+
ifdef::disconnected[]
21+
[id="installing-ide-plugin-disconnected-environment_{context}"]
22+
= Installing the {PluginName} in a disconnected environment
23+
24+
You can install the {PluginName} for Eclipse or Red Hat CodeReady Studio in a disconnected environment.
25+
26+
The {PluginName} has been tested with Eclipse 2020-09 and Red Hat CodeReady Studio 12.15.
27+
endif::[]
28+
29+
.Prerequisites
30+
31+
ifdef::maven-guide[]
32+
* OpenJDK 1.8, OpenJDK 11, Oracle JDK 1.8, _or_ Oracle JDK 11
33+
* 8 GB RAM
34+
* Maven 3.2.5 or later
35+
endif::[]
36+
ifdef::plugin-guide,disconnected[]
37+
* link:{CodeReadyStudioDownloadPageURL}[Red Hat CodeReady Studio] _or_ link:https://www.eclipse.org/downloads/packages/release/2020-09/r/eclipse-ide-enterprise-java-developers[Eclipse IDE for Java Enterprise Developers 2020-09 R]
38+
* JBoss Tools
39+
+
40+
You must install the Eclipse Marketplace Client, browse to JBoss Tools in the Client, and then install the JBoss Tools. For more information, navigate to link:https://www.eclipse.org/[Eclipse.org], click *More* -> *Documentation*, and select the *Eclipse Marketplace User Guide*.
41+
endif::[]
42+
* If you are installing on macOS, the value of `maxproc` must be `2048` or greater.
43+
44+
.Procedure
45+
46+
ifdef::maven-guide[]
47+
. Clone the {MavenName} Github repository:
48+
+
49+
----
50+
$ git clone https://github.com/windup/windup-maven-plugin.git
51+
----
52+
53+
. Navigate to the `windup-maven-plugin` directory.
54+
+
55+
----
56+
$ cd windup-maven-plugin
57+
----
58+
59+
. Build the project:
60+
+
61+
----
62+
$ mvn clean install
63+
----
64+
+
65+
The `windup-maven-plugin` jar is installed in your local Maven repository.
66+
endif::[]
67+
ifdef::disconnected[]
68+
. Navigate to the link:{MTADownloadPageURL}[Migration Toolkit for Applications download site] and download the `IDE Plugin Repository` file.
69+
endif::[]
70+
ifdef::plugin-guide,disconnected[]
71+
. Launch your IDE.
72+
. From the menu bar, select *Help* -> *Install New Software*.
73+
. Next to the *Work with* field, click *Add*.
74+
. In the *Name* field, enter `{ProductShortName}`.
75+
endif::[]
76+
ifdef::plugin-guide[]
77+
. In the *Location* field, enter `\http://download.jboss.org/jbosstools/photon/stable/updates/mta/` and click *OK*.
78+
endif::[]
79+
ifdef::disconnected[]
80+
. Next to the *Location* field, click *Archive*.
81+
. Select the IDE Plugin archive file and click *OK*.
82+
endif::[]
83+
ifdef::plugin-guide,disconnected[]
84+
. Select all the *JBoss Tools - MTA* check boxes and click *Next*.
85+
. Review the installation details and click *Next*.
86+
. Accept the terms of the license agreement and click *Finish* to install the plugin.
87+
. Restart your IDE for the changes to take effect.
88+
endif::[]

‎docs/topics/installing-web-console-or-cli-tool.adoc‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/cli-guide/master.adoc
4+
// * docs/web-console-guide/master.adoc
5+
6+
ifdef::cli-guide[]
7+
[id="installing-cli_{context}"]
8+
= Installing the {CLINameTitle}
9+
10+
You can install the {CLINameTitle} on Linux, Windows, or macOS operating systems.
11+
endif::[]
12+
ifdef::web-console-guide[]
13+
[id="installing-web-console-linux-win-mac_{context}"]
14+
= Installing the {WebName} on Linux, Windows, or macOS
15+
16+
You can install the {WebName} on Linux, Windows, or macOS operating systems and access the {WebName} in a browser.
17+
18+
The {WebName} has been tested with Chrome and Firefox.
19+
endif::[]
20+
21+
.Prerequisites
22+
23+
* OpenJDK 1.8, OpenJDK 11, Oracle JDK 1.8, _or_ Oracle JDK 11
24+
* 8 GB RAM
25+
* If you are installing on macOS, the value of `maxproc` must be `2048` or greater.
26+
27+
.Procedure
28+
29+
ifdef::cli-guide[]
30+
. Navigate to the link:{MTADownloadPageURL}[{ProductShortName} Download page] and download the `Migration Toolkit CLI` file.
31+
endif::[]
32+
ifdef::web-console-guide[]
33+
. Navigate to the link:{MTADownloadPageURL}[{ProductShortName} Download page] and download the {WebName} `Local install & OpenShift` file.
34+
endif::[]
35+
36+
. Extract the `.zip` file to a directory of your choice.
37+
+
38+
[NOTE]
39+
====
40+
If you are installing on a Windows operating system:
41+
42+
. Extract the `.zip` file to a folder named `mta` to avoid a `Path too long` error.
43+
. If a *Confirm file replace* window is displayed during extraction, click *Yes to all*.
44+
====
45+
+
46+
The installation directory is referred to as `<MTA_HOME>` in this guide.
47+
48+
ifdef::web-console-guide[]
49+
. Start the {WebName}:
50+
51+
* Linux operating system:
52+
+
53+
----
54+
$ <MTA_HOME>/run_mta.sh
55+
----
56+
57+
* Windows operating system:
58+
+
59+
----
60+
C:\<MTA_HOME>\run_mta.bat
61+
----
62+
63+
. Open a browser and navigate to `\http://localhost:8080/mta-web`. The {WebName} login page is displayed in your browser.
64+
+
65+
.Web console login page
66+
image::web-login-openshift.png[web console login page]
67+
+
68+
The default user is `mta` and the default password is `password`.
69+
endif::[]

‎docs/topics/installing-web-console.adoc‎

Lines changed: 0 additions & 152 deletions
This file was deleted.

‎docs/web-console-guide/master.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ include::topics/about-the-web-console.adoc[leveloffset=+2]
2929
You can install the {WebName} on Linux, Windows, macOS, or {ocp-full}.
3030

3131
// Installing on Linux, Windows, macOS
32-
include::topics/installing-web-console.adoc[leveloffset=+2]
32+
include::topics/installing-web-console-or-cli-tool.adoc[leveloffset=+2]
3333

3434
=== Installing the {WebName} on {ocp-short}
3535

0 commit comments

Comments
 (0)