Svend Vanderveken created FLINK-7434:
----------------------------------------
Summary: Scafolding of an scala project should rely on "sbt new"
Key: FLINK-7434
URL:
https://issues.apache.org/jira/browse/FLINK-7434 Project: Flink
Issue Type: Improvement
Components: Documentation
Affects Versions: 1.3.2
Reporter: Svend Vanderveken
Priority: Minor
h2. Issue:
Currently, the documentation for [scafolding a new scala project|
https://ci.apache.org/projects/flink/flink-docs-release-1.3/quickstart/scala_api_quickstart.html#sbt] refers to 3 methods providing an equivalent basic project:
1) installing and using giter8 to generate it from [this giter8 template|
https://github.com/tillrohrmann/flink-project.g8]
2) cloning [this other template|
https://github.com/tillrohrmann/flink-project]
3) using the [sbt-quickstart.sh|
https://flink.apache.org/q/sbt-quickstart.sh] script
This works, though implies 3 templates need to be maintained in parallel and simpler methods now exist
h2. Suggested solution
- the documentation for the template related to method 1) above has recently been updated: we can now generate projects from it with a simple {{sbt new}} command line statement. Using {{sbt new}} is more natural to the end use since it does not require to install giter8, and sbt is more likely to be installed already.
- I think we should remove method 2) since it is essentially equivalent to method 1), with the drawback that the version numbers are hard-coded inside it, as opposed to a parameter-based giter8 template
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
Locked
