diff --git a/docs/README.md b/docs/README.md index 82a752ffae4..2c6b0018cab 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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"* @@ -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 ([VERSION])` 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 ([VERSION])` in _includes/themes/zeppelin/_navigation.html - -need to be updated