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

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

GitHub user sv3nd opened a pull request:

    https://github.com/apache/flink/pull/4531

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

    
    ## What is the purpose of the change
    
    Current [documentation for scala project scafolding from 
template](https://ci.apache.org/projects/flink/flink-docs-release-1.3/quickstart/scala_api_quickstart.html#create-project)
 mentions that giter8 needs to be installed. 
    
    The purpose of this documentation update is to clarify that such 
installation is not required, making it easier to newcomers (and others) to 
start coding a flink project. 
    
    ## Brief change log
    
    Documents  how to use `sbt new` instead of `giter8`.  `sbt` is very likely 
to already be installed since this is a commonly used developer tool, 
especially given that the target user here is a scala developer.  
    
    Also, removes the reference to cloning the git project, since that method 
is more cumbersome for 2 reasons:
    - requires the user to remove the `.git` folder after the `git clone`
    - is not template based => folders and versions are hard-coded
    
    Also, removing this method imply that one less template needs to be 
maintained. 
    
    ## Verifying this change
    
      -*Manually verified the change by running `./build_docs.sh -p` from 
inside the docker container available in `docs/docker`
    
    ## Does this pull request potentially affect one of the following parts:
    
      - Dependencies (does it add or upgrade a dependency): (no)
      - The public API, i.e., is any changed class annotated with 
`@Public(Evolving)`: ( no)
      - The serializers: ( no )
      - The runtime per-record code paths (performance sensitive): (no )
      - Anything that affects deployment or recovery: JobManager (and its 
components), Checkpointing, Yarn/Mesos, ZooKeeper: (no )
    
    ## Documentation
    
      - Does this pull request introduce a new feature? (no)
      - If yes, how is the feature documented? ( docs )
    


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/sv3nd/flink doc_scala_sbt_new

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/flink/pull/4531.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #4531
    
----
commit caadb32807abc9bea97a34f8e7fe87431697d717
Author: Svend Vanderveken <svend.vanderve...@gmail.com>
Date:   2017-08-12T09:11:36Z

    [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).

----


> Scafolding of a 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)

Reply via email to