Add config documentation for S3 sink (#518)

Fix for #515 

Adds configuration documentation to web site.

Author: Claudenw

s3-sink-connector/build.gradle.kts

@@ -75,6 +75,9 @@ idea {
 dependencies {
   compileOnly(apache.kafka.connect.api)
   compileOnly(apache.kafka.connect.runtime)
+  compileOnly(project(":site"))
+  compileOnly("org.apache.velocity:velocity-engine-core:2.4.1")
+  compileOnly("org.apache.velocity.tools:velocity-tools-generic:3.1")
 
   implementation(project(":commons"))
   testImplementation(testFixtures(project(":commons")))
@@ -257,3 +260,47 @@ signing {
   }
   signatureTypes = ASCSignatureProvider()
 }
+
+/** ******************************* */
+/* Documentation building section */
+/** ******************************* */
+tasks.register("buildDocs") {
+  dependsOn("buildConfigMd")
+  dependsOn("buildConfigYml")
+}
+
+tasks.register<JavaExec>("buildConfigMd") {
+  mainClass = "io.aiven.kafka.connect.tools.ConfigDoc"
+  classpath =
+      sourceSets.main
+          .get()
+          .compileClasspath
+          .plus(files(tasks.jar))
+          .plus(sourceSets.main.get().runtimeClasspath)
+  args =
+      listOf(
+          "io.aiven.kafka.connect.s3.config.S3SinkConfig",
+          "configDef",
+          "src/templates/configData.md.vm",
+          "build/site/markdown/s3-sink-connector/S3SinkConfig.md")
+}
+
+tasks.register<JavaExec>("buildConfigYml") {
+  mainClass = "io.aiven.kafka.connect.tools.ConfigDoc"
+  classpath =
+      sourceSets.main
+          .get()
+          .compileClasspath
+          .plus(files(tasks.jar))
+          .plus(sourceSets.main.get().runtimeClasspath)
+  args =
+      listOf(
+          "io.aiven.kafka.connect.s3.config.S3SinkConfig",
+          "configDef",
+          "src/templates/configData.yml.vm",
+          "build/site/s3-sink-connector/S3SinkConfig.yml")
+}
+
+/** ****************************** */
+/*  End of documentation section */
+/** ****************************** */

s3-sink-connector/src/templates/configData.md.vm

@@ -0,0 +1,15 @@
+
+# S3 Sink Configuration
+
+The complete S3 sink configuration file
+
+#foreach ($section in $sections)
+${esc.hash}${esc.hash} ${section.displayName}
+ - Default value: ${section.getDefaultValue()|"none"}
+ - Type:  $section.type
+ - Valid values:  ${section.validator|"no restrictions"}
+ - Importance: $section.importance
+
+ $section.documentation
+
+#end

s3-sink-connector/src/templates/configData.yml.vm

@@ -0,0 +1,10 @@
+S3SinkConfigDef:
+#foreach ($section in $sections)
+-
+  name: ${section.displayName}
+  documentation:  $section.documentation
+  type:  $section.type
+  default: ${section.getDefaultValue()|"none"}
+  validValues: ${section.validator|"no restrictions"}
+  importance: $section.importance
+#end

site/src/site/site.xml

@@ -81,6 +81,7 @@ under the License.
 
                 <item name="Sink">
                     <item name="Introduction" href="s3-sink-connector/index.html"/>
+                    <item name="Configuration" href="s3-sink-connector/S3SinkConfig.html"/>
                     <item name="Javadoc" href="s3-sink-connector/javadoc/index.html"/>
                 </item>