Hi Ethan, Thanks for the RFC. I have a few observations about the docs. I saw the diagram for the docs, asf-site and master are kept as separate branches, currently.
(1) I suggest two approaches for maintaining the docs looking at how other popular Apache projects do, - Apache Flink <https://github.com/apache/flink/tree/master/docs> - Keeping docs part of the master. - Keeping docs part of the master will help in updating the docs and code simultaneously when the releases are cut. (I prefer this). - Apache Kafka <https://github.com/apache/kafka-site> - Keeping a separate repository for documentation. - A separate repo will give much more flexibility and independence in terms of deployment, but will also be a bit inconvenient in terms of switching between the repository while making changes, like the current case of different branches. I can't think of any other advantages of doing this. (2) Introduce a new section for listing PMC members and Committers - This will help in getting in touch with core contributors and give them visibility as well. (3) For improving new contributor experience, Add a little more detail regarding the project structure and what each module is designed for. A section on describing the Hudi metadata structure (A good reference https://kafka.apache.org/protocol) (4) Regarding the comparison table with other alternatives Not sure if we should keep this. Since all projects are developing at a good pace, keeping tabs on what each project is doing or has implemented can be taxing, since people here are majorly working on Hudi. It shouldn't happen that we present a misleading or old comparison regarding the features of other projects. I feel benchmarks and comparisons make a good topic for blog posts since they are always dated. Regards, Gurudatt On Thu, Nov 14, 2019 at 6:21 AM Y Ethan Guo <ethan.guoyi...@gmail.com> wrote: > Hey folks, > > I put my thoughts around the topic in this RFC: > > RFC-10: Restructuring and auto-generation of docs > > https://cwiki.apache.org/confluence/display/HUDI/RFC-10%3A+Restructuring+and+auto-generation+of+docs > > Feel free to provide feedback there or here. > > Thanks, > - Ethan >
