Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate markdown documentation for all CometConf entries #315

Closed
andygrove opened this issue Apr 24, 2024 · 0 comments · Fixed by #349
Closed

Generate markdown documentation for all CometConf entries #315

andygrove opened this issue Apr 24, 2024 · 0 comments · Fixed by #349
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@andygrove
Copy link
Member

What is the problem the feature request solves?

We should have a configuration reference page in our published documentation at https://datafusion.apache.org/comet/

Describe the potential solution

I propose that we write code to automatically generate a docs/sources/configs.md page based on the configuration entries specified in org.apache.comet.CometConf and execute this code from the maven build.

We will need to add this new page to the site index as well.

We can look at Apache Spark or NVIDIA Spark RAPIDS for inspiration on implementing this.

Additional context

No response

@andygrove andygrove added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Apr 24, 2024
@andygrove andygrove self-assigned this Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant