flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From trohrm...@apache.org
Subject flink git commit: [FLINK-7434][doc] scafolding with "sbt new"
Date Mon, 14 Aug 2017 09:22:04 GMT
Repository: flink
Updated Branches:
  refs/heads/master 0a19c456a -> 4c0fa6edf


[FLINK-7434][doc] scafolding with "sbt new"

Since the generated project is an sbt project, it is
much more straightfoward for the user to create it with
the new "sbt new" command than by using giter8 (which
requires to install giter8 just for that purpose).

This closes #4531.


Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/4c0fa6ed
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/4c0fa6ed
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/4c0fa6ed

Branch: refs/heads/master
Commit: 4c0fa6edf52ac2ec2a902a44022d99397755a4f1
Parents: 0a19c45
Author: Svend Vanderveken <svend.vanderveken@gmail.com>
Authored: Sat Aug 12 11:11:36 2017 +0200
Committer: Till Rohrmann <trohrmann@apache.org>
Committed: Mon Aug 14 11:21:50 2017 +0200

----------------------------------------------------------------------
 docs/quickstart/scala_api_quickstart.md | 19 +++++++------------
 1 file changed, 7 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flink/blob/4c0fa6ed/docs/quickstart/scala_api_quickstart.md
----------------------------------------------------------------------
diff --git a/docs/quickstart/scala_api_quickstart.md b/docs/quickstart/scala_api_quickstart.md
index abf6021..9e563ed 100644
--- a/docs/quickstart/scala_api_quickstart.md
+++ b/docs/quickstart/scala_api_quickstart.md
@@ -41,25 +41,20 @@ These templates help you to set up the project structure and to create
the initi
 
 ### Create Project
 
+You can scafold a new project via either of the following two methods:
+
 <ul class="nav nav-tabs" style="border-bottom: none;">
-    <li class="active"><a href="#giter8" data-toggle="tab">Use <strong>Giter8</strong></a></li>
-    <li><a href="#clone-repository" data-toggle="tab">Clone <strong>repository</strong></a></li>
+    <li class="active"><a href="#sbt_template" data-toggle="tab">Use the <strong>sbt
template</strong></a></li>
     <li><a href="#quickstart-script-sbt" data-toggle="tab">Run the <strong>quickstart
script</strong></a></li>
 </ul>
 
 <div class="tab-content">
-    <div class="tab-pane active" id="giter8">
-    {% highlight bash %}
-    $ g8 tillrohrmann/flink-project
-    {% endhighlight %}
-    This will create a Flink project in the <strong>specified</strong> project
directory from the <a href="https://github.com/tillrohrmann/flink-project.g8">flink-project
template</a>.
-    If you haven't installed <a href="https://github.com/n8han/giter8">giter8</a>,
then please follow this <a href="https://github.com/n8han/giter8#installation">installation
guide</a>.
-    </div>
-    <div class="tab-pane" id="clone-repository">
+    <div class="tab-pane active" id="sbt_template">
     {% highlight bash %}
-    $ git clone https://github.com/tillrohrmann/flink-project.git
+    $ sbt new tillrohrmann/flink-project.g8
     {% endhighlight %}
-    This will create the Flink project in the directory <strong>flink-project</strong>.
+    This will will prompt you for a couple of parameters (project name, flink version...)
and then create a Flink project from the <a href="https://github.com/tillrohrmann/flink-project.g8">flink-project
template</a>.
+    You need sbt >= 0.13.13 to execute this command. You can follow this <a href="http://www.scala-sbt.org/download.html">installation
guide</a> to obtain it if necessary.
     </div>
     <div class="tab-pane" id="quickstart-script-sbt">
     {% highlight bash %}


Mime
View raw message