[
https://issues.apache.org/jira/browse/HUDI-1241?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17379361#comment-17379361
]
ASF GitHub Bot commented on HUDI-1241:
--------------------------------------
codope opened a new pull request #3260:
URL: https://github.com/apache/hudi/pull/3260
## What is the purpose of the pull request
Generates the configuration doc automatically by scanning all class that
extend `HoodieConfig`.
## Brief change log
- Add Reflections to get subTypes of ConfigProperty.
- Generate tables for configs.
- Write markdown to file.
## Verify this pull request
Run the `generate_config_docs.sh` script in `hudi_utilities` by giving a
branch name. It should produce an output file named `config_doc.md`.
Alternatively, checkout a branch and just run `HoodieConfigDocGenerator` from
IDE.
## Committer checklist
- [ ] Has a corresponding JIRA in PR title & commit
- [ ] Commit message is descriptive of the change
- [ ] CI is green
- [ ] Necessary doc changes done or have another open PR
- [ ] For large changes, please consider breaking it into sub-tasks under
an umbrella JIRA.
--
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: Sagar Sumit
> 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)
