From 2287a8d20774ad0e2f7443986fdb920c57c35509 Mon Sep 17 00:00:00 2001 From: "Yazdan.JS" Date: Fri, 11 May 2018 01:35:16 -0400 Subject: [PATCH] [FLINK-9333] QuickStart Docs Spelling fix and some info regarding IntelliJ JVM Options - Spelling fix for QuickStart Project Template for Java - Adding more details regarding changing JVM options in IntelliJ IDEA --- docs/quickstart/java_api_quickstart.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/quickstart/java_api_quickstart.md b/docs/quickstart/java_api_quickstart.md index 9a325911dd27b..e3058e503c82e 100644 --- a/docs/quickstart/java_api_quickstart.md +++ b/docs/quickstart/java_api_quickstart.md @@ -64,7 +64,7 @@ Use one of the following commands to __create a project__: {% unless site.is_stable %}

- Note: For Maven 3.0 or higher, it is no longer possible to specify the repository (-DarchetypeCatalog) via the commandline. If you wish to use the snapshot repository, you need to add a repository entry to your settings.xml. For details about this change, please refer to Maven official document + Note: For Maven 3.0 or higher, it is no longer possible to specify the repository (-DarchetypeCatalog) via the command line. If you wish to use the snapshot repository, you need to add a repository entry to your settings.xml. For details about this change, please refer to Maven official document

{% endunless %} @@ -101,17 +101,17 @@ allows to [import Maven projects](http://books.sonatype.com/m2eclipse-book/refer Some Eclipse bundles include that plugin by default, others require you to install it manually. -*A note to Mac OS X users*: The default JVM heapsize for Java mey be too +*A note to Mac OS X users*: The default JVM heapsize for Java may be too small for Flink. You have to manually increase it. In Eclipse, choose `Run Configurations -> Arguments` and write into the `VM Arguments` -box: `-Xmx800m`. +box: `-Xmx800m`. In IntelliJ IDEA recommended way to change JVM options is from the `Help | Edit Custom VM Options` menu. See [this article](https://intellij-support.jetbrains.com/hc/en-us/articles/206544869-Configuring-JVM-options-and-platform-properties) for details. ## Build Project If you want to __build/package your project__, go to your project directory and run the '`mvn clean package`' command. You will __find a JAR file__ that contains your application, plus connectors and libraries -that you may have added as dependencoes to the application: `target/-.jar`. +that you may have added as dependencies to the application: `target/-.jar`. __Note:__ If you use a different class than *StreamingJob* as the application's main class / entry point, we recommend you change the `mainClass` setting in the `pom.xml` file accordingly. That way, the Flink @@ -122,12 +122,12 @@ can run time application from the JAR file without additionally specifying the m Write your application! If you are writing a streaming application and you are looking for inspiration what to write, -take a look at the [Stream Processing Application Tutorial]({{ site.baseurl }}/quickstart/run_example_quickstart.html#writing-a-flink-program) +take a look at the [Stream Processing Application Tutorial]({{ site.baseurl }}/quickstart/run_example_quickstart.html#writing-a-flink-program). If you are writing a batch processing application and you are looking for inspiration what to write, -take a look at the [Batch Application Examples]({{ site.baseurl }}/dev/batch/examples.html) +take a look at the [Batch Application Examples]({{ site.baseurl }}/dev/batch/examples.html). -For a complete overview over the APIa, have a look at the +For a complete overview over the APIs, have a look at the [DataStream API]({{ site.baseurl }}/dev/datastream_api.html) and [DataSet API]({{ site.baseurl }}/dev/batch/index.html) sections.