-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Fix some typos, grammars and Increase readability documentation #578
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 `
|
@HeartSaVioR Thank you for your kind reviewing! I applied the comments that you mentioned. |
|
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.
|
|
So, ready to review : ) |
|
LGTM. Thanks @AhyoungRyu improving docs! |
docs/interpreter/cassandra.md
Outdated
There was a problem hiding this comment.
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
|
@felixcheung |
There was a problem hiding this comment.
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.
|
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 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 interpreterTo configure your interpreter you need to follow these steps:
|
|
@corneadoug looks good, I'd only add in 2, instead of a specific line number, could we refer to it as: |
|
... 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? |
|
@felixcheung I thing its fine in this category since the step before is adding the interpreter under the right folder |
|
@corneadoug but point 2 is code change that someone creating a new interpreter should do, right? |
|
Yes, but its more things to do when adding the interpreter to Zeppelin |
|
@corneadoug @felixcheung I applied the comments : ) |
|
Honestly, there is too much changes in that PR to properly review all the grammar and sentences. |
|
LGTM i'm merging |
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.
### 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.
### 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.
### 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.
What is this PR for?
It would be better if Zeppelin provides looking good documentation.
What type of PR is it?
Improvement
Todos
Is there a relevant Jira issue?
No : )
How should this be tested?
These documentations are in here.
Screenshots (if appropriate)
Questions: