Improving the contribution experience is super-important if we want more people to get involved in the project. Thanks for taking this on Okumin!
I did a pass and left a few suggestions but nothing blocking. Let's continue improving our documentation! Best, Stamatis On Fri, Mar 28, 2025 at 6:49 AM Shohei Okumiya <oku...@apache.org> wrote: > > Hi all, > > I am trying to write a complete guide about qtest. I have sometimes > explained how to use the testing framework to new contributors. This > document will allow us to say, "Please read this page"! > https://github.com/apache/hive-site/pull/45 > > I still don't know all about Hive. Could you please take a look at my > pull request and let me know if you have informative tips? > > Regards, > Okumin > > On Fri, Dec 13, 2024 at 12:02 PM Butao Zhang <zhangbu...@apache.org> wrote: > > > > Thanks Stamatis for your great job! > > It's a good beginning about migrating document from wiki to web-site. > > I think we can refer to https://github.com/apache/spark-website in the > > future development. We can create the multi-version hive-site, refer to > > spark: > > https://archive.apache.org/dist/spark/docs/3.4.3/ > > https://archive.apache.org/dist/spark/docs/3.4.4/ > > https://spark.apache.org/docs/latest/index.html > > > > Therefore, we can add/delete some stuff in the different hive-site version, > > and users can slso know clearing which new feature/hive syntax was added in > > the version. > > > > Thanks, > > Butao Zhang > > > > On 2024/12/12 13:06:18 Stamatis Zampetakis wrote: > > > The first step towards the migration of the wiki to the site is done. > > > Please check https://issues.apache.org/jira/browse/HIVE-28666 and > > > share your feedback there or under the respective PR. > > > > > > Best, > > > Stamatis > > > > > > On Wed, Dec 11, 2024 at 12:56 PM Stamatis Zampetakis <zabe...@gmail.com> > > > wrote: > > > > > > > > Hey everyone, > > > > > > > > Improving and facilitating contributions for newcomers is super > > > > important so any action towards this direction is very much welcome. I > > > > am not sure what exactly you have in mind Okumin but if there's a > > > > meaningful way to combine/organize the aforementioned documents we can > > > > review the concrete proposal and move it forward. > > > > > > > > As others mentioned already, in the past we discussed the migration of > > > > the wiki to the website. This should be the first step since it would > > > > greatly facilitate the review process especially if we start moving > > > > material around. I think everyone agrees that moving away from the wiki > > > > is the right direction so I started working on a POC to get a first > > > > version in the next few days. It won't be perfect but we can improve > > > > gradually. > > > > > > > > Regarding the javadocs, I don't know if it should be moved to the site > > > > or not but the fact that it is broken right now is something that is > > > > worth a ticket and it would be great if someone has the bandwidth to > > > > look into it. > > > > > > > > Best, > > > > Stamatis > > > > > > > > > > > > On Tue, Dec 10, 2024, 7:30 PM Simhadri G <simhad...@apache.org> wrote: > > > >> > > > >> Thanks for bringing this up. > > > >> > > > >> I would like to add that the current javadocs for hive hosted on svn > > > >> is broken . > > > >> https://hive.apache.org/docs/javadocs/ > > > >> > > > >> We should move the javadocs to the hive-site repo as a part of this > > > >> initiative as well. > > > >> > > > >> > > > >> > > > >> > > > >> > > > >> > > > >> > > > >> On Tue, Dec 10, 2024, 11:27 PM Ayush Saxena <ayush...@gmail.com> wrote: > > > >>> > > > >>> Thanks, everyone, for the discussion! I recall bringing up this > > > >>> initiative during our conversations about the Hive 4.0 release. At the > > > >>> time, most of us agreed on the importance of having versioned > > > >>> documentation on the website, especially since the current information > > > >>> is scattered across various wikis—some of which are outdated—causing > > > >>> confusion for many users. > > > >>> > > > >>> As part of a long-term plan, if someone has the bandwidth, we should > > > >>> prioritize migrating Hive 4.X documentation to the website. Even if > > > >>> it’s not possible to do it all at once, taking incremental steps in > > > >>> that direction would be highly beneficial. > > > >>> > > > >>> For context, I had started drafting a wiki for Hive 4.x [1], given the > > > >>> lack of time to integrate all relevant documentation directly into the > > > >>> website. If anyone is interested in picking this up, a good starting > > > >>> point might be migrating the contribution guidelines and key portions > > > >>> of the 4.x documentation to the site. > > > >>> > > > >>> – Ayush > > > >>> > > > >>> [1] https://cwiki.apache.org/confluence/display/Hive/Apache+Hive+4.0.X > > > >>> > > > >>> On Mon, 9 Dec 2024 at 08:27, Butao Zhang <butaozha...@163.com> wrote: > > > >>> > > > > >>> > 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 ---- > > > >>> > FromShohei Okumiya<oku...@apache.org> > > > >>> > Date12/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 > > >
