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 apache#723 from felixcheung/docreadme and squashes the following commits: 7bbf93a [Felix Cheung] typo 565a3a5 [Felix Cheung] update doc
sashashura · Feb 17, 2016 · 4ac7ff5 · 4ac7ff5
1 parent 2f73712
commit 4ac7ff5
Showing 1 changed file with 20 additions and 17 deletions.
diff --git 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