Thanks Okumin for starting this thread. We definitely need a more comprehensive contribution documents! Personally, i want to add a new webpage in hive-site(https://github.com/apache/hive-site/). But our hive-site is so simple, i am not sure if some folks want to develop a brand new hive-site :). Some other OSS project like Spark & Iceberg, have the good & updated doc/webpage, which can make new contribution work happy.
Therefore, maybe the current reasonable solution is to add a new document for Hive master/ Hive4, as we only focus on Hive master/ Hive4 since then. But we need to ensure the Hive developers could easily find the new wiki docs, e.g. maybe add a link from the old wiki docs. Thanks, Butao Zhang ---- Replied Message ---- | From | Shohei Okumiya<oku...@apache.org> | | Date | 12/9/2024 10:23 | | To | <dev@hive.apache.org> | | Subject | [DISCUSS] Reorganize documents for developers/contributors | Hi Hive developers, I'd like to discuss my idea, which provides a single source for Hive contributors. Recently, I reviewed multiple pull requests submitted by new contributors. Our Query Unit Test suite was tricky enough for new people, and we sometimes needed to guide them through GitHub or e-mails. It requires some contexts like the directory structure or various types of TestCliDriver. I think a comprehensive document would be helpful. We already have three documents that describe how to use the testing framework. It is hard to remember which contains the latest information as they all have generic titles. Also, I think some content is not aligned with real needs(e.g., branch-1 or branch-2 are unimportant for most people in 2024). I guess they can be barriers for new developers. - Developer Guide: https://cwiki.apache.org/confluence/display/Hive/DeveloperGuide - How to Contribute to Apache Hive: https://cwiki.apache.org/confluence/display/Hive/HowToContribute - Hive Developer FAQ: https://cwiki.apache.org/confluence/display/Hive/HiveDeveloperFAQ Then, I'd like to propose creating a document for developers tuned for 2024 and deprecating the old documents. This will help new contributors develop Hive, and existing committers support patch authors. Do you know if this initiative is viable? If it is viable, where should it be written, i.e., WIKI or hive-site? I guess we prefer hive-site for new pages, but that might not be true. Regards, Okumin
