Skip to content

Conversation

@yoonjs2
Copy link
Contributor

@yoonjs2 yoonjs2 commented Jan 17, 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:
    after titles
  2. Fix too wide spaces between paragraph and tables
  3. Remove unnecessary spaces at end of paragraph and lines

@Leemoonsoo
Copy link
Member

Thanks @yoonjs2 for the good contribution.
Just merged another documentation improvement #578 from @AhyoungRyu. That seems make this branch conflict to master. Do you mind resolve the conflict once again?

@yoonjs2
Copy link
Contributor Author

yoonjs2 commented Jan 17, 2016

Hi @Leemoonsoo, I just merged my branch with #578.
And also I fixed & matched more unnecessary spaces and indention in every interpreter documentations to make them more looks like written by one author. But while I merging documentations I found contents and numbering of titles are also varies between documents.

  • Some documents has overview but some are not.
  • Some documents use numbering at titles but some are not.
  • Some documents has spaces between titles and paragraph but some are not.
  • Some documents use
    tags to make line spaces but some are not.

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?

@AhyoungRyu
Copy link
Contributor

@yoonjs2
It's really good idea to make a standard guideline. I've always thought that we need it!

@Leemoonsoo
Copy link
Member

The change looks good to me. Merge if there're no more discussions.
And big +1 for guidelines for documentation style.

@felixcheung
Copy link
Member

looks good

@asfgit asfgit closed this in 0d157ae Jan 21, 2016
doanduyhai added a commit to doanduyhai/incubator-zeppelin that referenced this pull request Jan 27, 2016
Leemoonsoo pushed a commit to Leemoonsoo/zeppelin that referenced this pull request Feb 4, 2016
### 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
asfgit pushed a commit that referenced this pull request Feb 13, 2016
### 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
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.

4 participants