Repository: zeppelin Updated Branches: refs/heads/master 9bce03ce0 -> 56bbff3d3
[ZEPPELIN-1414] Remove CONTRIBUTING.md files ### What is this PR for? Following the PR #1356, we now have the contribution documentation to on Apache Zeppelin Website. We can now remove the contributing files from the repository, and replace the links to that documentation. ### What type of PR is it? Documentation ### What is the Jira issue? https://issues.apache.org/jira/browse/ZEPPELIN-1414 ### How should this be tested? Just check if there is other CONTRIBUTING.md files and if there is other links to replace ### Questions: * Does the licenses files need update? No * Is there breaking changes for older versions? No * Does this needs documentation? No Author: Damien CORNEAU <cornead...@gmail.com> Closes #1406 from corneadoug/ZEPPELIN-1414 and squashes the following commits: 4347043 [Damien CORNEAU] change a how to contribute link to the webiste in the docs faf3e11 [Damien CORNEAU] Make links to contribution material point to the website cb4b5f7 [Damien CORNEAU] Remove contributing files from RAT 7810f57 [Damien CORNEAU] Remove contributing files Project: http://git-wip-us.apache.org/repos/asf/zeppelin/repo Commit: http://git-wip-us.apache.org/repos/asf/zeppelin/commit/56bbff3d Tree: http://git-wip-us.apache.org/repos/asf/zeppelin/tree/56bbff3d Diff: http://git-wip-us.apache.org/repos/asf/zeppelin/diff/56bbff3d Branch: refs/heads/master Commit: 56bbff3d3d7669065ba12b78f326297a64fd61a1 Parents: 9bce03c Author: Damien CORNEAU <cornead...@gmail.com> Authored: Tue Sep 6 17:50:08 2016 +0900 Committer: Damien CORNEAU <cornead...@gmail.com> Committed: Fri Sep 9 08:04:10 2016 +0900 ---------------------------------------------------------------------- .github/PULL_REQUEST_TEMPLATE | 2 +- CONTRIBUTING.md | 228 -------------------- README.md | 10 +- docs/CONTRIBUTING.md | 94 -------- docs/README.md | 8 +- docs/development/writingzeppelininterpreter.md | 7 +- docs/index.md | 5 +- pom.xml | 14 +- zeppelin-web/CONTRIBUTING.md | 127 ----------- zeppelin-web/README.md | 2 +- 10 files changed, 22 insertions(+), 475 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/zeppelin/blob/56bbff3d/.github/PULL_REQUEST_TEMPLATE ---------------------------------------------------------------------- diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 09c1b3b..526b414 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -1,6 +1,6 @@ ### What is this PR for? A few sentences describing the overall goals of the pull request's commits. -First time? Check out the contributing guide - https://github.com/apache/zeppelin/blob/master/CONTRIBUTING.md +First time? Check out the contributing guide - https://zeppelin.apache.org/contribution/contributions.html ### What type of PR is it? http://git-wip-us.apache.org/repos/asf/zeppelin/blob/56bbff3d/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 278c36f..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,228 +0,0 @@ -# How to contribute - -**Zeppelin** is [Apache2 License](https://github.com/apache/zeppelin/blob/master/CONTRIBUTING.md) Software. -Contributing to Zeppelin (Source code, Documents, Image, Website) means you agree to the Apache2 License. - -1. Make sure your issue is not already in the [Jira issue tracker](https://issues.apache.org/jira/browse/ZEPPELIN) -2. If not, create a ticket describing the change you're proposing in the [Jira issue tracker](https://issues.apache.org/jira/browse/ZEPPELIN) -3. Contribute your patch via Pull Request. - -Before you start, please read the [Code of Conduct](http://www.apache.org/foundation/policies/conduct.html) carefully, familiarize yourself with it and refer to it whenever you need it. - -For those of you who are not familiar with Apache project, understanding [How it works](http://www.apache.org/foundation/how-it-works.html) would be quite helpful. - -## Creating a Pull Request -In order to make the review process easier, please follow this template when making a Pull Request: - -``` -### What is this PR for? -A few sentences describing the overall goals of the pull request's commits. -First time? Check out the contributing guide - https://github.com/apache/zeppelin/blob/master/CONTRIBUTING.md - -### What type of PR is it? -[Bug Fix | Improvement | Feature | Documentation | Hot Fix | Refactoring] - -### Todos -* [ ] - Task - -### What is the Jira issue? -* Open an issue on Jira https://issues.apache.org/jira/browse/ZEPPELIN/ -* Put link here, and add [ZEPPELIN-*Jira number*] in PR title, eg. [ZEPPELIN-533] - -### How should this be tested? -Outline the steps to test the PR here. - -### Screenshots (if appropriate) - -### Questions: -* Does the licenses files need update? -* Is there breaking changes for older versions? -* Does this needs documentation? -``` - -## Testing a Pull Request -You can also test and review a particular Pull Request. Here are two useful ways. - -* Using a utility provided from Zeppelin. - - ``` - dev/test_zeppelin_pr.py [# of PR] - ``` - - For example, if you want to test `#513`, then the command will be: - - ``` - dev/test_zeppelin_pr.py 513 - ``` - -* Another way is using [github/hub](https://github.com/github/hub). - - ``` - hub checkout https://github.com/apache/zeppelin/pull/[# of PR] - ``` - -The above two methods will help you test and review Pull Requests. - -## Source Control Workflow -Zeppelin follows [Fork & Pull] (https://github.com/sevntu-checkstyle/sevntu.checkstyle/wiki/Development-workflow-with-Git:-Fork,-Branching,-Commits,-and-Pull-Request) model. - -## The Review Process - -When a Pull Request is submitted, it is being merged or rejected by following review process. - -* Anybody can be a reviewer and may comment on the change and suggest modifications. -* Reviewer can indicate that a patch looks suitable for merging with a comment such as: "Looks good", "LGTM", "+1". -* At least one indication of suitable for merging (e.g. "LGTM") from committer is required to be merged. -* Pull request is open for 1 or 2 days for potential additional review, unless it's got enough indication of suitable for merging. -* Committer can initiate lazy consensus ("Merge if there is no more discussion") and the code can be merged after certain time (normally 24 hours) when there is no review exists. -* Contributor can ping reviewers (including committer) by commenting 'Ready to review' or suitable indication. - -## Becoming a Committer - -The PPMC adds new committers from the active contributors, based on their contribution to Zeppelin. The qualifications for new committers include: - -1. Sustained contributions: Committers should have a history of constant contributions to Zeppelin. -2. Quality of contributions: Committers more than any other community member should submit simple, well-tested, and well-designed patches. -3. Community involvement: Committers should have a constructive and friendly attitude in all community interactions. They should also be active on the dev, user list and reviewing patches. Also help new contributors and users. - - -## Setting up -Here are some things you will need to build and test Zeppelin. - -### Software Configuration Management (SCM) - -Zeppelin uses Git for its SCM system. `http://git.apache.org/zeppelin.git` you'll need git client installed in your development machine. -For write access, `https://git-wip-us.apache.org/repos/asf/zeppelin.git` - -### 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>flink</module> - <module>ignite</module> - <module>lens</module> - <module>cassandra</module> - <module>zeppelin-web</module> - <module>zeppelin-server</module> - <module>zeppelin-distribution</module> - -### Web Project Contribution Guidelines -If you plan on making a contribution to Zeppelin's WebApplication, -please check [its own contribution guidelines](https://github.com/apache/zeppelin/blob/master/zeppelin-web/CONTRIBUTING.md) - -### Code convention -We are following Google Code style: -* [Java style](https://google.github.io/styleguide/javaguide.html) -* [Shell style](https://google.github.io/styleguide/shell.xml) - -Check style 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 [http://git.apache.org/zeppelin.git](http://git.apache.org/zeppelin.git). - -### git access - -Get the source code on your development machine using git. - -``` -git clone git://git.apache.org/zeppelin.git zeppelin -``` - -You may also want to develop against a specific branch. For example, for branch-0.5.6 - -``` -git clone -b branch-0.5.6 git://git.apache.org/zeppelin.git zeppelin -``` - -or with write access - -``` -git clone https://git-wip-us.apache.org/repos/asf/zeppelin.git -``` - -### Fork repository - -If you want not only build Zeppelin but also make change, then you need fork Zeppelin github mirror repository (https://github.com/apache/zeppelin) 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: - - 1. Unit Tests: The unit tests run as part of each package's build. E.g. SparkInterpeter Module's unit test is SparkInterpreterTest - 2. Integration Tests: The integration tests run after all modules are build. The integration tests launch an instance of Zeppelin server. ZeppelinRestApiTest is an example integration test. - 3. GUI integration tests: These tests validate the Zeppelin UI elements. These tests require a running Zeppelin server and launches 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/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/zeppelin/builds) - - -## Run Zeppelin server in development mode - -``` -cd zeppelin-server -HADOOP_HOME=YOUR_HADOOP_HOME JAVA_HOME=YOUR_JAVA_HOME mvn exec:java -Dexec.mainClass="org.apache.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](https://issues.apache.org/jira/browse/ZEPPELIN) - -## Where to Start -You can find issues for [beginner](https://issues.apache.org/jira/issues/?jql=(labels%20%3D%20newbie%20or%20labels%3D%20beginner)%20and%20project%3DZeppelin) - -## Stay involved -Everyone is welcome to join our mailing list: - - * [us...@zeppelin.apache.org](http://mail-archives.apache.org/mod_mbox/zeppelin-users/) is for usage questions, help, and announcements [ [subscribe](mailto:users-subscr...@zeppelin.apache.org?subject=send%20this%20email%20to%20subscribe), [unsubscribe](mailto:users-unsubscr...@zeppelin.apache.org?subject=send%20this%20email%20to%20unsubscribe), [archive](http://mail-archives.apache.org/mod_mbox/zeppelin-users/) ] - * [d...@zeppelin.apache.org](http://mail-archives.apache.org/mod_mbox/zeppelin-users/) is for people who want to contribute code to Zeppelin.[ [subscribe](mailto:dev-subscr...@zeppelin.apache.org?subject=send%20this%20email%20to%20subscribe), [unsubscribe](mailto:dev-unsubscr...@zeppelin.apache.org?subject=send%20this%20email%20to%20unsubscribe), [archive](http://mail-archives.apache.org/mod_mbox/zeppelin-dev/) ] - * [commits@zeppelin.apache.org](http://mail-archives.apache.org/mod_mbox/zeppelin-commits/) is for commit messages and patches to Zeppelin. [ [subscribe](mailto:commits-subscr...@zeppelin.apache.org?subject=send%20this%20email%20to%20subscribe), [unsubscribe](mailto:commits-unsubscr...@zeppelin.apache.org?subject=send%20this%20email%20to%20unsubscribe), [archive](http://mail-archives.apache.org/mod_mbox/zeppelin-commits/) ] http://git-wip-us.apache.org/repos/asf/zeppelin/blob/56bbff3d/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index dc3460c..c1deb88 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ **Documentation:** [User Guide](http://zeppelin.apache.org/docs/latest/index.html)<br/> **Mailing Lists:** [User and Dev mailing list](http://zeppelin.apache.org/community.html)<br/> **Continuous Integration:** [](https://travis-ci.org/apache/zeppelin) <br/> -**Contributing:** [Contribution Guide](https://github.com/apache/zeppelin/blob/master/CONTRIBUTING.md)<br/> +**Contributing:** [Contribution Guide](https://zeppelin.apache.org/contribution/contributions.html)<br/> **Issue Tracker:** [Jira](https://issues.apache.org/jira/browse/ZEPPELIN)<br/> **License:** [Apache 2.0](https://github.com/apache/zeppelin/blob/master/LICENSE) @@ -18,7 +18,7 @@ Core feature: To know more about Zeppelin, visit our web site [http://zeppelin.apache.org](http://zeppelin.apache.org) ## Requirements - * Git + * Git * Java 1.7 * Tested on Mac OSX, Ubuntu 14.X, CentOS 6.X, Windows 7 Pro SP1 * Maven (if you want to build from the source code) @@ -67,7 +67,7 @@ First of all, set your proxy configuration on Maven `settings.xml`. </settings> ``` -Then, run these commands from shell. +Then, run these commands from shell. ``` npm config set proxy http://localhost:3128 npm config set https-proxy http://localhost:3128 @@ -87,10 +87,10 @@ git config --global --unset https.proxy git config --global --unset url."http://".insteadOf ``` -_Notes:_ +_Notes:_ - If you are behind NTLM proxy you can use [Cntlm Authentication Proxy](http://cntlm.sourceforge.net/). - Replace `localhost:3128` with the standard pattern `http://user:pwd@host:port`. - + #### Install maven ``` wget http://www.eu.apache.org/dist/maven/maven-3/3.3.9/binaries/apache-maven-3.3.9-bin.tar.gz http://git-wip-us.apache.org/repos/asf/zeppelin/blob/56bbff3d/docs/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md deleted file mode 100644 index 7cdb8ad..0000000 --- a/docs/CONTRIBUTING.md +++ /dev/null @@ -1,94 +0,0 @@ -# Contributing to Apache Zeppelin Documentation - -## Folder Structure -`docs/` folder is organized as below: - -``` -docs/ - âââ _includes/themes/zeppelin - â âââ _navigation.html - â âââ default.html - âââ _layouts - âââ _plugins - âââ assets/themes/zeppelin -> {ASSET_PATH} - â âââ bootstrap - â âââ css - â âââ img - â âââ js - âââ development/ *.md - âââ displaysystem/ *.md - âââ install/ *.md - âââ interpreter/ *.md - âââ manual/ *.md - âââ quickstart/ *.md - âââ rest-api/ *.md - âââ security/ *.md - âââ storage/ *.md - âââ Gemfile - âââ Gemfile.lock - âââ _config.yml - âââ index.md - âââ ... -``` - - - `_navigation.html`: the dropdown menu in navbar - - `default.html` & `_layouts/`: define default HTML layout - - `_plugins/`: custom plugin `*.rb` files can be placed in this folder. See [jekyll/plugins](https://jekyllrb.com/docs/plugins/) for the further information. - - `{ASSET_PATH}/css/style.css`: extra css components can be defined - - `{ASSET_PATH}/img/docs-img/`: image files used for document pages can be placed in this folder - - `{ASSET_PATH}/js/`: extra `.js` files can be placed - - `Gemfile`: defines bundle dependencies. They will be installed by `bundle install`. - - `Gemfile.lock`: when you run `bundle install`, bundler will persist all gems name and their version to this file. For the more details, see [Bundle "The Gemfile Lock"](http://bundler.io/v1.10/man/bundle-install.1.html#THE-GEMFILE-LOCK) - - `documentation_group`: `development/`, `displaysystem/`, `install/`, `interpreter/`... - - `_config.yml`: defines configuration options for docs website. See [jekyll/configuration](https://jekyllrb.com/docs/configuration/) for the other available config variables. - - `index.md`: the main page of `http://zeppelin.apache.org/docs/<ZEPPELIN_VERSION>/` - - -## Markdown -Zeppelin documentation pages are written with [Markdown](http://daringfireball.net/projects/markdown/). It is possible to use [GitHub flavored syntax](https://help.github.com/categories/writing-on-github/) and intermix plain HTML. - -## Front matter -Every page contains [YAML front matter](https://jekyllrb.com/docs/frontmatter/) block in their header. Don't forget to wrap the front matter list with triple-dashed lines(`---`) like below. -The document page should start this triple-dashed lines. Or you will face 404 error, since Jekyll can't find the page. - -``` ---- -layout: page -title: "Apache Zeppelin Tutorial" -description: "This tutorial page contains a short walk-through tutorial that uses Apache Spark backend. Please note that this tutorial is valid for Spark 1.3 and higher." -group: quickstart ---- -``` - - - `layout`: the default layout is `page` which is defined in `_layout/page.html`. - - `title`: the title for the document. Please note that if it needs to include `Zeppelin`, it should be `Apache Zeppelin`, not `Zeppelin`. - - `description`: a short description for the document. One or two sentences would be enough. This description also will be shown as an extract sentence when people search pages. - - `group`: a category of the document page - -## Headings -All documents are structured with headings. From these headings, you can automatically generate a **Table of Contents**. There is a simple rule for Zeppelin docs headings. - -``` -# Level-1 heading <- used only for the main title -## Level-2 heading <- start with this -### Level-3 heading -#### Level-4 heading <- won't be converted in TOC from this level -``` - -## Table of contents(TOC) - -``` -<div id="toc"></div> -``` - -Add this line below `# main title` in order to generate a **Table of Contents**. Headings until `### (Level-3 heading)` are included to TOC. - - -Default setting options for TOC are definded in [here](https://github.com/apache/zeppelin/blob/master/docs/assets/themes/zeppelin/js/toc.js#L4). - - -## Adding new pages -If you're going to create new pages, there are some spots you need to add the location of the page. - - - **Dropdown menu in navbar**: add your docs location to [_navigation.html](https://github.com/apache/zeppelin/blob/master/docs/_includes/themes/zeppelin/_navigation.html) - - **Main index**: add your docs below [What is the next?](http://zeppelin.apache.org/docs/latest/#what-is-the-next) section in [index.md](https://github.com/apache/zeppelin/blob/master/docs/index.md) with a short description. No need to do this if the page is for **Interpreters**. http://git-wip-us.apache.org/repos/asf/zeppelin/blob/56bbff3d/docs/README.md ---------------------------------------------------------------------- diff --git a/docs/README.md b/docs/README.md index fdf27fa..a0c4e96 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # Apache Zeppelin documentation -This README will walk you through building the documentation of Apache Zeppelin. The documentation is included here with Apache Zeppelin source code. The online documentation at [https://zeppelin.apache.org/docs/<ZEPPELIN_VERSION>](https://zeppelin.apache.org/docs/latest) is also generated from the files found in here. +This README will walk you through building the documentation of Apache Zeppelin. The documentation is included here with Apache Zeppelin source code. The online documentation at [https://zeppelin.apache.org/docs/<ZEPPELIN_VERSION>](https://zeppelin.apache.org/docs/latest) is also generated from the files found in here. ## Build documentation Zeppelin is using [Jekyll](https://jekyllrb.com/) which is a static site generator and [Github Pages](https://pages.github.com/) as a site publisher. For the more details, see [help.github.com/articles/about-github-pages-and-jekyll/](https://help.github.com/articles/about-github-pages-and-jekyll/). @@ -19,7 +19,7 @@ bundle install For the further information about requirements, please see [here](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements). -On OS X 10.9, you may need to do +On OS X 10.9, you may need to do ``` xcode-select --install @@ -39,7 +39,7 @@ Using the above command, Jekyll will start a web server at `http://localhost:400 ## Contribute to Zeppelin documentation -If you wish to help us and contribute to Zeppelin Documentation, please look at [Zeppelin Documentation's contribution guideline](https://github.com/apache/zeppelin/blob/master/docs/CONTRIBUTING.md). +If you wish to help us and contribute to Zeppelin Documentation, please look at [Zeppelin Documentation's contribution guideline](https://zeppelin.apache.org/contribution/contributions.html). ## For committers only @@ -49,7 +49,7 @@ If you wish to help us and contribute to Zeppelin Documentation, please look at ### Deploy to ASF svnpubsub infra 1. generate static website in `./_site` - + ``` # go to /docs under Zeppelin source bundle exec jekyll build --safe http://git-wip-us.apache.org/repos/asf/zeppelin/blob/56bbff3d/docs/development/writingzeppelininterpreter.md ---------------------------------------------------------------------- diff --git a/docs/development/writingzeppelininterpreter.md b/docs/development/writingzeppelininterpreter.md index c9d4521..4ae1cbc 100644 --- a/docs/development/writingzeppelininterpreter.md +++ b/docs/development/writingzeppelininterpreter.md @@ -42,7 +42,7 @@ In 'Separate Interpreter(scoped / isolated) for each note' mode which you can se Creating a new interpreter is quite simple. Just extend [org.apache.zeppelin.interpreter](https://github.com/apache/zeppelin/blob/master/zeppelin-interpreter/src/main/java/org/apache/zeppelin/interpreter/Interpreter.java) abstract class and implement some methods. You can include `org.apache.zeppelin:zeppelin-interpreter:[VERSION]` artifact in your build system. And you should put your jars under your interpreter directory with a specific directory name. Zeppelin server reads interpreter directories recursively and initializes interpreters including your own interpreter. -There are three locations where you can store your interpreter group, name and other information. Zeppelin server tries to find the location below. Next, Zeppelin tries to find `interpreter-setting.json` in your interpreter jar. +There are three locations where you can store your interpreter group, name and other information. Zeppelin server tries to find the location below. Next, Zeppelin tries to find `interpreter-setting.json` in your interpreter jar. ``` {ZEPPELIN_INTERPRETER_DIR}/{YOUR_OWN_INTERPRETER_DIR}/interpreter-setting.json @@ -73,7 +73,7 @@ Here is an example of `interpreter-setting.json` on your own interpreter. }, { ... - } + } ] ``` @@ -207,7 +207,7 @@ Checkout some interpreters released with Zeppelin by default. We welcome contribution to a new interpreter. Please follow these few steps: - - First, check out the general contribution guide [here](https://github.com/apache/zeppelin/blob/master/CONTRIBUTING.md). + - First, check out the general contribution guide [here](https://zeppelin.apache.org/contribution/contributions.html). - Follow the steps in [Make your own Interpreter](#make-your-own-interpreter) section above. - Add your interpreter as in the [Configure your interpreter](#configure-your-interpreter) section above; also add it to the example template [zeppelin-site.xml.template](https://github.com/apache/zeppelin/blob/master/conf/zeppelin-site.xml.template). - Add tests! They are run by [Travis](https://travis-ci.org/apache/zeppelin) for all changes and it is important that they are self-contained. @@ -215,4 +215,3 @@ We welcome contribution to a new interpreter. Please follow these few steps: - Add documentation on how to use your interpreter under `docs/interpreter/`. Follow the Markdown style as this [example](https://github.com/apache/zeppelin/blob/master/docs/interpreter/elasticsearch.md). Make sure you list config settings and provide working examples on using your interpreter in code boxes in Markdown. Link to images as appropriate (images should go to `docs/assets/themes/zeppelin/img/docs-img/`). And add a link to your documentation in the navigation menu (`docs/_includes/themes/zeppelin/_navigation.html`). - Most importantly, ensure licenses of the transitive closure of all dependencies are list in [license file](https://github.com/apache/zeppelin/blob/master/zeppelin-distribution/src/bin_license/LICENSE). - Commit your changes and open a [Pull Request](https://github.com/apache/zeppelin/pulls) on the project [Mirror on GitHub](https://github.com/apache/zeppelin); check to make sure Travis CI build is passing. - http://git-wip-us.apache.org/repos/asf/zeppelin/blob/56bbff3d/docs/index.md ---------------------------------------------------------------------- diff --git a/docs/index.md b/docs/index.md index 9e0752b..8c2ce95 100644 --- a/docs/index.md +++ b/docs/index.md @@ -115,7 +115,7 @@ If you want to learn more about this feature, please visit [this page](./manual/ <img class="img-responsive" style="margin:0 auto; padding: 15px;" src="./assets/themes/zeppelin/img/asf_logo.png" width="250px"/> -Apache Zeppelin is Apache2 Licensed software. Please check out the [source repository](http://git.apache.org/zeppelin.git) and [how to contribute](./development/howtocontribute.html). +Apache Zeppelin is Apache2 Licensed software. Please check out the [source repository](http://git.apache.org/zeppelin.git) and [how to contribute](https://zeppelin.apache.org/contribution/contributions.html). Apache Zeppelin has a very active development community. Join to our [Mailing list](https://zeppelin.apache.org/community.html) and report issues on [Jira Issue tracker](https://issues.apache.org/jira/browse/ZEPPELIN). @@ -178,8 +178,7 @@ Join to our [Mailing list](https://zeppelin.apache.org/community.html) and repor * [How to contribute (code)](./development/howtocontribute.html) * [How to contribute (documentation website)](./development/howtocontributewebsite.html) -#### External Resources +#### External Resources * [Mailing List](https://zeppelin.apache.org/community.html) * [Apache Zeppelin Wiki](https://cwiki.apache.org/confluence/display/ZEPPELIN/Zeppelin+Home) * [StackOverflow tag `apache-zeppelin`](http://stackoverflow.com/questions/tagged/apache-zeppelin) - http://git-wip-us.apache.org/repos/asf/zeppelin/blob/56bbff3d/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 1aef2ea..364c203 100644 --- a/pom.xml +++ b/pom.xml @@ -384,7 +384,7 @@ </plugin> <!--TODO(alex): make part of the build and reconcile conflicts - <plugin> + <plugin> <groupId>com.ning.maven.plugins</groupId> <artifactId>maven-duplicate-finder-plugin</artifactId> <version>1.0.4</version> @@ -393,12 +393,12 @@ <id>default</id> <phase>verify</phase> <goals> - <goal>check</goal> - </goals> - </execution> - </executions> + <goal>check</goal> + </goals> + </execution> + </executions> <configuration> - <failBuildInCaseOfConflict>true</failBuildInCaseOfConflict> + <failBuildInCaseOfConflict>true</failBuildInCaseOfConflict> </configuration> </plugin> --> @@ -737,7 +737,6 @@ <exclude>**/README.md</exclude> <exclude>DEPENDENCIES</exclude> <exclude>DEPLOY.md</exclude> - <exclude>CONTRIBUTING.md</exclude> <exclude>STYLE.md</exclude> <exclude>Roadmap.md</exclude> <exclude>**/licenses/**</exclude> @@ -775,7 +774,6 @@ <exclude>docs/sitemap.txt</exclude> <exclude>docs/search_data.json</exclude> <exclude>**/dependency-reduced-pom.xml</exclude> - <exclude>docs/CONTRIBUTING.md</exclude> <!-- bundled from anchor --> <exclude>docs/assets/themes/zeppelin/js/anchor.min.js</exclude> http://git-wip-us.apache.org/repos/asf/zeppelin/blob/56bbff3d/zeppelin-web/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/zeppelin-web/CONTRIBUTING.md b/zeppelin-web/CONTRIBUTING.md deleted file mode 100644 index e9a4312..0000000 --- a/zeppelin-web/CONTRIBUTING.md +++ /dev/null @@ -1,127 +0,0 @@ -# Contributing to Zeppelin-Web - -## Dev Mode -When working on Zeppelin's WebApplication, it is recommended to run in dev mode. - -For that, start Zeppelin server normally, then use ``./grunt serve`` in _zeppelin-web_ directory. - -This will launch a Zeppelin WebApplication on port **9000** that will update on code changes. - -## Technologies - -Zeppelin WebApplication is using **AngularJS** as main Framework, and **Grunt** and **Bower** as helpers. - -So you might want to get familiar with it. -[Here is a good start](http://www.sitepoint.com/kickstart-your-angularjs-development-with-yeoman-grunt-and-bower/) -(There is obviously plenty more ressources to learn) - -## Coding style - -* We follow mainly the [Google Javascript Guide](https://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml) -* We use a 2 spaces indentation -* We use single quotes - -But don't worry, Eslint and Jscs will make you remember it for the most part. - -We try not to have **JQuery except in directives**, If you want to include a library, -please search for its **angularJS** directive first. - -If you still need to use it, then please use ``angular.element()`` instead of ``$()`` - -## Folder Structure & Code Organization - -* `src` folder: Contains the Source code for Zeppelin WebApplication -* `dist` folder: Contains the compiled code after using **grunt build** - -### Src and Code Organization - -The `src` folder is organized as such: - -<pre> - src/ - âââ app/ - â âââ name/ - â â âââ name.controller.js - | | âââ name.html - | | âââ subComponent1/ - | | | âââ subComponent1.html - | | | âââ subComponent1.css - â | | âââ subComponent1.controller.js - â â âââ name.css - â âââ app.js - âââ assets/ - â âââ images/ - â âââ styles/ - | âââ looknfeel/ - â âââ printMode.css - âââ components/ - â âââ component1/ - | | âââ component1.html - â | âââ component1.controller.js - â âââ component2/ - âââ fonts/ - | âââ *.{eot,svg,ttf,woff,otf} - â âââ *.css - âââ favico.ico - âââ index.html - âââ 404.html -</pre> - -The code is now organized in a component type of architecture, where everything is logically grouped. - -#### File type name convention - -In order to understand what is contained inside the .js files without opening it, we use some name conventions: -* .controller.js -* .directive.js -* .service.js - -### Component Architecture - -When we talk about Component architecture, we think about grouping files together in a logical way. - -A component can then be made of multiple files like `.html`, `.css` or any other file type mentioned above. - -Related components can be grouped as sub-component as long as they are used in that component only. - - -#### App folder - -Contains the application `app.js` and page related components. -* Home Page -* Interpreter Page -* Notebook Page -etc... - -The only resctiction being that a component in the `app` folder is **not used anywhere else** - -#### Components folder - -The `components` folder is here to contains any reusable component (used more than once) - -### Fonts - -Fonts files and their css are mixed together in the `fonts` folder - -## New files includes - -As we do not use yeoman to generate controllers or other type of files with this new structure, -we need to do some includes manually in `index.html` in order to use dev mode and compile correctly. - -* Non-bower `.js` files needs to be injected between the tag `<!-- build:js({.tmp,src}) scripts/scripts.js -->` -* Css files needs to be injected between the tag `<!-- build:css(.tmp) styles/main.css -->` - -## Add plugins with Bower -``` -bower install <plugin> --save -``` -The file index.html will automatically update with the new bower_component - -<br/> - -**Example**: `./bower install angular-nvd3` - -You should find that line in the index.html file -``` -<script src="bower_components/angular-nvd3/dist/angular-nvd3.js"></script> -```` http://git-wip-us.apache.org/repos/asf/zeppelin/blob/56bbff3d/zeppelin-web/README.md ---------------------------------------------------------------------- diff --git a/zeppelin-web/README.md b/zeppelin-web/README.md index ad4c3bf..1260479 100644 --- a/zeppelin-web/README.md +++ b/zeppelin-web/README.md @@ -61,4 +61,4 @@ also try to add proxy info to npm install command: and retry to build again. ## Contribute on Zeppelin Web -If you wish to help us and contribute to Zeppelin WebApplication, please look at [Zeppelin WebApplication's contribution guideline](CONTRIBUTING.md). +If you wish to help us and contribute to Zeppelin WebApplication, please look at the overall project [contribution guidelines](https://zeppelin.apache.org/contribution/contributions.html) and the more focused [Zeppelin WebApplication's documentation](https://zeppelin.apache.org/contribution/webapplication.html).
