Versions Compared

Key

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

...

Eventually, we will have all .md of docs files on master, thus allowing the docs change with code change to be committed in a single PR.  The automation scripts to generate the docs content will also be on master.  To start with, we will still keep all docs files on a separate branch, i.e., asf-site.

...

Content regarding the general information of Hudi should remain in asf-site branch (site docs)only have one version, generated from the latest changes:

  • Use Cases
  • Talks & Powered By
  • Comparison
  • Releases
  • Community
  • Code
  • Developers
  • Feedback

The release docs on master and site docs in asf-site are generated separatelyThe docs content are still generated from a single branch, so that all page references can be generated properly.  The generated web pages are then uploaded to the hosting server for the Hudi site.  The landing page references the specific version of docs content through links.

...

To make updating and deploying docs content easier, a set of scripts automating the above process will be added (including sanity checks of whether there are breaking changes, e.g., broken links, missing pages, before actual changes to the site).  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.

Rollout/Adoption Plan

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

...