](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
diff --git a/docs/development/writingzeppelininterpreter.md b/docs/development/writingzeppelininterpreter.md
index c9d45219dad..4ae1cbcca06 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.
-
diff --git a/docs/index.md b/docs/index.md
index 9e0752b5e39..8c2ce95cc95 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/
-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)
-
diff --git a/pom.xml b/pom.xml
index 2ac72cf3678..d0f43885514 100644
--- a/pom.xml
+++ b/pom.xml
@@ -384,7 +384,7 @@
@@ -734,7 +734,6 @@
**/README.md
DEPENDENCIES
DEPLOY.md
- CONTRIBUTING.md
STYLE.md
Roadmap.md
**/licenses/**
@@ -772,7 +771,6 @@
docs/sitemap.txt
docs/search_data.json
**/dependency-reduced-pom.xml
- docs/CONTRIBUTING.md
docs/assets/themes/zeppelin/js/anchor.min.js
diff --git a/zeppelin-web/CONTRIBUTING.md b/zeppelin-web/CONTRIBUTING.md
deleted file mode 100644
index e9a4312fbd9..00000000000
--- 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:
-
-
- 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
-
-
-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 ``
-* Css files needs to be injected between the tag ``
-
-## Add plugins with Bower
-```
-bower install --save
-```
-The file index.html will automatically update with the new bower_component
-
-
-
-**Example**: `./bower install angular-nvd3`
-
-You should find that line in the index.html file
-```
-
-````
diff --git a/zeppelin-web/README.md b/zeppelin-web/README.md
index ad4c3bfc037..1260479e796 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).