Create configs.rst #343
Create configs.rst #343
Conversation
Add Gradle task :storage:inkless:genInklessConfigDoc that generates the file docs/inkless/configs.rst documenting Inkless-specific configuration parameters. The task executes aiven.inkless.doc.ConfigsDocs.
| @@ -2468,6 +2468,19 @@ project(':storage:inkless') { | |||
| outputs.dir("${projectDir}/build/generated/main/java/io/aiven/inkless/generated") | |||
| } | |||
|
|
|||
| task genInklessConfigDoc(type: JavaExec) { | |||
There was a problem hiding this comment.
I wonder what's the best way to link this into the build process, so it doesn't get outdated.
In TS we used "finalizedBy" to do it after compilation: https://github.com/Aiven-Open/tiered-storage-for-apache-kafka/blob/8a98bcc8ad3dd0be026a55a85ede1dce8a703782/docs/build.gradle#L55-L57
Another option is to have it as part of the release process, and include it on siteDocsTar but we are not publishing docs so maybe not too useful.
Make :storage:inkless:build depend on genInklessConfigDoc to automatically generate the config.rst.
Good point. Now |
Sounds quite good. I'll have a look at this. Also, the metrics need to be documented, I'll check that too. |
There's now #344 for the topic config. |
|
I'm late to the party, but why an |
One reason is that |
Add Gradle task :storage:inkless:genInklessConfigDoc that generates the file docs/inkless/configs.rst documenting Inkless-specific configuration parameters. The task executes aiven.inkless.doc.ConfigsDocs.
Make :storage:inkless:build depend on genInklessConfigDoc to automatically generate the config.rst.