-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Fix styles of documentation about interpreters #648
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
…. Remove unnecessary spaces.
…. Remove unnecessary spaces.
# Conflicts: # docs/interpreter/cassandra.md
# Conflicts: # docs/interpreter/cassandra.md
|
Thanks @yoonjs2 for the good contribution. |
# Conflicts: # docs/interpreter/cassandra.md
|
Hi @Leemoonsoo, I just merged my branch with #578.
So It may need to build some standard guidelines in documentation styles to give ground rules for users to start documentation on their proposing features. If that guidelines goes well with the community, It will be easy to add nice design and document format in the future. (like http://getbootstrap.com or other OSS projects) Any suggestions? |
|
@yoonjs2 |
|
The change looks good to me. Merge if there're no more discussions. |
|
looks good |
### What is this PR for? Update official documentation for **Cassandra interpreter V2** Related to PR: apache#600 ### What type of PR is it? [Documentation] ### Is there a relevant Jira issue? **[ZEPPELIN-575]** ### How should this be tested? Just check the doc after the build to see if you can see the **chapter 14 Change Log** ### Questions: * Does the licenses files need update? --> **No** * Is there breaking changes for older versions? --> **No** * Does this needs documentation? --> **No** [ZEPPELIN-575]: https://issues.apache.org/jira/browse/ZEPPELIN-575 Author: DuyHai DOAN <doanduyhai@gmail.com> Closes apache#604 from doanduyhai/CassandraInterpreterDocumentation and squashes the following commits: d3f7871 [DuyHai DOAN] Use ZEPPELIN_VERSION variable instead of hard-coding c05d489 [DuyHai DOAN] Revert commit of doc cleaning PR apache#648 88811ee [DuyHai DOAN] Add Zeppelin version along-side with interpreter version 01716e1 [DuyHai DOAN] Cassandra Interpreter V2 doc e3dd18b [DuyHai DOAN] [ZEPPELIN-382] Add Documentation for Cassandra interpreter in the doc pages
### What is this PR for? Update official documentation for **Cassandra interpreter V2** Related to PR: #600 ### What type of PR is it? [Documentation] ### Is there a relevant Jira issue? **[ZEPPELIN-575]** ### How should this be tested? Just check the doc after the build to see if you can see the **chapter 14 Change Log** ### Questions: * Does the licenses files need update? --> **No** * Is there breaking changes for older versions? --> **No** * Does this needs documentation? --> **No** [ZEPPELIN-575]: https://issues.apache.org/jira/browse/ZEPPELIN-575 Author: DuyHai DOAN <doanduyhai@gmail.com> Closes #604 from doanduyhai/CassandraInterpreterDocumentation and squashes the following commits: b1e70cb [DuyHai DOAN] Remove un-necessary whitespaces 80fcea4 [DuyHai DOAN] Add ZEPPELIN_VERSION in _config.yml f052bd8 [DuyHai DOAN] Fixes reference to ZEPPELIN_VERSION in markdown d3f7871 [DuyHai DOAN] Use ZEPPELIN_VERSION variable instead of hard-coding c05d489 [DuyHai DOAN] Revert commit of doc cleaning PR #648 88811ee [DuyHai DOAN] Add Zeppelin version along-side with interpreter version 01716e1 [DuyHai DOAN] Cassandra Interpreter V2 doc e3dd18b [DuyHai DOAN] [ZEPPELIN-382] Add Documentation for Cassandra interpreter in the doc pages
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.
after titles