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

Update contents in docs/README.md

Browse source
This commit is contained in:
AhyoungRyu 2016-08-12 19:06:32 +09:00
parent 74c975641b
commit 3c05b474c2
1 changed files with 32 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
docs/README.md
View file

@ -1,41 +1,55 @@
## Apache Zeppelin documentation
This readme will walk you through building the Zeppelin documentation, which is included here with the Zeppelin source code.
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
See https://help.github.com/articles/using-jekyll-with-pages#installing-jekyll
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/).
**Requirements**
```
ruby --version >= 2.0.0
gem install bundler
# go to /docs under your Zeppelin source
bundle install
# ruby --version >= 2.0.0
# Install Bundler using gem
gem install bundler
cd $ZEPPELIN_HOME/docs
# Install all dependencies declared in the Gemfile
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).
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 "xcode-select --install"*
On OS X 10.9, you may need to do
```
xcode-select --install
```
## Run website locally
If you don't want to encounter uglily rendered pages, run the documentation site in your local first.
In `$ZEPPELIN_HOME/docs`,
```
bundle exec jekyll serve --watch
```
Using the above command, Jekyll will start a web server at `http://localhost:4000` and watch the `/docs` directory to update.
## Run website
bundle exec jekyll serve --watch
## 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).
## Adding a new page
rake page name="new-page.md"
## Bumping up version in a new release
## For committers only
### Bumping up version in a new release
* `ZEPPELIN_VERSION` and `BASE_PATH` property in _config.yml
## Deploy to ASF svnpubsub infra (for committers only)
### Deploy to ASF svnpubsub infra
1. generate static website in `./_site`
```
# go to /docs under Zeppelin source
bundle exec jekyll build --safe