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)
- Restructure the page layout for users to check out docs of
different releases
- Add online javadocs (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)
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
