Versions Compared

Old Version 4

changes.mady.by.user Ethan Guo

Saved on

compared with

New Version 5

changes.mady.by.user Ethan Guo

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In addition to these docs, a new set of API docs will be added generated by javadoc for each release (similar to this).

...

To make updating and deploying docs content easier, a set of scripts automating the above process will be added.  In this way, once the changes to the /docs on either master or asf-site are landed, the update content pages can be uploaded to the hosting server of Hudi website.  The API docs on master branch is also going to be maintained in this way.

Redesigning landing page

The landing page should serve the following purposes, with as fewer words as possible

  1. Answer what is Hudi
  2. Provide insights into why someone should use Hudi (some answers in FAQ)
  3. Highlight key features
  4. Have the link to the comparison page if the user would like to read more
  5. Direct links/buttons to join the community

Here are the proposed changes corresponding to each item:

  1. Simplify the existing content to 2-3 sentences, with a diagram showing the interoperability with existing data ecosystem
  2. 3-4 sentences on why someone should use Hudi, with a link to the FAQ
  3. Highlight a few key features, each one elaborated with the technical details in 2-3 sentences, something like the following (from this set of slides by Vinoth and Balaji)
    E.g., "Near real-time data ingestion to Cloud storage/DFS: By carefully managing how data is laid out in storage & how it’s exposed to queries, Hudi is able to power a rich data ecosystem where external sources can be ingested in near real-time and made available for interactive SQL Engines like Presto & Spark"
    Image AddedImage Added
  4. Have a few sentences on the comparison against other solutions.  Have a link to the detailed comparison page.
  5. Direct links for joining the slack group and mailing list.  Right now these links are in the community page and requires additional clicks and reading.

For the detailed comparison page, we could have an interactive table to compare Hudi with other solutions regarding different aspects (each aspect can be clickable to show detailed explanation):

Image Added

The top menu bar on the landing page is still kept.

Rollout/Adoption Plan

  • No impact on existing users regarding APIs as this is docs website change.

Test Plan

...

  • Test the content organization locally to make sure the links are working and the content is readable