Skip to content

Commit 3c05b47

Browse files
committed
Update contents in docs/README.md
1 parent 74c9756 commit 3c05b47

File tree

1 file changed

+29
-15
lines changed

1 file changed

+29
-15
lines changed

docs/README.md

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,55 @@
11
## Apache Zeppelin documentation
22

3-
This readme will walk you through building the Zeppelin documentation, which is included here with the Zeppelin source code.
4-
3+
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.
54

65
## Build documentation
7-
See https://help.github.com/articles/using-jekyll-with-pages#installing-jekyll
6+
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/).
87

98
**Requirements**
109

1110
```
12-
ruby --version >= 2.0.0
13-
gem install bundler
14-
# go to /docs under your Zeppelin source
15-
bundle install
11+
# ruby --version >= 2.0.0
12+
# Install Bundler using gem
13+
gem install bundler
14+
15+
cd $ZEPPELIN_HOME/docs
16+
# Install all dependencies declared in the Gemfile
17+
bundle install
1618
```
1719

18-
For the further information about requirements, please see [here](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements).
20+
For the further information about requirements, please see [here](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements).
21+
22+
On OS X 10.9, you may need to do
23+
24+
```
25+
xcode-select --install
26+
```
1927

20-
*On OS X 10.9 you may need to do "xcode-select --install"*
28+
## Run website locally
29+
If you don't want to encounter uglily rendered pages, run the documentation site in your local first.
2130

31+
In `$ZEPPELIN_HOME/docs`,
2232

23-
## Run website
33+
```
34+
bundle exec jekyll serve --watch
35+
```
2436

25-
bundle exec jekyll serve --watch
37+
Using the above command, Jekyll will start a web server at `http://localhost:4000` and watch the `/docs` directory to update.
2638

2739

28-
## Adding a new page
2940

30-
rake page name="new-page.md"
41+
## Contribute to Zeppelin documentation
42+
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).
3143

3244

33-
## Bumping up version in a new release
45+
## For committers only
46+
### Bumping up version in a new release
3447

3548
* `ZEPPELIN_VERSION` and `BASE_PATH` property in _config.yml
3649

37-
## Deploy to ASF svnpubsub infra (for committers only)
50+
### Deploy to ASF svnpubsub infra
3851
1. generate static website in `./_site`
52+
3953
```
4054
# go to /docs under Zeppelin source
4155
bundle exec jekyll build --safe

0 commit comments

Comments
 (0)