Skip to content

update README for doc #723

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
felixcheung wants to merge 2 commits into from
Closed

update README for doc #723

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
565a3a5
update doc
felixcheung Feb 17, 2016
7bbf93a
typo
felixcheung Feb 17, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 20 additions & 17 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,13 @@ 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"*


Expand All @@ -20,28 +23,28 @@ See https://help.github.com/articles/using-jekyll-with-pages#installing-jekyll
bundle exec jekyll serve --watch


## Deploy to ASF svnpubsub infra (commiters only)
## Adding a new page

rake page name="new-page.md"


## Bumping up version in a new release

* `ZEPPELIN_VERSION` and `BASE_PATH` property in _config.yml
* `Zeppelin <small>([VERSION])</small>` in _includes/themes/zeppelin/_navigation.html
should be updated


## Deploy to ASF svnpubsub infra (for committers only)
1. generate static website in `./_site`
```
# go to /docs under Zeppelin source
bundle exec jekyll build --safe
```

2. checkout ASF repo
```
svn co https://svn.apache.org/repos/asf/incubator/zeppelin asf-zepplelin
svn co https://svn.apache.org/repos/asf/incubator/zeppelin asf-zeppelin
```
3. copy zeppelin/_site to asf-zepplelin/site/docs/[VERSION]
3. copy `zeppelin/docs/_site` to `asf-zeppelin/site/docs/[VERSION]`
4. ```svn commit```

## Adding a new page

rake page name="new-page.md"



## Bumping up version

* `BASE_PATH` property in _config.yml
* `ZEPPELIN <small>([VERSION])</small>` in _includes/themes/zeppelin/_navigation.html

need to be updated