zeppelin/docs/development/howtocontributewebsite.md
k 3244a56105 [MINOR][DOC] Fix typo (re-open PR #1541 with rebase)
### What is this PR for?
Fix minor typos in docs

### What type of PR is it?
Documentation

### Questions:
* Does the licenses files need update? no
* Is there breaking changes for older versions? no
* Does this needs documentation? no

Author: k <K@kui-MacBook-Pro.local>
Author: Mina Lee <minalee@apache.org>
Author: laesunk <laesunk@gmail.com>

Closes #1542 from laesunk/fix_typo and squashes the following commits:

7b703a7 [laesunk] Merge pull request #1 from minahlee/fix_typo
28fc9ce [Mina Lee] Fix more typos
a55ae4a [Mina Lee] Restore wrong changes during rebase
190ac05 [k] fix words
01ce71b [k] fix likly
2016-10-23 12:44:06 +09:00

3.7 KiB

layout title description group
page Contributing to Apache Zeppelin (Website) How can you contribute to Apache Zeppelin project website? This document covers from building Zeppelin documentation site to making a pull request on Github. development

{% include JB/setup %}

Contributing to Apache Zeppelin ( Website )

This page will give you an overview of how to build and contribute to the documentation of Apache Zeppelin. The online documentation at zeppelin.apache.org is also generated from the files found here.

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

Getting the source code

First of all, you need Zeppelin source code. The official location of Zeppelin is http://git.apache.org/zeppelin.git. Documentation website is hosted in 'master' branch under /docs/ dir.

git access

First of all, you need the website source code. The official location of mirror for Zeppelin is http://git.apache.org/zeppelin.git. Get the source code on your development machine using git.

git clone git://git.apache.org/zeppelin.git
cd docs

Apache Zeppelin follows Fork & Pull as a source control workflow. If you want to not only build Zeppelin but also make any changes, then you need to fork Zeppelin github mirror repository and make a pull request.

Build

You'll need to install some prerequisites to build the code. Please check Build documentation section in docs/README.md.

Run website in development mode

While you're modifying website, you might want to see preview of it. Please check Run website section in docs/README.md. Then you'll be able to access it on http://localhost:4000 with your web browser.

Making a Pull Request

When you are ready, just make a pull-request.

Alternative way

You can directly edit .md files in /docs/ directory at the web interface of github and make pull-request immediately.

Stay involved

Contributors should join the Zeppelin mailing lists.

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

If you have any issues, create a ticket in JIRA.