[DISCUSSION] Updates to CarbonData documentation and structure

Posted by sraghunandan on Sep 04, 2018; 7:57am
URL: http://apache-carbondata-dev-mailing-list-archive.168.s1.nabble.com/DISCUSSION-Updates-to-CarbonData-documentation-and-structure-tp61280.html

Dear All,

 I wanted to propose some updates and changes to our current
documentation,Please let me know your inputs and comments.


1.Split Our carbondata command into DDL and DML

2.Add Presto and Hive integration along with Spark into quick start

3.Add a master reference manual which lists all the commands supported in
carbondata.This manual shall have links to DDL and DML supported

4.Add a introduction to carbondata covering architecture,design and
features supported

5.Merge FAQ and troubleshooting documents into single document

6.Add a separate md file to explain user how to navigate across our
documentation

7.Add the TOC (Table of Contents) to all the md files which has multiple
sections

8.Add list of supported properties at the beginning of each DDL or DML so
that user knows all the properties that are supported

9.Rewrite the configuration properties description to explain the property
in bit more detail and also highlight when to use the command and any
caveats

10.ReOrder our configuration properties table to group features wise

11.Update our webpage(carbondata.apache.org) to have a better navigation
for documentation section

12.Add use cases about carbondata usage and performance tuning tips


Regards

Raghu