mirror of
https://github.com/apache/zeppelin
synced 2026-05-24 09:38:26 +00:00
70d22d3d0a
### What is this PR for? Most of other projects have **Quick Start** or **Getting Started** page for the beginner. Currently, Zeppelin also has [Zeppelin Install](https://zeppelin.apache.org/docs/0.6.0-SNAPSHOT/install/install.html) which is similar with those kind of instruction page. But it has only contents that explain just installation and configuration. So I updated this page to **Quick Start** so that it can include step by step guide for the beginners. ### What type of PR is it? Improvement & Documentation ### Todos * [x] - Add each title link to the head of documentation * [x] - Add more information about Zeppelin installation * [x] - Reorder contents ### What is the Jira issue? [ZEPPELIN-998](https://issues.apache.org/jira/browse/ZEPPELIN-998) ### How should this be tested? See the attached screenshot images ### Screenshots (if appropriate) <img width="809" alt="screen shot 2016-06-14 at 2 59 47 pm" src="https://cloud.githubusercontent.com/assets/10060731/16061227/d88abe56-3240-11e6-845c-e37a9975aceb.png"> <img width="796" alt="screen shot 2016-06-14 at 3 00 01 pm" src="https://cloud.githubusercontent.com/assets/10060731/16061229/daca8b06-3240-11e6-821b-7d118b7b3e09.png"> <img width="789" alt="screen shot 2016-06-14 at 3 00 15 pm" src="https://cloud.githubusercontent.com/assets/10060731/16061234/dd12072c-3240-11e6-9a0a-cf1e320fd879.png"> <img width="785" alt="screen shot 2016-06-14 at 3 00 27 pm" src="https://cloud.githubusercontent.com/assets/10060731/16061238/df7f904c-3240-11e6-83e0-73f3688c0815.png"> <img width="789" alt="screen shot 2016-06-14 at 3 00 38 pm" src="https://cloud.githubusercontent.com/assets/10060731/16061242/e1ad1402-3240-11e6-81ba-2e7125cec98e.png"> ### Questions: * Does the licenses files need update? No * Is there breaking changes for older versions? No * Does this needs documentation? No Author: AhyoungRyu <fbdkdud93@hanmail.net> Closes #1010 from AhyoungRyu/ZEPPELIN-998 and squashes the following commits: |
||
|---|---|---|
| .. | ||
| _includes | ||
| _layouts | ||
| _plugins | ||
| assets/themes/zeppelin | ||
| development | ||
| displaysystem | ||
| install | ||
| interpreter | ||
| manual | ||
| quickstart | ||
| rest-api | ||
| security | ||
| storage | ||
| 404.html | ||
| _config.yml | ||
| atom.xml | ||
| Gemfile | ||
| Gemfile.lock | ||
| index.md | ||
| pleasecontribute.md | ||
| Rakefile | ||
| README.md | ||
| robot.txt | ||
| rss.xml | ||
| screenshots.md | ||
| sitemap.txt | ||
Zeppelin documentation
This readme will walk you through building the Zeppelin documentation, which is included here with the Zeppelin source code.
Build documentation
See https://help.github.com/articles/using-jekyll-with-pages#installing-jekyll
tl;dr version:
ruby --version >= 1.9.3
gem install bundler
# go to /docs under your Zeppelin source
bundle install
On OS X 10.9 you may need to do "xcode-select --install"
Run website
bundle exec jekyll serve --watch
Adding a new page
rake page name="new-page.md"
Bumping up version in a new release
ZEPPELIN_VERSIONandBASE_PATHproperty in _config.yml
Deploy to ASF svnpubsub infra (for committers only)
-
generate static website in
./_site# go to /docs under Zeppelin source bundle exec jekyll build --safe -
checkout ASF repo
svn co https://svn.apache.org/repos/asf/zeppelin asf-zeppelin -
copy
zeppelin/docs/_sitetoasf-zeppelin/site/docs/[VERSION] -
svn commit