You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

 RFC-10: Restructuring and auto-generation of docs

Proposers

Approvers

Status

Current state: Under Discussion

Discussion thread: here

JIRA: here

Released: <Hudi Version>

Abstract

This RFC aims at 

Background

There are a few gaps we observed regarding the docs:

Implementation

<Describe the new thing you want to do in appropriate detail, how it fits into the project architecture. Provide a detailed description of how you intend to implement this feature.This may be fairly extensive and have large subsections of its own. Or it may be a few sentences. Use judgement based on the scope of the change.>

Rollout/Adoption Plan

  • <What impact (if any) will there be on existing users?>
  • <If we are changing behavior how will we phase out the older behavior?>
  • <If we need special migration tools, describe them here.>
  • <When will we remove the existing behavior?>

Test Plan

<Describe in few sentences how the RFC will be tested. How will we know that the implementation works as expected? How will we know nothing broke?>

  • No labels