wuchong commented on PR #2474: URL: https://github.com/apache/fluss/pull/2474#issuecomment-3796413579
Thanks, @Prajwal-banakar. It looks like this framework generates Markdown files for the configuration options. However, I’m not sure how these can be integrated or embedded into our existing documentation Markdown files, such as: - https://fluss.apache.org/docs/next/engine-flink/options/ - https://fluss.apache.org/docs/next/maintenance/configuration/ I initially assumed the framework would generate HTML snippets, which would be straightforward to embed directly into the documentation, like how Flink does. Could you clarify how the generated Markdown is intended to be incorporated into the current doc structure? Besides, it would be grreat if you can add a `README.md` under the `fluss-docgen` module root. That would help others to understand how to use this tool. Flink has such README: https://github.com/apache/flink/blob/master/flink-docs/README.md -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
