flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FLINK-5008) Update quickstart documentation
Date Wed, 14 Dec 2016 14:40:00 GMT

    [ https://issues.apache.org/jira/browse/FLINK-5008?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15748501#comment-15748501
] 

ASF GitHub Bot commented on FLINK-5008:
---------------------------------------

Github user fhueske commented on a diff in the pull request:

    https://github.com/apache/flink/pull/2764#discussion_r92398867
  
    --- Diff: docs/quickstart/java_api_quickstart.md ---
    @@ -46,39 +46,79 @@ Use one of the following commands to __create a project__:
         {% highlight bash %}
         $ mvn archetype:generate                               \
           -DarchetypeGroupId=org.apache.flink              \
    -      -DarchetypeArtifactId=flink-quickstart-java      \
    +      -DarchetypeArtifactId=flink-quickstart-java      \{% unless site.is_stable %}
    +      -DarchetypeCatalog=https://repository.apache.org/content/repositories/snapshots/
\{% endunless %}
           -DarchetypeVersion={{site.version}}
         {% endhighlight %}
             This allows you to <strong>name your newly created project</strong>.
It will interactively ask you for the groupId, artifactId, and package name.
         </div>
         <div class="tab-pane" id="quickstart-script">
         {% highlight bash %}
    +{% if site.is_stable %}
         $ curl https://flink.apache.org/q/quickstart.sh | bash
    +{% else %}
    +    $ curl https://flink.apache.org/q/quickstart-SNAPSHOT.sh | bash
    +{% endif %}
         {% endhighlight %}
         </div>
     </div>
     
     ## Inspect Project
     
    -There will be a new directory in your working directory. If you've used the _curl_ approach,
the directory is called `quickstart`. Otherwise, it has the name of your artifactId.
    +There will be a new directory in your working directory. If you've used
    +the _curl_ approach, the directory is called `quickstart`. Otherwise,
    +it has the name of your `artifactId`:
    +
    +{% highlight bash %}
    +$ tree quickstart/
    +quickstart/
    +├── pom.xml
    +└── src
    +    └── main
    +        ├── java
    +        │   └── org
    +        │       └── myorg
    +        │           └── quickstart
    +        │               ├── BatchJob.java
    +        │               ├── SocketTextStreamWordCount.java
    +        │               ├── StreamingJob.java
    +        │               └── WordCount.java
    +        └── resources
    +            └── log4j.properties
    +{% endhighlight %}
     
     The sample project is a __Maven project__, which contains four classes. _StreamingJob_
and _BatchJob_ are basic skeleton programs, _SocketTextStreamWordCount_ is a working streaming
example and _WordCountJob_ is a working batch example. Please note that the _main_ method
of all classes allow you to start Flink in a development/testing mode.
     
    -We recommend you __import this project into your IDE__ to develop and test it. If you
use Eclipse, the [m2e plugin](http://www.eclipse.org/m2e/) allows to [import Maven projects](http://books.sonatype.com/m2eclipse-book/reference/creating-sect-importing-projects.html#fig-creating-import).
Some Eclipse bundles include that plugin by default, others require you to install it manually.
The IntelliJ IDE also supports Maven projects out of the box.
    +We recommend you __import this project into your IDE__ to develop and
    +test it. If you use Eclipse, the [m2e plugin](http://www.eclipse.org/m2e/)
    +allows to [import Maven projects](http://books.sonatype.com/m2eclipse-book/reference/creating-sect-importing-projects.html#fig-creating-import).
    +Some Eclipse bundles include that plugin by default, others require you
    +to install it manually. The IntelliJ IDE supports Maven projects out of
    +the box.
     
     
    -A note to Mac OS X users: The default JVM heapsize for Java is too small for Flink. You
have to manually increase it. Choose "Run Configurations" -> Arguments and write into the
"VM Arguments" box: "-Xmx800m" in Eclipse.
    +*A note to Mac OS X users*: The default JVM heapsize for Java is too
    --- End diff --
    
    Isn't the latest version called "macOS"?


> Update quickstart documentation
> -------------------------------
>
>                 Key: FLINK-5008
>                 URL: https://issues.apache.org/jira/browse/FLINK-5008
>             Project: Flink
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Nico Kruber
>            Assignee: Nico Kruber
>            Priority: Minor
>
> * The IDE setup documentation of Flink is outdated in both parts: IntelliJ IDEA was based
on an old version and Eclipse/Scala IDE does not work at all anymore.
> * The example in the "Quickstart: Setup" is outdated and requires "." to be in the path.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message