Commit graph

11 commits

Author SHA1 Message Date
AhyoungRyu
8f344db93e [ZEPPELIN-1421] Fix dead link in docs/README.md
### What is this PR for?
There is a dead link in [docs/README.md](https://github.com/apache/zeppelin/blob/master/docs/README.md).

It should be `https://zeppelin.apache.org/docs/latest/` not `https://zeppelin.apache.org/docs/latest`

### What type of PR is it?
Bug Fix

### What is the Jira issue?
[ZEPPELIN-1421](https://issues.apache.org/jira/browse/ZEPPELIN-1421)

### How should this be tested?
 - Before [https://zeppelin.apache.org/docs/latest](https://zeppelin.apache.org/docs/latest)
 - After [https://zeppelin.apache.org/docs/latest/](https://zeppelin.apache.org/docs/latest/)

### Screenshots (if appropriate)

### Questions:
* Does the licenses files need update? no
* Is there breaking changes for older versions? no
* Does this needs documentation? no

Author: AhyoungRyu <fbdkdud93@hanmail.net>

Closes #1420 from AhyoungRyu/ZEPPELIN-1421 and squashes the following commits:

57336f8 [AhyoungRyu] Remove BASE_PATH in some docs pages
311e2ef [AhyoungRyu] Fix dead link in docs/README.md
2016-09-19 15:50:43 +09:00
Damien CORNEAU
56bbff3d3d [ZEPPELIN-1414] Remove CONTRIBUTING.md files
### What is this PR for?
Following the PR #1356, we now have the contribution documentation to on Apache Zeppelin Website.

We can now remove the contributing files from the repository, and replace the links to that documentation.

### What type of PR is it?
Documentation

### What is the Jira issue?
https://issues.apache.org/jira/browse/ZEPPELIN-1414

### How should this be tested?
Just check if there is other CONTRIBUTING.md files and if there is other links to replace

### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No

Author: Damien CORNEAU <corneadoug@gmail.com>

Closes #1406 from corneadoug/ZEPPELIN-1414 and squashes the following commits:

4347043 [Damien CORNEAU] change a how to contribute link to the webiste in the docs
faf3e11 [Damien CORNEAU] Make links to contribution material point to the website
cb4b5f7 [Damien CORNEAU] Remove contributing files from RAT
7810f57 [Damien CORNEAU] Remove contributing files
2016-09-09 08:04:10 +09:00
AhyoungRyu
ff2465b9da [ZEPPELIN-1323] Add contribution guide for Zeppelin documentation
### What is this PR for?
Recently I added auto generated Table of Contents by #1031 and searching feature by #1266. So I wrote some guide to `docs/CONTRIBUTING.md` about how to use and how they can be applied to docs page. Hope this helps to new Zeppelin (docs) contributors :)

### What type of PR is it?
Documentation

### Todos
* [x] - Update `docs/README.md`

### What is the Jira issue?
[ZEPPELIN-1323](https://issues.apache.org/jira/browse/ZEPPELIN-1323)

### How should this be tested?
Just click `View` button on the top of the file diff :)

### Screenshots (if appropriate)

### Questions:
* Does the licenses files need update? no
* Is there breaking changes for older versions? no
* Does this needs documentation? no

Author: AhyoungRyu <fbdkdud93@hanmail.net>

Closes #1326 from AhyoungRyu/ZEPPELIN-1323 and squashes the following commits:

e23286b [AhyoungRyu] Update some contents
f74c676 [AhyoungRyu] Attach 'Apache' to the title in README.md
f1eb6b3 [AhyoungRyu] Change Zeppelin docs link version to latest
2879ada [AhyoungRyu] Exclude docs/CONTRIBUTING.md
2f7520b [AhyoungRyu] Remove useless back slash
b58183b [AhyoungRyu] Add new files: CONTRIBUTING.md
3c05b47 [AhyoungRyu] Update contents in docs/README.md
2016-08-18 23:42:07 -07:00
AhyoungRyu
28b478d955 [ZEPPELIN-813] Update safe_yaml version 0.9.7 -> 1.0.4
### What is this PR for?
This PR will fix [ZEPPELIN-813](https://issues.apache.org/jira/browse/ZEPPELIN-813).
I'm not sure what environment exactly generate this errors. I saw the below error in OS X 10.11.3
and ruby 2.3.0.

```
$ bundle exec jekyll serve --watch
/Users/cyhsutw/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/commander-4.1.5/lib/commander/user_interaction.rb:328: warning: constant ::TimeoutError is deprecated
/Users/cyhsutw/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/commander-4.1.5/lib/commander/runner.rb:365:in `block in require_program': program version required (Commander::Runner::CommandError)
	from /Users/cyhsutw/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/commander-4.1.5/lib/commander/runner.rb:364:in `each'
	from /Users/cyhsutw/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/commander-4.1.5/lib/commander/runner.rb:364:in `require_program'
	from /Users/cyhsutw/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/commander-4.1.5/lib/commander/runner.rb:52:in `run!'
	from /Users/cyhsutw/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/commander-4.1.5/lib/commander/delegates.rb:7:in `run!'
	from /Users/cyhsutw/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/commander-4.1.5/lib/commander/import.rb:10:in `block in <top (required)>'
/Users/cyhsutw/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/safe_yaml-0.9.7/lib/safe_yaml/syck_node_monkeypatch.rb:42:in `<top (required)>': uninitialized constant Syck (NameError)
	from /Users/cyhsutw/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/safe_yaml-0.9.7/lib/safe_yaml.rb:200:in `require'
	from /Users/cyhsutw/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/safe_yaml-0.9.7/lib/safe_yaml.rb:200:in `<module:YAML>'
	from /Users/cyhsutw/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/safe_yaml-0.9.7/lib/safe_yaml.rb:132:in `<top (required)>'
	from /Users/cyhsutw/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/jekyll-1.3.0/lib/jekyll.rb:21:in `require'
	from /Users/cyhsutw/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/jekyll-1.3.0/lib/jekyll.rb:21:in `<top (required)>'
	from /Users/cyhsutw/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/jekyll-1.3.0/bin/jekyll:7:in `require'
	from /Users/cyhsutw/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/jekyll-1.3.0/bin/jekyll:7:in `<top (required)>'
	from /Users/cyhsutw/.rbenv/versions/2.3.0/bin/jekyll:23:in `load'
	from /Users/cyhsutw/.rbenv/versions/2.3.0/bin/jekyll:23:in `<main>'
```

Maybe this error will be gone with `bundle update`. But it would be better we set `safe_yaml` version for the other users. So I just updated `safe_yaml` version from `0.9.7` to `1.0.4` in `Gemfile.lock` manually. And confirmed that there are no compatibility issues with ruby version `2.3.0`(latest stable version), `2.2.1`, `2.1.1` and `2.0.0`(this version is no longer maintained by ruby).

I also updated `docs/README.md` since we need ruby version higher than `2.0.0` not `1.9.3`. Please see [here](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements).

### What type of PR is it?
Bug Fix & Documentation

### What is the Jira issue?
[ZEPPELIN-813](https://issues.apache.org/jira/browse/ZEPPELIN-813)

### How should this be tested?

###### 1. Apply this patch

```
$ cd docs
$ bundle install
```
If you already installed dependencies before, you need

```
$ bundle update safe_yaml
```

###### 2. Check what version of `safe_yaml` is installed -> `1.0.4` should be installed. Then

```
$ bundle exec jekyll serve --watch
```
It should be run with no issues.

### Questions:
* Does the licenses files need update? no
* Is there breaking changes for older versions? no
* Does this needs documentation? no

Author: AhyoungRyu <fbdkdud93@hanmail.net>

Closes #1167 from AhyoungRyu/ZEPPELIN-813 and squashes the following commits:

458957d [AhyoungRyu] Add a newline
9cf8b42 [AhyoungRyu] Update docs/README.md
a2fd980 [AhyoungRyu] Update safe_yaml version 0.9.7 -> 1.0.4
2016-07-21 11:01:44 +09:00
Mina Lee
4a4691fa59 [MINOR] Make nav zeppelin version to point ZEPPELIN_VERSION in _config.yml
### What is this PR for?
One less line to change when releasing docs by making `ZEPPELIN_VERSION` to be retrieved from `_config.yml`.

### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? Will be updated in https://cwiki.apache.org/confluence/display/ZEPPELIN/Preparing+Zeppelin+Release

Author: Mina Lee <minalee@apache.org>

Closes #997 from minahlee/docs/navZeppelinVersion and squashes the following commits:

dd547b2 [Mina Lee] Make nav zeppelin version to point ZEPPELIN_VERSION in _config.yml
2016-06-14 09:40:49 -07:00
Mina Lee
81adf09f21 [ZEPPELIN-980] Move git repository from incubator-zeppelin to zeppelin
### What is this PR for?
git repo infra have moved from incubator-zeppelin to zeppelin

### What type of PR is it?
Hot Fix

### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No

Author: Mina Lee <minalee@apache.org>

Closes #983 from minahlee/ZEPPELIN-980 and squashes the following commits:

7542c31 [Mina Lee] remove travis url after travis migration is done
3793b38 [Mina Lee] Move git repository from incubator-zeppelin to zeppelin
2016-06-10 09:02:41 -07:00
Felix Cheung
4ac7ff5ca4 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 <felixcheung_m@hotmail.com>

Closes #723 from felixcheung/docreadme and squashes the following commits:

7bbf93a [Felix Cheung] typo
565a3a5 [Felix Cheung] update doc
2016-02-17 12:36:00 -08:00
Lee moon soo
e4ff4c0353 ZEPPELIN-448 Update documentation for Spark configuration and BASE_PATH change
https://issues.apache.org/jira/browse/ZEPPELIN-448

Addresses update documentation for Spark configuration.

And BASE_PATH change after #430, #431 is deployed.
(currently deployed website has this change applied)

Author: Lee moon soo <moon@apache.org>

Closes #448 from Leemoonsoo/update_install and squashes the following commits:

54e2edf [Lee moon soo] add newline
cbd95d6 [Lee moon soo] Add description for included version of spark when SPARK_HOME is not set
00099ad [Lee moon soo] Add description for bumping up version
cf99212 [Lee moon soo] Fix typo
ab6d267 [Lee moon soo] Update BASE_PATH
73a737c [Lee moon soo] Remove instruction for 0.5.0 as zeppelin has documentation per version
4369f3e [Lee moon soo] Fix link
dcdaa74 [Lee moon soo] Add more configurations possible
8c9361d [Lee moon soo] Change font style
de74e6b [Lee moon soo] Update install and configuring spark
2015-11-21 15:25:14 +09:00
Lee moon soo
c2cbafd1d8 ZEPPELIN-412 Documentation based on Zeppelin version
https://issues.apache.org/jira/browse/ZEPPELIN-412

To provide documentation based on Zeppelin version, like Spark, Flink project does, it need to separate documentations from website.

* docs will be kept in Zeppelin main source tree and being built and published under 'docs' menu on website with specific version number.
* website will be kept in gh-pages branch and provides menu for multiple version of docs.

This PR removes unnecessary pages, which is provided by website. (for example download page)

This is the screenshot after applying this PR

![image](https://cloud.githubusercontent.com/assets/1540981/11163334/53a14c7a-8b0e-11e5-80cb-961bb8a15faa.png)

![image](https://cloud.githubusercontent.com/assets/1540981/11163335/5acc9f22-8b0e-11e5-8329-273bee738cc9.png)

Author: Lee moon soo <moon@apache.org>

Closes #430 from Leemoonsoo/ZEPPELIN-412 and squashes the following commits:

35da7f2 [Lee moon soo] Remove docs dir
5e4ce12 [Lee moon soo] Update readme
0635cbb [Lee moon soo] Remove unnecessary pages
e21cdd2 [Lee moon soo] Style font size
b5fe812 [Lee moon soo] Change title to overview
469b850 [Lee moon soo] Get remove unnecessary menu
2015-11-18 09:08:54 +09:00
Alexander Bezzubov
82ea80dc6a ZEPPELIN-296 add flink docs
[ZEPPELIN-296](https://issues.apache.org/jira/browse/ZEPPELIN-296) initial documentation for Apache Flink interpreter

While we are at it, there are some minor updates for the docs too.

Author: Alexander Bezzubov <abezzubov@nflabs.com>

Closes #303 from bzz/ZEPPELIN-296-add-flink-docs and squashes the following commits:

8a2f909 [Alexander Bezzubov] ZEPPELIN-296: initial Flink interpreter docs
8e87683 [Alexander Bezzubov] Update /docs README
f85b4cd [Alexander Bezzubov] Update /download page
2015-10-05 08:30:54 +09:00
Alexander Bezzubov
d1d32b1172 ZEPPELIN-279: move website w/ docs to master branch
Details at the [ZEPPELIN-279](https://issues.apache.org/jira/browse/ZEPPELIN-279)

Author: Alexander Bezzubov <bzz@apache.org>

Closes #282 from bzz/ZEPPELIN-279-move-docs-to-master and squashes the following commits:

16d2cd0 [Alexander Bezzubov] ZEPPELIN-279: updating refs to new /docs location
a051a35 [Alexander Bezzubov] ZEPPELIN-279: moving website gh-pages -> master:/docs
2015-09-05 19:48:22 +09:00