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 |
Administrator
|
Hi Raghu
+1, all these optimizations are very good. Regards Liang sraghunandan wrote > 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 -- Sent from: http://apache-carbondata-dev-mailing-list-archive.1130556.n5.nabble.com/ |
In reply to this post by sraghunandan
I think even we split the carbondata command into DDL and DML, it is still
too large for one document. For example, there are many TBLProperties for creating table in DDL. Some descriptions of the TBLProperties is long and now we do not have TOC for them. It's difficult to locate one property in the doc. Besides, some parameters can be specified in system configuration, TBLProperties, LoadOptions level at the same time. Where should we describe this parameter? -- Sent from: http://apache-carbondata-dev-mailing-list-archive.1130556.n5.nabble.com/ |
+1,
As this will improve our documentation quality, just have 1 suggestions, do we need to have a migration guide also in carbon or a section which basically says any behaviour changes while migrating the carbon versions. This will be very handy when we release our major versions. Fo Example if any behaviour changes in bad records handling across version or changes in behaviour of particular data type data like decimal precision/scale handling etc. Regards, Sujith On Wed, 5 Sep 2018 at 7:39 AM, xuchuanyin <[hidden email]> wrote: > I think even we split the carbondata command into DDL and DML, it is still > too large for one document. > > For example, there are many TBLProperties for creating table in DDL. Some > descriptions of the TBLProperties is long and now we do not have TOC for > them. It's difficult to locate one property in the doc. > > Besides, some parameters can be specified in system configuration, > TBLProperties, LoadOptions level at the same time. Where should we describe > this parameter? > > > > -- > Sent from: > http://apache-carbondata-dev-mailing-list-archive.1130556.n5.nabble.com/ > |
+1, I agree with sujith.
We can have a seperate link in the website(example: *Breaking change*) which can list all the behaviour changes that the new version is introducing. Regards, Kunal Kapoor On Wed, Sep 5, 2018 at 3:56 PM sujith chacko <[hidden email]> wrote: > +1, > As this will improve our documentation quality, just have 1 suggestions, do > we need to have a migration guide also in carbon or a section which > basically says any behaviour changes while migrating the carbon versions. > This will be very handy when we release our major versions. > > Fo Example if any behaviour changes in bad records handling across version > or changes in behaviour of particular data type data like decimal > precision/scale handling etc. > > Regards, > Sujith > > > On Wed, 5 Sep 2018 at 7:39 AM, xuchuanyin <[hidden email]> wrote: > > > I think even we split the carbondata command into DDL and DML, it is > still > > too large for one document. > > > > For example, there are many TBLProperties for creating table in DDL. Some > > descriptions of the TBLProperties is long and now we do not have TOC for > > them. It's difficult to locate one property in the doc. > > > > Besides, some parameters can be specified in system configuration, > > TBLProperties, LoadOptions level at the same time. Where should we > describe > > this parameter? > > > > > > > > -- > > Sent from: > > http://apache-carbondata-dev-mailing-list-archive.1130556.n5.nabble.com/ > > > |
Free forum by Nabble | Edit this page |