[GitHub] zeppelin pull request #1480: [ZEPPELIN-1489] Remove jdbc-like interpreter ex...

[AhyoungRyu]

GitHub user AhyoungRyu opened a pull request:

    https://github.com/apache/zeppelin/pull/1480

    [ZEPPELIN-1489] Remove jdbc-like interpreter example properties and improve 
JDBC docs

    ### What is this PR for?
    Currently we can use `%jdbc(prefix)` for multi database connections(e.g. 
configuring both postgresql and hive in one JDBC interpreter). But after #1360 
merged, Zeppelin doesn't support `%jdbc(prefix)` to `%prefix` anymore. So 
auto-prefix feature is not working for `%jdbc(prefix)`. The auto-prefix only 
works for `%prefix` now. Considering this status, it would be better we remove 
the JDBC connection examples in `jdbc/interpreter-setting.json` (this is come 
from #1096) so that users can create several JDBC interpreters instead of using 
multiple connections with one JDBC interpreter.  I removed the related contents 
in `jdbc.md` as well.
    
    Also, the contents of [current JDBC documentation 
page](http://zeppelin.apache.org/docs/0.7.0-SNAPSHOT/interpreter/jdbc.html) is 
quite confusing and unorganized. So I updated the contents with some screenshot 
images to guide "How to create JDBC interpreter", "How to edit the interpreter 
properties for the connection", "How to use `%prefix` with the interpreter", 
and so on.
    
    ### What type of PR is it?
    Improvement & Documentation
    
    ### What is the Jira issue?
    * [ZEPPELIN-1489](https://issues.apache.org/jira/browse/ZEPPELIN-1489)
    
    ### How should this be tested?
    * Removing example properties in `interpreter-setting.json`
      1. after applying this patch and build with `mvn clean package 
-DskipTests -Pspark-1.6 -pl 
'jdbc,zeppelin-interpreter,zeppelin-web,zeppelin-server,zeppelin-zengine,zeppelin-display`
      2. create JDBC interpreter and check whether the example settings are 
gone or not  
    
    * JDBC docs
      1. Build only `docs/` dir as described in 
[here](https://github.com/apache/zeppelin/blob/master/docs/README.md#build-documentation)
      2. Go to `interpreter -> JDBC` and just compare this locally builded page 
with [the original JDBC 
page](https://zeppelin.apache.org/docs/0.7.0-SNAPSHOT/interpreter/jdbc.html)
    
    ### Screenshots (if appropriate)
     - Before 
    <img width="1579" alt="before" 
src="https://cloud.githubusercontent.com/assets/10060731/19045323/1ff0c706-89d3-11e6-9b6f-dc75877f81f3.png";>
    
     - After 
    <img width="944" alt="screen shot 2016-10-04 at 1 05 00 am" 
src="https://cloud.githubusercontent.com/assets/10060731/19045324/24a9187a-89d3-11e6-90d6-b80acbc6af7c.png";>
    
     - Some parts of updated JDBC docs
    Since many contentst are changed, it would be better to build `docs/` 
locally to review all of the updated contents.
    
    <img width="695" alt="screen shot 2016-10-04 at 12 36 39 am" 
src="https://cloud.githubusercontent.com/assets/10060731/19043794/9d9a32fc-89cc-11e6-9d15-f6036a1b738e.png";>
    
    <img width="704" alt="screen shot 2016-10-04 at 12 36 59 am" 
src="https://cloud.githubusercontent.com/assets/10060731/19043800/a62fc90e-89cc-11e6-976d-5c697729eca4.png";>
    
    <img width="677" alt="screen shot 2016-10-04 at 12 37 31 am" 
src="https://cloud.githubusercontent.com/assets/10060731/19043807/acbc9766-89cc-11e6-8c73-eab1cc18440b.png";>
    
    <img width="688" alt="screen shot 2016-10-04 at 12 37 43 am" 
src="https://cloud.githubusercontent.com/assets/10060731/19043816/b06b5690-89cc-11e6-9298-a20b49fea622.png";>
    
    ### Questions:
    * Does the licenses files need update? no
    * Is there breaking changes for older versions? no
    * Does this needs documentation? yes


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

    $ git pull https://github.com/AhyoungRyu/zeppelin ZEPPELIN-1489

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

    https://github.com/apache/zeppelin/pull/1480.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 #1480
    
----
commit 223ee1ea76f7472341d0d5c041d63799917bf9df
Author: AhyoungRyu <ahyoung...@apache.org>
Date:   2016-10-03T14:44:42Z

    Redshit -> Redshift in JDBCInterpreter.java

commit bf946ade5a72b68544b5c28d201664d206245967
Author: AhyoungRyu <ahyoung...@apache.org>
Date:   2016-10-03T15:38:37Z

    Update jdbc.md

commit a90470db78dd7b9ad77f0e91cfddb65d9be1498c
Author: AhyoungRyu <ahyoung...@apache.org>
Date:   2016-10-03T15:39:54Z

    Remove jdbc setting examples in interpreter-setting.json

commit 16a39cef69fe2aae6018969d9d5ca54a6100ce7e
Author: AhyoungRyu <ahyoung...@apache.org>
Date:   2016-10-03T15:40:26Z

    Add screenshot images

commit a0b7849b7b742bbeba49bd3fda6d928a43a5f48b
Author: AhyoungRyu <ahyoung...@apache.org>
Date:   2016-10-03T15:44:03Z

    Remove useless screenshot images

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---