Elgato_dark/zeppelin
1
0
Fork 0
mirror of https://github.com/apache/zeppelin synced 2026-05-24 09:38:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
zeppelin/docs/development/howtocontributewebsite.md
Lee moon soo c2cbafd1d8 ZEPPELIN-412 Documentation based on Zeppelin version 
https://issues.apache.org/jira/browse/ZEPPELIN-412

To provide documentation based on Zeppelin version, like Spark, Flink project does, it need to separate documentations from website.

* docs will be kept in Zeppelin main source tree and being built and published under 'docs' menu on website with specific version number.
* website will be kept in gh-pages branch and provides menu for multiple version of docs.

This PR removes unnecessary pages, which is provided by website. (for example download page)

This is the screenshot after applying this PR

![image](https://cloud.githubusercontent.com/assets/1540981/11163334/53a14c7a-8b0e-11e5-80cb-961bb8a15faa.png)

![image](https://cloud.githubusercontent.com/assets/1540981/11163335/5acc9f22-8b0e-11e5-8329-273bee738cc9.png)

Author: Lee moon soo <moon@apache.org>

Closes #430 from Leemoonsoo/ZEPPELIN-412 and squashes the following commits:

35da7f2 [Lee moon soo] Remove docs dir
5e4ce12 [Lee moon soo] Update readme
0635cbb [Lee moon soo] Remove unnecessary pages
e21cdd2 [Lee moon soo] Style font size
b5fe812 [Lee moon soo] Change title to overview
469b850 [Lee moon soo] Get remove unnecessary menu
2015-11-18 09:08:54 +09:00

2.2 KiB
Raw Blame History

layout title description group
page How to contribute (website) How to contribute (website) development

IMPORTANT

Apache Zeppelin (incubating) is an Apache2 License Software. Any contribution to Zeppelin (Source code, Documents, Image, Website) means you agree license all your contributions as Apache2 License.

Modifying the website


#### Getting the source code Website is hosted in 'master' branch under `/docs/` dir.

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

Get the source code on your development machine using git.

git clone https://github.com/apache/incubator-zeppelin.git
cd docs

#### Build

To build, you'll need to install some prerequisites.

Please check 'Build' section on docs/README.md


#### Run website in development mode

While you're modifying website, you'll want to see preview of it.

Please check 'Run' section on docs/README.md

You'll be able to access it on localhost:4000 with your webbrowser.


#### Pull request

When you're ready, just make a pull-request.


### Alternative way

You can directly edit .md files in /docs/ dir at github's web interface and make pull-request immediatly.


### JIRA Zeppelin manages its issues in Jira. [https://issues.apache.org/jira/browse/ZEPPELIN](https://issues.apache.org/jira/browse/ZEPPELIN)

Stay involved

Contributors should join the Zeppelin mailing lists.

  • dev@zeppelin.incubator.apache.org is for people who want to contribute code to Zeppelin. [subscribe](mailto:dev-subscribe@zeppelin.incubator.apache.org?subject=send this email to subscribe), [unsubscribe](mailto:dev-unsubscribe@zeppelin.incubator.apache.org?subject=send this email to unsubscribe), archives