[ 
https://issues.apache.org/jira/browse/HUDI-1241?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17384105#comment-17384105
 ] 

ASF GitHub Bot commented on HUDI-1241:
--------------------------------------

rmahindra123 opened a new pull request #3303:
URL: https://github.com/apache/hudi/pull/3303


   ## What is the purpose of the pull request
   Now that we have `HoodieConfig` and `ConfigProperty`, we want to write a 
small script that can build a certain branch or git-sha, use reflection to load 
up all the HoodieConfig classes, and generate a .md file automatically for each 
ConfigProperty defined.
   
   In this PR, we add a java class within the asf-site branch, that 
automatically reads all the Config files that extend 'HoodieConfig` and include 
config params implemented as `ConfigProperty`.  
   
   ## Brief change log
   
   - Added a new java maven project `hudi-utils`
   - Implemented a java class `HoodieConfigDocGenerator` that automatically 
reads all config files and generates a md file that can be used to generate the 
config webpage in hudi.apache.org
   - Spark and Flink configs are implemented as special case for now as the 
former does not extend `HoodieConfig` and the latter does not use 
`ConfigProperty`
   
   ## Verify this pull request
   
   Tested with the current hudi master and used the local docker setup to test 
that the md is properly rendered by the asf-site.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@hudi.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


> Generate config docs automatically
> ----------------------------------
>
>                 Key: HUDI-1241
>                 URL: https://issues.apache.org/jira/browse/HUDI-1241
>             Project: Apache Hudi
>          Issue Type: Improvement
>          Components: Code Cleanup
>            Reporter: sivabalan narayanan
>            Assignee: Rajesh Mahindra
>            Priority: Blocker
>              Labels: pull-request-available
>             Fix For: 0.9.0
>
>
> Now that we have `HoodieConfig` and `ConfigProperty`, can we write a small 
> script that can build a certain branch or git-sha, use reflection to load up 
> all the HoodieConfig classes and generate a .md file automatically for each 
> ConfigProperty defined.
>  
> We will then render the .md file thru the site, as always



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to