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 Thu, 15 Dec 2016 13:30:58 GMT

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

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

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

    https://github.com/apache/flink/pull/2764#discussion_r92608383
  
    --- 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,
    --- End diff --
    
    shortcut doesn't sound right - at least to the user not knowing what is happening behind
the script, you can consider the two options two different approaches of creating a quickstart
project


> 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