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
----
---
