[GitHub] carbondata pull request #2693: [CARBONDATA-2915] Reformat Documentation of C...

[qiuchenjian-2]

GitHub user sraghunandan opened a pull request:

    https://github.com/apache/carbondata/pull/2693

    [CARBONDATA-2915] Reformat Documentation of CarbonData

    1.Split Our carbondata command into DDL and DML
    2.Add Presto 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.Change the grammar and sentences
   
     - [X] Any interfaces changed?
     NA
     - [X] Any backward compatibility impacted?
     NA
     - [X] Document update required?
    YES
     - [X] Testing done
            Please provide details on
            - Whether new unit test cases have been added or why no new tests are required?
            - How it is tested? Please attach test report.
            - Is it a performance related change? Please attach the performance test report.
            - Any additional information to help reviewers in testing this change.
           NA
     - [X] For large changes, please consider breaking it into sub-tasks under an umbrella JIRA.
    NA

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/sraghunandan/carbondata-1 rewrite_documents

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/carbondata/pull/2693.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #2693
   
----
commit 12e3650bb56a8db02cc01cf1dd92665fd2442fc2
Author: Raghunandan S <carbondatacontributions@...>
Date:   2018-07-02T14:23:16Z

    Updated & enhanced Documentation of CarbonData

commit 92b5c6337b5e81fb2faba0c22dfd43e6fd3b6718
Author: Raghunandan S <carbondatacontributions@...>
Date:   2018-09-04T15:09:12Z

    updated as per comments

commit 838acf669ea513a0053553ba5ac4a40da5f28ec0
Author: Raghunandan S <carbondatacontributions@...>
Date:   2018-08-27T11:15:42Z

    Updated & enhanced Documentation of CarbonData

----


---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2693
 
    Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/1/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2693
 
    Build Failed  with Spark 2.3.1, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder1/8333/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2693
 
    Build Success with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/263/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2693
 
    Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/130/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2693
 
    Build Success with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/298/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2693
 
    Build Failed  with Spark 2.3.1, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.3/8368/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2693
 
    Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/132/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2693
 
    Build Failed  with Spark 2.3.1, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.3/8370/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2693
 
    Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/135/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2693
 
    Build Success with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/300/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2693
 
    Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/137/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2693
 
    Build Success with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/303/



---

[qiuchenjian-2]

Github user chenliang613 commented on a diff in the pull request:

    https://github.com/apache/carbondata/pull/2693#discussion_r215879237
 
    --- Diff: docs/carbondata-architecture-design.md ---
    @@ -0,0 +1,140 @@
    +## Architecture
    +
    --- End diff --
   
    Please remove this architecture md file from this pr,  there are many info need to be confirmed, it would be better if you could put it to mailing list for discussion.


---

[qiuchenjian-2]

Github user chenliang613 commented on a diff in the pull request:

    https://github.com/apache/carbondata/pull/2693#discussion_r215879697
 
    --- Diff: docs/configuration-parameters.md ---
    @@ -235,3 +235,16 @@ RESET
     * Success will be recorded in the driver log.
     
     * Failure will be displayed in the UI.
    +
    +
    +<script>
    --- End diff --
   
    what is this ?  please remove.


---

[qiuchenjian-2]

Github user chenliang613 commented on a diff in the pull request:

    https://github.com/apache/carbondata/pull/2693#discussion_r215881276
 
    --- Diff: docs/datamap-developer-guide.md ---
    @@ -3,14 +3,28 @@
     ### Introduction
     DataMap is a data structure that can be used to accelerate certain query of the table. Different DataMap can be implemented by developers.
     Currently, there are two 2 types of DataMap supported:
    -1. IndexDataMap: DataMap that leveraging index to accelerate filter query
    -2. MVDataMap: DataMap that leveraging Materialized View to accelerate olap style query, like SPJG query (select, predicate, join, groupby)
    +1. IndexDataMap: DataMap that leverages index to accelerate filter query
    +2. MVDataMap: DataMap that leverages Materialized View to accelerate olap style query, like SPJG query (select, predicate, join, groupby)
     
     ### DataMap provider
     When user issues `CREATE DATAMAP dm ON TABLE main USING 'provider'`, the corresponding DataMapProvider implementation will be created and initialized.
     Currently, the provider string can be:
    -1. preaggregate: one type of MVDataMap that do pre-aggregate of single table
    -2. timeseries: one type of MVDataMap that do pre-aggregate based on time dimension of the table
    +1. preaggregate: A type of MVDataMap that do pre-aggregate of single table
    +2. timeseries: A type of MVDataMap that do pre-aggregate based on time dimension of the table
     3. class name IndexDataMapFactory  implementation: Developer can implement new type of IndexDataMap by extending IndexDataMapFactory
     
    -When user issues `DROP DATAMAP dm ON TABLE main`, the corresponding DataMapProvider interface will be called.
    \ No newline at end of file
    +When user issues `DROP DATAMAP dm ON TABLE main`, the corresponding DataMapProvider interface will be called.
    +
    +Details about [DataMap Management](./datamap-management.md#datamap-management) and supported [DSL](./datamap-management.md#overview) are documented [here](./datamap-management.md).
    --- End diff --
   
    this link is not working.


---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2693
 
    Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/140/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2693
 
    Build Failed  with Spark 2.3.1, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.3/8375/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2693
 
    Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/141/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2693
 
    Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/142/



---