Skip to content

Commit

Permalink
reorganized the installation procedures.
Browse files Browse the repository at this point in the history
  • Loading branch information
apinnick committed Apr 14, 2021
1 parent c83c012 commit 1f455a0
Show file tree
Hide file tree
Showing 7 changed files with 165 additions and 160 deletions.
2 changes: 1 addition & 1 deletion docs/cli-guide/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ include::topics/about-cli.adoc[leveloffset=+2]
== Getting started

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

// Run the CLI
include::topics/execute.adoc[leveloffset=+2]
Expand Down
2 changes: 1 addition & 1 deletion docs/maven-guide/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ include::topics/about-maven.adoc[leveloffset=+2]
== Getting started

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

// Run the {MavenNameTitle}
include::topics/maven-run.adoc[leveloffset=+2]
Expand Down
10 changes: 5 additions & 5 deletions docs/plugin-guide/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ include::topics/what-is-the-toolkit.adoc[leveloffset=+2]
include::topics/about-plugin.adoc[leveloffset=+2]

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

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

:plugin-guide:
// Access the {ProductShortName} IDE Tools
Expand Down
88 changes: 88 additions & 0 deletions docs/topics/installing-plugin.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
// Module included in the following assemblies:
//
// * docs/maven-guide/master.adoc
// * docs/plugin-guide/master.adoc

ifdef::maven-guide[]
[id="installing-maven-plugin_{context}"]
= Installing the {MavenNameTitle}

You can install the {MavenName} in your local Maven repository.
endif::[]
ifdef::plugin-guide[]
[id="installing-ide-plugin-connected-environment_{context}"]
= Installing the {PluginName} in a connected environment

You can install the {PluginName} for Eclipse or Red Hat CodeReady Studio in a connected environment.

The {PluginName} has been tested with Eclipse 2020-09 and Red Hat CodeReady Studio 12.15.
endif::[]
ifdef::disconnected[]
[id="installing-ide-plugin-disconnected-environment_{context}"]
= Installing the {PluginName} in a disconnected environment

You can install the {PluginName} for Eclipse or Red Hat CodeReady Studio in a disconnected environment.

The {PluginName} has been tested with Eclipse 2020-09 and Red Hat CodeReady Studio 12.15.
endif::[]

.Prerequisites

ifdef::maven-guide[]
* OpenJDK 1.8, OpenJDK 11, Oracle JDK 1.8, _or_ Oracle JDK 11
* 8 GB RAM
* Maven 3.2.5 or later
endif::[]
ifdef::plugin-guide,disconnected[]
* 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]
* JBoss Tools
+
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*.
endif::[]
* If you are installing on macOS, the value of `maxproc` must be `2048` or greater.

.Procedure

ifdef::maven-guide[]
. Clone the {MavenName} Github repository:
+
----
$ git clone https://github.com/windup/windup-maven-plugin.git
----

. Navigate to the `windup-maven-plugin` directory.
+
----
$ cd windup-maven-plugin
----

. Build the project:
+
----
$ mvn clean install
----
+
The `windup-maven-plugin` jar is installed in your local Maven repository.
endif::[]
ifdef::disconnected[]
. Navigate to the link:{MTADownloadPageURL}[Migration Toolkit for Applications download site] and download the `IDE Plugin Repository` file.
endif::[]
ifdef::plugin-guide,disconnected[]
. Launch your IDE.
. From the menu bar, select *Help* -> *Install New Software*.
. Next to the *Work with* field, click *Add*.
. In the *Name* field, enter `{ProductShortName}`.
endif::[]
ifdef::plugin-guide[]
. In the *Location* field, enter `\http://download.jboss.org/jbosstools/photon/stable/updates/mta/` and click *OK*.
endif::[]
ifdef::disconnected[]
. Next to the *Location* field, click *Archive*.
. Select the IDE Plugin archive file and click *OK*.
endif::[]
ifdef::plugin-guide,disconnected[]
. Select all the *JBoss Tools - MTA* check boxes and click *Next*.
. Review the installation details and click *Next*.
. Accept the terms of the license agreement and click *Finish* to install the plugin.
. Restart your IDE for the changes to take effect.
endif::[]
69 changes: 69 additions & 0 deletions docs/topics/installing-web-console-or-cli-tool.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
// Module included in the following assemblies:
//
// * docs/cli-guide/master.adoc
// * docs/web-console-guide/master.adoc

ifdef::cli-guide[]
[id="installing-cli_{context}"]
= Installing the {CLINameTitle}

You can install the {CLINameTitle} on Linux, Windows, or macOS operating systems.
endif::[]
ifdef::web-console-guide[]
[id="installing-web-console-linux-win-mac_{context}"]
= Installing the {WebName} on Linux, Windows, or macOS

You can install the {WebName} on Linux, Windows, or macOS operating systems and access the {WebName} in a browser.

The {WebName} has been tested with Chrome and Firefox.
endif::[]

.Prerequisites

* OpenJDK 1.8, OpenJDK 11, Oracle JDK 1.8, _or_ Oracle JDK 11
* 8 GB RAM
* If you are installing on macOS, the value of `maxproc` must be `2048` or greater.
.Procedure

ifdef::cli-guide[]
. Navigate to the link:{MTADownloadPageURL}[{ProductShortName} Download page] and download the `Migration Toolkit CLI` file.
endif::[]
ifdef::web-console-guide[]
. Navigate to the link:{MTADownloadPageURL}[{ProductShortName} Download page] and download the {WebName} `Local install & OpenShift` file.
endif::[]

. Extract the `.zip` file to a directory of your choice.
+
[NOTE]
====
If you are installing on a Windows operating system:

. Extract the `.zip` file to a folder named `mta` to avoid a `Path too long` error.
. If a *Confirm file replace* window is displayed during extraction, click *Yes to all*.
====
+
The installation directory is referred to as `<MTA_HOME>` in this guide.

ifdef::web-console-guide[]
. Start the {WebName}:

* Linux operating system:
+
----
$ <MTA_HOME>/run_mta.sh
----
* Windows operating system:
+
----
C:\<MTA_HOME>\run_mta.bat
----
. Open a browser and navigate to `\http://localhost:8080/mta-web`. The {WebName} login page is displayed in your browser.
+
.Web console login page
image::web-login-openshift.png[web console login page]
+
The default user is `mta` and the default password is `password`.
endif::[]
152 changes: 0 additions & 152 deletions docs/topics/installing-web-console.adoc

This file was deleted.

2 changes: 1 addition & 1 deletion docs/web-console-guide/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ include::topics/about-the-web-console.adoc[leveloffset=+2]
You can install the {WebName} on Linux, Windows, macOS, or {ocp-full}.

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

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

Expand Down

0 comments on commit 1f455a0

Please sign in to comment.