Skip to content

Conversation

@AhyoungRyu
Copy link
Contributor

What is this PR for?

It would be better if Zeppelin provides looking good documentation.

What type of PR is it?

Improvement

Todos

  • - Fix typos, grammars and Increase readability writingzeppelininterpreter.md
  • - Also spark.md
  • - tutorial.md
  • - cassandra.md
  • - elasticsearch.md
  • - flink.md
  • - hive.md
  • - lens.md
  • - markdown.md
  • - rest-interpreter.md

Is there a relevant Jira issue?

No : )

How should this be tested?

These documentations are in here.

Screenshots (if appropriate)

Questions:

  • Does the licenses files need update? No
  • Is there breaking changes for older versions? No
  • Does this needs documentation? No

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

./bin/zeppelin-daemon.sh start is the correct one.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right. I fixed it.

@AhyoungRyu AhyoungRyu changed the title Fix some typos and grammars in writingzeppelininterpreter.md [WIP] Fix some typos and grammars in writingzeppelininterpreter.md Dec 29, 2015
@AhyoungRyu AhyoungRyu changed the title [WIP] Fix some typos and grammars in writingzeppelininterpreter.md [WIP] Fix some typos, grammars and Increase readability documentation Dec 29, 2015
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: space between l and `

@AhyoungRyu
Copy link
Contributor Author

@HeartSaVioR Thank you for your kind reviewing! I applied the comments that you mentioned.
And I'll commit the rest of TODO.

@AhyoungRyu AhyoungRyu changed the title [WIP] Fix some typos, grammars and Increase readability documentation Fix some typos, grammars and Increase readability documentation Jan 8, 2016
@AhyoungRyu
Copy link
Contributor Author

I checked out several docs pages(in the above TODO list), since there are some grammar error or typos or bad alignment. Actually I want to checkout another pages too in this PR, but I saw the other PR which fix same docs pages. So after this PR merged, I will open another PR for them.

So far, below pages also have to be checked.

  • - install.md (a table in this docs is little bit not pretty(?))
  • - table.md
  • - angular.md
  • - notebookashomepage.md
  • - rest-notebook.md
  • - howtocontribute.md
  • - howtocontributewebsite.md
  • - Remove the duplicated section between interpreter.md and writingzeppelininterpreter.md
  • - Divide display.md into text.md & html.md
  • - Divide storage.md into gitstorage.md & s3storage.md

@AhyoungRyu
Copy link
Contributor Author

So, ready to review : )

@AhyoungRyu AhyoungRyu closed this Jan 8, 2016
@AhyoungRyu AhyoungRyu reopened this Jan 8, 2016
@Leemoonsoo
Copy link
Member

LGTM. Thanks @AhyoungRyu improving docs!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we might want to keep lowered case for null, boolean tuple and udt since the actual types are lowered case? http://docs.datastax.com/en/cql/3.1/cql/cql_reference/tupleType.html

@AhyoungRyu
Copy link
Contributor Author

@felixcheung
I really appreciate to your prudent review : )
All your comments are make sense, so I applied them.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once you have build....
-> Once you have built your interpreter, you can place it under the interpreter directory with all its dependencies.

@corneadoug
Copy link
Contributor

While reviewing this PR, I found out that the docs/development/writingzeppelininterpreter.md might not be accurate.

For example, in https://github.com/apache/incubator-zeppelin/blob/master/docs/development/writingzeppelininterpreter.md#configure-your-interpreter

The interpreter should be added to conf/zeppelin-site.xml.template only (since conf/zeppelin-site.xml is user configuration)

And the part about default configuration should not be as a 'Note' but as a step to do.

In the end, it should look like this:

Configure your interpreter

To configure your interpreter you need to follow these steps:

  1. Add your interpreter class name to the zeppelin.interpreters property in conf/zeppelin-site.xml.template

    Property value is comma separated [INTERPRETER_CLASS_NAME].

    For example:

    <property>
    <name>zeppelin.interpreters</name>
    <value>org.apache.zeppelin.spark.SparkInterpreter,org.apache.zeppelin.spark.PySparkInterpreter,org.apache.zeppelin.spark.SparkSqlInterpreter,org.apache.zeppelin.spark.DepInterpreter,org.apache.zeppelin.markdown.Markdown,org.apache.zeppelin.shell.ShellInterpreter,org.apache.zeppelin.hive.HiveInterpreter,com.me.MyNewInterpreter</value>
    </property>
    
  2. Add your interpreter to the default configuration which is used when there is no zeppelin-site.xml.

  3. Start zeppelin by running ./bin/zeppelin-deamon start

  4. In the interpreter page, click the +Create button and configure your interpreter properties.
    Now you are done and ready to use your interpreter.

@felixcheung
Copy link
Member

@corneadoug looks good, I'd only add in 2, instead of a specific line number, could we refer to it as:
"
Add your interpreter to the ZEPPELIN_INTERPRETERS() list in zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java
"

@felixcheung
Copy link
Member

... although, shouldn't point 1 & 2 be part of https://github.com/apache/incubator-zeppelin/blob/master/docs/development/writingzeppelininterpreter.md#make-your-own-interpreter instead they should be code changes to include in the PR for the new interpreter?

@corneadoug
Copy link
Contributor

@felixcheung I thing its fine in this category since the step before is adding the interpreter under the right folder

@felixcheung
Copy link
Member

@corneadoug but point 2 is code change that someone creating a new interpreter should do, right?

@corneadoug
Copy link
Contributor

Yes, but its more things to do when adding the interpreter to Zeppelin

@AhyoungRyu
Copy link
Contributor Author

@corneadoug @felixcheung I applied the comments : )

@corneadoug
Copy link
Contributor

Honestly, there is too much changes in that PR to properly review all the grammar and sentences.
But I think that overall the changes are good, and people can always fix the docs later :) LGTM

@Leemoonsoo
Copy link
Member

LGTM i'm merging

@asfgit asfgit closed this in 8c848f0 Jan 17, 2016
asfgit pushed a commit that referenced this pull request Jan 21, 2016
Due to the documentation of interpreters written by various authors, styles of documentations are vary and has broken tags and inconsistent spaces. This fix cleans those little glitches to make documentation more readable and look cleaner to users.

1) Clean up unnecessary or wrong HTML tags ex: \<hr/\> after titles
2) Fix too wide spaces between paragraph and tables
3) Remove unnecessary spaces at end of paragraph and lines

Author: Jesang Yoon <yoonjs2@kanizsalab.com>

Closes #648 from yoonjs2/master and squashes the following commits:

eba0315 [Jesang Yoon] Merge remote-tracking branch 'upstream/master'
db8b4da [Jesang Yoon] Merge remote-tracking branch 'upstream/master'
781954b [Jesang Yoon] Interpreter documentation merge with commit #578
af55811 [Jesang Yoon] Merge remote-tracking branch 'origin/master'
079480f [Jesang Yoon] Merge remote-tracking branch 'origin/master'
5f0a6e0 [Jesang Yoon] Merge remote-tracking branch 'origin/master'
4d1503a [Jesang Yoon] Merge remote-tracking branch 'origin/master'
5b091e4 [Jesang Yoon] Fix wrong HTML tags, indention and space between paragraph and tables. Remove unnecessary spaces.
5665dcf [Jesang Yoon] Fix wrong HTML tags, indention and space between paragraph and tables. Remove unnecessary spaces.
asfgit pushed a commit that referenced this pull request Mar 18, 2016
### What is this PR for?
Provide a guide to setup basic authentication using NGINX with detailed instruction for users who wants to use NGINX as a separate authentication server. Shiro Security is preferred way to provide a basic authentication for future releases, but we may need to provide a way to workaround when user need other options.

### What type of PR is it?
Documentation

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

Author: Jesang Yoon <yoonjs2@kanizsalab.com>

Closes #775 from yoonjs2/add-nginx-auth-documentation and squashes the following commits:

54b8970 [Jesang Yoon] Fix reference url about Shiro security to https://github.com/apache/incubator-zeppelin/blob/master/SECURITY-README.md in document
fe0f616 [Jesang Yoon] Merge branch 'master' of https://github.com/apache/incubator-zeppelin into add-nginx-auth-documentation
10f339d [Jesang Yoon] Fix server port naming
4b2223a [Jesang Yoon] Make path to cert and key for HTTPS Ambigious
aac4cd4 [Jesang Yoon] Add documentation for explaining enable HTTP basic authentication served by NGINX
3d9e5b3 [Jesang Yoon] Merge remote-tracking branch 'upstream/master'
eba0315 [Jesang Yoon] Merge remote-tracking branch 'upstream/master'
db8b4da [Jesang Yoon] Merge remote-tracking branch 'upstream/master'
781954b [Jesang Yoon] Interpreter documentation merge with commit #578
af55811 [Jesang Yoon] Merge remote-tracking branch 'origin/master'
079480f [Jesang Yoon] Merge remote-tracking branch 'origin/master'
5f0a6e0 [Jesang Yoon] Merge remote-tracking branch 'origin/master'
4d1503a [Jesang Yoon] Merge remote-tracking branch 'origin/master'
5b091e4 [Jesang Yoon] Fix wrong HTML tags, indention and space between paragraph and tables. Remove unnecessary spaces.
5665dcf [Jesang Yoon] Fix wrong HTML tags, indention and space between paragraph and tables. Remove unnecessary spaces.
onkarshedge pushed a commit to onkarshedge/incubator-zeppelin that referenced this pull request May 11, 2016
### What is this PR for?
Provide a guide to setup basic authentication using NGINX with detailed instruction for users who wants to use NGINX as a separate authentication server. Shiro Security is preferred way to provide a basic authentication for future releases, but we may need to provide a way to workaround when user need other options.

### What type of PR is it?
Documentation

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

Author: Jesang Yoon <yoonjs2@kanizsalab.com>

Closes apache#775 from yoonjs2/add-nginx-auth-documentation and squashes the following commits:

54b8970 [Jesang Yoon] Fix reference url about Shiro security to https://github.com/apache/incubator-zeppelin/blob/master/SECURITY-README.md in document
fe0f616 [Jesang Yoon] Merge branch 'master' of https://github.com/apache/incubator-zeppelin into add-nginx-auth-documentation
10f339d [Jesang Yoon] Fix server port naming
4b2223a [Jesang Yoon] Make path to cert and key for HTTPS Ambigious
aac4cd4 [Jesang Yoon] Add documentation for explaining enable HTTP basic authentication served by NGINX
3d9e5b3 [Jesang Yoon] Merge remote-tracking branch 'upstream/master'
eba0315 [Jesang Yoon] Merge remote-tracking branch 'upstream/master'
db8b4da [Jesang Yoon] Merge remote-tracking branch 'upstream/master'
781954b [Jesang Yoon] Interpreter documentation merge with commit apache#578
af55811 [Jesang Yoon] Merge remote-tracking branch 'origin/master'
079480f [Jesang Yoon] Merge remote-tracking branch 'origin/master'
5f0a6e0 [Jesang Yoon] Merge remote-tracking branch 'origin/master'
4d1503a [Jesang Yoon] Merge remote-tracking branch 'origin/master'
5b091e4 [Jesang Yoon] Fix wrong HTML tags, indention and space between paragraph and tables. Remove unnecessary spaces.
5665dcf [Jesang Yoon] Fix wrong HTML tags, indention and space between paragraph and tables. Remove unnecessary spaces.
asfgit pushed a commit that referenced this pull request May 18, 2016
### What is this PR for?
Revised documentation about nginx authentication after receive few comments about it. Especially for users who using old version of nginx (older than 1.3) facing websocket failures when using zeppelin after follow instructions. I put more information for those users to encourage use of latest version of nginx if possible + fix few grammars for readability.

### What type of PR is it?
Documentation

Author: Jesang Yoon <yoonjs2@kanizsalab.com>

Closes #877 from yoonjs2/nginx-auth-revised and squashes the following commits:

5c97838 [Jesang Yoon] Remove unused image files
3d48de4 [Jesang Yoon] Fix documentation to supply more information for help to setup basic auth with NGINX
7525167 [Jesang Yoon] Merge branch 'master' of https://github.com/apache/incubator-zeppelin
6a5a3c8 [Jesang Yoon] Merge branch 'master' of https://github.com/apache/incubator-zeppelin
6d04fa7 [Jesang Yoon] Merge branch 'master' of https://github.com/apache/incubator-zeppelin
90219f7 [Jesang Yoon] Merge branch 'master' of https://github.com/apache/incubator-zeppelin
35a6679 [Jesang Yoon] Merge branch 'master' of https://github.com/apache/incubator-zeppelin
4b2223a [Jesang Yoon] Make path to cert and key for HTTPS Ambigious
aac4cd4 [Jesang Yoon] Add documentation for explaining enable HTTP basic authentication served by NGINX
3d9e5b3 [Jesang Yoon] Merge remote-tracking branch 'upstream/master'
eba0315 [Jesang Yoon] Merge remote-tracking branch 'upstream/master'
db8b4da [Jesang Yoon] Merge remote-tracking branch 'upstream/master'
781954b [Jesang Yoon] Interpreter documentation merge with commit #578
af55811 [Jesang Yoon] Merge remote-tracking branch 'origin/master'
079480f [Jesang Yoon] Merge remote-tracking branch 'origin/master'
5f0a6e0 [Jesang Yoon] Merge remote-tracking branch 'origin/master'
4d1503a [Jesang Yoon] Merge remote-tracking branch 'origin/master'
5b091e4 [Jesang Yoon] Fix wrong HTML tags, indention and space between paragraph and tables. Remove unnecessary spaces.
5665dcf [Jesang Yoon] Fix wrong HTML tags, indention and space between paragraph and tables. Remove unnecessary spaces.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants