> > (1) docs is as important as code and something developers have to deal with > all the time. so good to get broad feedback on this.
Agree. I always favor well-organized documentations. (2) We actually expanded RFCs to include even "ideas", providing way for > someone to write down thoughts and share with the group in a structured > way. Epics can be created if the RFC ultimately results in planned work. > What do you think? Sure. Now I see that the RFCs could serve the purpose of idea gathering then it'll surely be beneficial. So +1 on it. On Wed, Nov 13, 2019 at 9:14 AM Vinoth Chandar <[email protected]> wrote: > Thanks for initiating this, Ethan. Will send detailed comments in a while. > > @raymond, I actually think this deserves an RFC for two reasons. > (1) docs is as important as code and something developers have to deal with > all the time. so good to get broad feedback on this. > (2) We actually expanded RFCs to include even "ideas", providing way for > someone to write down thoughts and share with the group in a structured > way. Epics can be created if the RFC ultimately results in planned work. > What do you think? > > @balaji or @sudha. Seems like I lost admin rights on cwiki space somehow > (may be the recent change on role based administration?) . Can you please > provide ethan access and also reinstate my permissions? :) > > > On Wed, Nov 13, 2019 at 8:01 AM Raymond Xu <[email protected]> > wrote: > > > Hi Ethan, > > > > I like the idea and I'm all for it. Actually this is one of the roadmap > > items under "Ease of Use" for 0.5.1 > > > > My only concern is: does this fit into an RFC? I believe an RFC is about > > adding a new feature to the framework while having better docs fall > within > > the dev experience realm IMO. Nonetheless, what you described definitely > > deserves an Epic in the JIRA board at least. > > > > Best, > > Raymond > > > > On Wed, Nov 13, 2019 at 4:37 AM leesf <[email protected]> wrote: > > > > > +1. It is very practical and thanks for driving the discussion. > > > > > > vinoth and balaji would give your cwiki permission. > > > > > > Best, > > > Leesf > > > > > > vino yang <[email protected]> 于2019年11月13日周三 下午5:02写道： > > > > > > > Hi Ethan, > > > > > > > > Thanks for starting this discussion thread. > > > > +1 from my side > > > > > > > > Best, > > > > Vino > > > > > > > > Y Ethan Guo <[email protected]> 于2019年11月13日周三 下午4:05写道： > > > > > > > > > Hey Folks, > > > > > > > > > > I plan to start an RFC in the Docs Overhaul track. The scope of > this > > > RFC > > > > > will be the restructuring and auto-generation of docs, with the > > > following > > > > > goals: > > > > > > > > > > - Make it easier for users to understand Hudi's main features and > > > > access > > > > > docs of each release > > > > > - Separate the actual documentation specific to each release (onto > > > > > master) from Hudi's landing page (asf-site, to include general > > > > > information > > > > > about Hudi) going forward > > > > > - Manually generate the docs pages of previous three releases ( > > > > > https://issues.apache.org/jira/browse/HUDI-226 > <https://issues.apache.org/jira/browse/HUDI-226> > > > <https://issues.apache.org/jira/browse/HUDI-226 > <https://issues.apache.org/jira/browse/HUDI-226>>) > > > > > - Restructure the page layout for users to check out docs of > > > > > different releases > > > > > - Add online javadocs ( > > > > > https://issues.apache.org/jira/browse/HUDI-319 > <https://issues.apache.org/jira/browse/HUDI-319> > > > <https://issues.apache.org/jira/browse/HUDI-319 > <https://issues.apache.org/jira/browse/HUDI-319>>) > > > > > - Reduce the amount of maintenance work on docs update and release > > for > > > > > developers/committers > > > > > - Add a script for generating release docs pages, which can be used > > > > > when cutting a release > > > > > - Add a script for updating/deploying the landing page of Hudi > > > > > website (https://issues.apache.org/jira/browse/HUDI-132 > <https://issues.apache.org/jira/browse/HUDI-132> > > > <https://issues.apache.org/jira/browse/HUDI-132 > <https://issues.apache.org/jira/browse/HUDI-132>>) > > > > > > > > > > Let me know if the scope is good and any other relevant work can > also > > > be > > > > > added in this RFC. > > > > > > > > > > I need cwiki write permission to create a new RFC. My cwiki handle > is > > > > > yihua. > > > > > > > > > > Thanks, > > > > > - Ethan > > > > > > > > > > > > > > > > > > -- > > *Raymond Xu* > > Sr. Software Engineer | Zendesk Inc. > > LinkedIn <http://linkedin.com/in/xushiyan > <http://linkedin.com/in/xushiyan>> | GitHub > > <http://github.com/xushiyan > <http://github.com/xushiyan>> > > > -- *Raymond Xu* Sr. Software Engineer | Zendesk Inc. LinkedIn <http://linkedin.com/in/xushiyan> | GitHub <http://github.com/xushiyan>
