Repository: incubator-zeppelin Updated Branches: refs/heads/master 2f737121e -> 4ac7ff5ca
update README for doc ### What is this PR for? Updating doc for the Zeppelin docs ### What type of PR is it? Documentation ### Todos * [x] - Update doc ### Is there a relevant Jira issue? N/A ### How should this be tested? N/A ### Screenshots (if appropriate) N/A ### Questions: * Does the licenses files need update? No * Is there breaking changes for older versions? No * Does this needs documentation? This is Author: Felix Cheung <[email protected]> Closes #723 from felixcheung/docreadme and squashes the following commits: 7bbf93a [Felix Cheung] typo 565a3a5 [Felix Cheung] update doc Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/4ac7ff5c Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/4ac7ff5c Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/4ac7ff5c Branch: refs/heads/master Commit: 4ac7ff5ca41a6798638666a842fd88cf1126af34 Parents: 2f73712 Author: Felix Cheung <[email protected]> Authored: Tue Feb 16 17:04:02 2016 -0800 Committer: Lee moon soo <[email protected]> Committed: Wed Feb 17 12:36:00 2016 -0800 ---------------------------------------------------------------------- docs/README.md | 37 ++++++++++++++++++++----------------- 1 file changed, 20 insertions(+), 17 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/4ac7ff5c/docs/README.md ---------------------------------------------------------------------- diff --git a/docs/README.md b/docs/README.md index 82a752f..2c6b001 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 <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
