Zeppelin Structure

How to contribute

Zeppelin is Apache2 License Software. Contributing to Zeppelin (Source code, Documents, Image, Website) means you agree to the Apache2 License.

Make sure your issue is not already in the Jira issue tracker
If not, create a ticket describing the change you’re proposing in the Jira issue tracker
Contribute your patch via Pull Request.

SourceControl Workflow

Zeppelin follows [Fork & Pull] (https://github.com/sevntu-checkstyle/sevntu.checkstyle/wiki/Development-workflow-with-Git:-Fork,-Branching,-Commits,-and-Pull-Request) model.

Setting up

Here are some things you will need to build and test Zeppelin.

Software Configuration Management(SCM)

Zeppelin uses Git for it’s SCM system. Hosted by github.com. https://github.com/apache/incubator-zeppelin You’ll need git client installed in your development machine.

Integrated Development Environment(IDE)

You are free to use whatever IDE you prefer, or your favorite command line editor.

Project Structure

Zeppelin project is based on Maven. Maven works by convention & defines [directory structure] (https://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html) for a project. The top level pom.xml describes the basic project structure. Currently Zeppelin has the following modules.

<module>zeppelin-interpreter</module>
<module>zeppelin-zengine</module>
<module>spark</module>
<module>markdown</module>
<module>angular</module>
<module>shell</module>
<module>hive</module>
<module>tajo</module>
<module>flink</module>
<module>ignite</module>
<module>lens</module>
<module>cassandra</module>
<module>zeppelin-web</module>
<module>zeppelin-server</module>
<module>zeppelin-distribution</module>

Code convention

We are following Google Code style:

Checkstyle report location are in ${submodule}/target/site/checkstyle.html Test coverage report location are in ${submodule}/target/site/cobertura/index.html

Build Tools

To build the code, install

Oracle Java 7
Apache Maven

Getting the source code

First of all, you need the Zeppelin source code. The official location for Zeppelin is https://github.com/apache/incubator-zeppelin

git access

Get the source code on your development machine using git.

git clone git@github.com:apache/incubator-zeppelin.git zeppelin

You may also want to develop against a specific release. For example, for branch-0.1

git clone -b branch-0.1 git@github.com:apache/incubator-zeppelin.git zeppelin

Fork repository

If you want not only build Zeppelin but also make change, then you need fork Zeppelin repository and make pull request.

Build

mvn install

To skip test

mvn install -DskipTests

To build with specific spark / hadoop version

mvn install -Phadoop-2.2 -Dhadoop.version=2.2.0 -Pspark-1.3 -Dspark.version=1.3.0

Tests

Each new File should have its own accompanying unit tests. Each new interpreter should have come with its tests.

Zeppelin has 3 types of tests:

Unit Tests: The unit tests run as part of each package’s build. E.g SparkInterpeter Module’s unit test is SparkInterpreterTest
Integration Tests: The intergration tests run after all modules are build. The integration tests launch an instance of Zeppelin server. ZeppelinRestApiTest is an example integration test.
GUI integration tests: These tests validate the Zeppelin UI elements. These tests require a running Zepplein server and lauches a web browser to validate Notebook UI elements like Notes and their execution. See ZeppelinIT as an example.

Currently the GUI integration tests are not run in the Maven and are only run in the CI environment when the pull request is submitted to github. Make sure to watch the [CI results] (https://travis-ci.org/apache/incubator-zeppelin/pull_requests) for your pull request.

Continuous Integration

Zeppelin uses Travis for CI. In the project root there is .travis.yml that configures CI and [publishes CI results] (https://travis-ci.org/apache/incubator-zeppelin/builds)

Run Zepplin server in development mode

cd zeppelin-server
HADOOP_HOME=YOUR_HADOOP_HOME JAVA_HOME=YOUR_JAVA_HOME mvn exec:java -Dexec.mainClass="com.nflabs.zeppelin.server.ZeppelinServer" -Dexec.args=""

or use daemon script

bin/zeppelin-daemon start

Server will be run on http://localhost:8080

JIRA

Zeppelin manages it’s issues in Jira. https://issues.apache.org/jira/browse/ZEPPELIN

Stay involved

Everyone is welcome to join our mailling list:

users@zeppelin.incubator.apache.org is for usage questions, help, and announcements [ subscribe, unsubscribe, archive ]
dev@zeppelin.incubator.apache.org is for people who want to contribute code to Zeppelin.[ subscribe, unsubscribe, archive ]
commits@zeppelin.incubator.apache.org is for commit messages and patches to Zeppelin. [ subscribe, unsubscribe, archive ]

Stop Thinking, Just Do!