Index file needs to be added to refer all the topics in one place.

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

Index file needs to be added to refer all the topics in one place.

Gururaj Shetty (Guru)
Hi All,

For documentation usage we need to add an Index file to refer all the documentation topics at one place. In Index file we need to provide the introduction and organise the topics based on the user scenario.
This is missing in https://github.com/apache/incubator-carbondata/tree/master/docs.

This file will be index.md file and can be added in doc folder.

Regards,
Gururaj

******************************************************************************************************************************************************************************************************************
This e-mail and attachments contain confidential information from HUAWEI, which is intended only for the person or entity whose address is listed above. Any use of the information contained herein in any way (including, but not limited to, total or partial disclosure, reproduction, or dissemination) by persons other than the intended recipient's) is prohibited. If you receive this e-mail in error, please notify the sender by phone or email immediately and delete it!

******************************************************************************************************************************************************************************************************************

Reply | Threaded
Open this post in threaded view
|

Re: Index file needs to be added to refer all the topics in one place.

Liang Chen
Administrator
Hi guru

Apache CarbonData community is preparing carbondata.apache.org, all documents will be indexed on the website for users to easily view. So i don't suggest add the index.md for github docs.

Regards
Liang


Gururaj Shetty (Guru) wrote
Hi All,

For documentation usage we need to add an Index file to refer all the documentation topics at one place. In Index file we need to provide the introduction and organise the topics based on the user scenario.
This is missing in https://github.com/apache/incubator-carbondata/tree/master/docs.

This file will be index.md file and can be added in doc folder.

Regards,
Gururaj

******************************************************************************************************************************************************************************************************************
This e-mail and attachments contain confidential information from HUAWEI, which is intended only for the person or entity whose address is listed above. Any use of the information contained herein in any way (including, but not limited to, total or partial disclosure, reproduction, or dissemination) by persons other than the intended recipient's) is prohibited. If you receive this e-mail in error, please notify the sender by phone or email immediately and delete it!

******************************************************************************************************************************************************************************************************************