Remove non-ASCII characters
Project: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/commit/83d26188 Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/tree/83d26188 Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/diff/83d26188 Branch: refs/heads/master Commit: 83d261885ac674350e6be8c7b59b54c088419944 Parents: 8f50fbf Author: Munagala V. Ramanath <[email protected]> Authored: Mon Nov 2 08:49:30 2015 -0800 Committer: Thomas Weise <[email protected]> Committed: Sun Feb 28 22:46:34 2016 -0800 ---------------------------------------------------------------------- apex_development_setup.md | 50 +++++++++++++++++++++--------------------- 1 file changed, 25 insertions(+), 25 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-apex-core/blob/83d26188/apex_development_setup.md ---------------------------------------------------------------------- diff --git a/apex_development_setup.md b/apex_development_setup.md index 7c5044b..c320316 100644 --- a/apex_development_setup.md +++ b/apex_development_setup.md @@ -9,20 +9,20 @@ Microsoft Windows There are a few tools that will be helpful when developing Apache Apex applications, some required and some optional: -1. *git* -- A revision control system (version 1.7.1 or later). There are multiple git clients available for Windows ([git-scm][1] for example), so download and install a client of your choice. +1. *git* -- A revision control system (version 1.7.1 or later). There are multiple git clients available for Windows ([git-scm][1] for example), so download and install a client of your choice. -2. *java JDK* (not JRE). Includes the Java Runtime Environment as well as the Java compiler and a variety of tools (version 1.7.0\_79 or later). Can be downloaded from the Oracle website. +2. *java JDK* (not JRE). Includes the Java Runtime Environment as well as the Java compiler and a variety of tools (version 1.7.0\_79 or later). Can be downloaded from the Oracle website. -3. *maven* -- Apache Maven is a build system for Java projects (version 3.0.5 or later). It can be downloaded from [Apache Maven][2]. +3. *maven* -- Apache Maven is a build system for Java projects (version 3.0.5 or later). It can be downloaded from [Apache Maven][2]. -4. *VirtualBox* -- Oracle VirtualBox is a virtual machine manager (version 4.3 or later) and can be downloaded from [VirtualBox][3]. It is needed to run the Data Torrent Sandbox. +4. *VirtualBox* -- Oracle VirtualBox is a virtual machine manager (version 4.3 or later) and can be downloaded from [VirtualBox][3]. It is needed to run the Data Torrent Sandbox. -5. *DataTorrent Sandbox* -- The sandbox can be downloaded from [Sandbox][4]. It is useful for testing simple applications since it contains Apache Hadoop and Data Torrent RTS 3.1.1 pre-installed with a time-limited Enterprise License. If you already installed the RTS Enterprise Edition (evaluation or production license) on a cluster, you can use that setup for deployment and testing instead of the sandbox. +5. *DataTorrent Sandbox* -- The sandbox can be downloaded from [Sandbox][4]. It is useful for testing simple applications since it contains Apache Hadoop and Data Torrent RTS 3.1.1 pre-installed with a time-limited Enterprise License. If you already installed the RTS Enterprise Edition (evaluation or production license) on a cluster, you can use that setup for deployment and testing instead of the sandbox. -6. (Optional) If you prefer to use an IDE (Integrated Development Environment) such as *NetBeans*, *Eclipse* or *IntelliJ*, install that as well. +6. (Optional) If you prefer to use an IDE (Integrated Development Environment) such as *NetBeans*, *Eclipse* or *IntelliJ*, install that as well. -After installing these tools, make sure that the directories containing the executable files are in your PATH environment; for example, for the JDK executables like _java_ and _javac_, the directory might be something like `C:\\Program Files\\Java\\jdk1.7.0\_80\\bin`; for _git_ it might be `C:\\Program Files\\Git\\bin`; and for maven it might be `C:\\Users\\user\\Software\\apache-maven-3.3.3\\bin`. Open a console window and enter the command: +After installing these tools, make sure that the directories containing the executable files are in your PATH environment; for example, for the JDK executables like _java_ and _javac_, the directory might be something like `C:\\Program Files\\Java\\jdk1.7.0\_80\\bin`; for _git_ it might be `C:\\Program Files\\Git\\bin`; and for maven it might be `C:\\Users\\user\\Software\\apache-maven-3.3.3\\bin`. Open a console window and enter the command: echo %PATH% @@ -69,13 +69,13 @@ Now run the following commands and ensure that the output is something similar t </table> -To install the sandbox, first download it from [Sandbox][4] and import the downloaded file into VirtualBox. Once the import completes, you can select it and click the Start button to start the sandbox. +To install the sandbox, first download it from [Sandbox][4] and import the downloaded file into VirtualBox. Once the import completes, you can select it and click the Start button to start the sandbox. -The sandbox is configured with 6GB RAM; if your development machine has 16GB or more, you can increase the sandbox RAM to 8GB or more using the VirtualBox console. This will yield better performance and support larger applications. Additionally, you can change the network adapter from **NAT** to **Bridged Adapter**; this will allow you to login to the sandbox from your host machine using an _ssh_ tool like **PuTTY** and also to transfer files to and from the host using `pscp` on Windows. Of course all such configuration must be done when when the sandbox is not running. +The sandbox is configured with 6GB RAM; if your development machine has 16GB or more, you can increase the sandbox RAM to 8GB or more using the VirtualBox console. This will yield better performance and support larger applications. Additionally, you can change the network adapter from **NAT** to **Bridged Adapter**; this will allow you to login to the sandbox from your host machine using an _ssh_ tool like **PuTTY** and also to transfer files to and from the host using `pscp` on Windows. Of course all such configuration must be done when when the sandbox is not running. -You can choose to develop either directly on the sandbox or on your development machine. The advantage of the former is that most of the tools (e.g. _jdk_, _git_, _maven_) are pre-installed and also the package files created by your project are directly available to the Data Torrent tools such as **dtManage** and **dtcli**. The disadvantage is that the sandbox is a memory-limited environment so running a memory-hungry tool like a Java IDE on it may starve other applications of memory. +You can choose to develop either directly on the sandbox or on your development machine. The advantage of the former is that most of the tools (e.g. _jdk_, _git_, _maven_) are pre-installed and also the package files created by your project are directly available to the Data Torrent tools such as **dtManage** and **dtcli**. The disadvantage is that the sandbox is a memory-limited environment so running a memory-hungry tool like a Java IDE on it may starve other applications of memory. You can now use the maven archetype to create a basic Apache Apex project as follows: Put these lines in a Windows command file called, for example, `newapp.cmd` and run it: @@ -85,18 +85,18 @@ You can now use the maven archetype to create a basic Apache Apex project as fol setlocal mvn archetype:generate ^ -DarchetypeRepository=https://www.datatorrent.com/maven/content/repositories/releases ^ -  -DarchetypeGroupId=com.datatorrent ^ -  -DarchetypeArtifactId=apex-app-archetype ^ -  -DarchetypeVersion=3.1.1 ^ -  -DgroupId=com.example ^ -  -Dpackage=com.example.myapexapp ^ -  -DartifactId=myapexapp ^ -  -Dversion=1.0-SNAPSHOT + -DarchetypeGroupId=com.datatorrent ^ + -DarchetypeArtifactId=apex-app-archetype ^ + -DarchetypeVersion=3.1.1 ^ + -DgroupId=com.example ^ + -Dpackage=com.example.myapexapp ^ + -DartifactId=myapexapp ^ + -Dversion=1.0-SNAPSHOT endlocal -The caret (^) at the end of some lines indicates that a continuation line follows. When you run this file, the properties will be displayed and you will be prompted with `` Y: :``; just press **Enter** to complete the project generation. +The caret (^) at the end of some lines indicates that a continuation line follows. When you run this file, the properties will be displayed and you will be prompted with `` Y: :``; just press **Enter** to complete the project generation. This command file also exists in the Data Torrent _examples_ repository which you can check out with: @@ -105,18 +105,18 @@ This command file also exists in the Data Torrent _examples_ repository which yo You will find the script under `examples\tutorials\topnwords\scripts\newapp.cmd`. -You can also, if you prefer, use an IDE to generate the project as described in Section 3 of [Apex Packages](apex_package.md) but use the archetype version 3.1.1 instead of 3.0.0. +You can also, if you prefer, use an IDE to generate the project as described in Section 3 of [Apex Packages](apex_package.md) but use the archetype version 3.1.1 instead of 3.0.0. -When the run completes successfully, you should see a new directory named `myapexapp` containing a maven project for building a basic Apache Apex application. It includes 3 source files:**Application.java**, **RandomNumberGenerator.java** and **ApplicationTest.java**. You can now build the application by stepping into the new directory and running the appropriate maven command: +When the run completes successfully, you should see a new directory named `myapexapp` containing a maven project for building a basic Apache Apex application. It includes 3 source files:**Application.java**, **RandomNumberGenerator.java** and **ApplicationTest.java**. You can now build the application by stepping into the new directory and running the appropriate maven command: cd myapexapp mvn clean package -DskipTests -The build should create the application package file `myapexapp\target\myapexapp-1.0-SNAPSHOT.apa`. This file can then be uploaded to the Data Torrent GUI tool on the sandbox (called **dtManage**) and launched from there. It generates a stream of random numbers and prints them out, each prefixed by the string  `hello world: `. If you built this package on the host, you can transfer it to the sandbox using the `pscp` tool bundled with **PuTTY** mentioned earlier. +The build should create the application package file `myapexapp\target\myapexapp-1.0-SNAPSHOT.apa`. This file can then be uploaded to the Data Torrent GUI tool on the sandbox (called **dtManage**) and launched from there. It generates a stream of random numbers and prints them out, each prefixed by the string `hello world: `. If you built this package on the host, you can transfer it to the sandbox using the `pscp` tool bundled with **PuTTY** mentioned earlier. -If you want to checkout the Apache Apex source repositories and build them, you can do so by running the script `build-apex.cmd` located in the same place in the examples repository described above. The source repositories contain more substantial demo applications and the associated source code. Alternatively, if you do not want to use the script, you can follow these simple manual steps: +If you want to checkout the Apache Apex source repositories and build them, you can do so by running the script `build-apex.cmd` located in the same place in the examples repository described above. The source repositories contain more substantial demo applications and the associated source code. Alternatively, if you do not want to use the script, you can follow these simple manual steps: 1. Check out the source code repositories: @@ -135,9 +135,9 @@ If you want to checkout the Apache Apex source repositories and build them, you mvn clean install -DskipTests popd -The `install` argument to the `mvn` command installs resources from each project to your local maven repository (typically `.m2/repository` under your home directory), and **not** to the system directories, so Administrator privileges are not required. The `-DskipTests` argument skips running unit tests since they take a long time. If this is a first-time installation, it might take several minutes to complete because maven will download a number of associated plugins. +The `install` argument to the `mvn` command installs resources from each project to your local maven repository (typically `.m2/repository` under your home directory), and **not** to the system directories, so Administrator privileges are not required. The `-DskipTests` argument skips running unit tests since they take a long time. If this is a first-time installation, it might take several minutes to complete because maven will download a number of associated plugins. -After the build completes, you should see the demo application package files in the target directory under each demo subdirectory in `incubator-apex-malhar\demos\`. +After the build completes, you should see the demo application package files in the target directory under each demo subdirectory in `incubator-apex-malhar\demos\`. Linux ------------------ @@ -148,7 +148,7 @@ Most of the instructions for Linux (and other Unix-like systems) are similar to The pre-requisites (such as _git_, _maven_, etc.) are the same as for Windows described above; please run the commands in the table and ensure that appropriate versions are present in your PATH environment variable (the command to display that variable is: `echo $PATH`). -The maven archetype command is the same except that continuation lines use a backslash (``\``) instead of caret (``^``); the script for it is available in the same location and is named `newapp` (without the `.cmd` extension). The script to checkout and build the Apache Apex repositories is named `build-apex`. +The maven archetype command is the same except that continuation lines use a backslash (``\``) instead of caret (``^``); the script for it is available in the same location and is named `newapp` (without the `.cmd` extension). The script to checkout and build the Apache Apex repositories is named `build-apex`. [1]: http://git-scm.com/download/win [2]: https://maven.apache.org/download.cgi
