Docs development (#201)

* close browser when screenshotting * add website link to Javadoc JAR text * add de.smartsquare/mqtt-starter example
adamko-dev · Mar 22, 2024 · 31ee8ed · 31ee8ed
1 parent 665bd62
commit 31ee8ed
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 7 deletions.
diff --git a/buildSrc/src/main/kotlin/buildsrc/conventions/kotlin-gradle-plugin.gradle.kts b/buildSrc/src/main/kotlin/buildsrc/conventions/kotlin-gradle-plugin.gradle.kts
@@ -16,11 +16,14 @@ val createJavadocJarReadme by tasks.registering(Sync::class) {
   from(
     resources.text.fromString(
       """
-      This Javadoc JAR is intentionally empty.
-      
-      For documentation, see the sources JAR or https://github.com/adamko-dev/dokkatoo/
-      
-    """.trimIndent()
+        |This Javadoc JAR is intentionally empty.
+        |
+        |For documentation, see:
+        |* https://adamko-dev.github.io/dokkatoo/
+        |* https://github.com/adamko-dev/dokkatoo/
+        |* Or the sources JAR. 
+        |
+      """.trimMargin()
     )
   ) {
     rename { "readme.txt" }

diff --git a/buildSrc/src/main/kotlin/buildsrc/screenshotter/ScreenshotterWorker.kt b/buildSrc/src/main/kotlin/buildsrc/screenshotter/ScreenshotterWorker.kt
@@ -16,6 +16,7 @@ import kotlin.time.Duration.Companion.seconds
 import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.logging.Logging
 import org.gradle.api.provider.ListProperty
+import org.gradle.kotlin.dsl.support.useToRun
 import org.gradle.workers.WorkAction
 import org.gradle.workers.WorkParameters
 
@@ -68,7 +69,7 @@ internal abstract class ScreenshotterWorker : WorkAction<ScreenshotterWorker.Par
       newPage(
         NewPageOptions()
           .setColorScheme(colorScheme)
-      ).apply {
+      ).useToRun {
         navigate(uri.toString()).finished()
         waitForLoadState(DOMCONTENTLOADED)
         Thread.sleep(0.5.seconds.inWholeMilliseconds)

diff --git a/modules/docs/build.gradle.kts b/modules/docs/build.gradle.kts
@@ -122,4 +122,5 @@ tasks.screenshotter {
     "Kotlin-JS-Resources-Plugin",
     "https://opensavvy.gitlab.io/automation/kotlin-js-resources/api-docs/"
   )
+  website("mqtt-starter", "https://javadoc.io/doc/de.smartsquare/mqtt-starter/latest/index.html")
 }
diff --git a/modules/docs/site/src/data/showcase/mqtt-starter.png b/modules/docs/site/src/data/showcase/mqtt-starter.png
diff --git a/modules/docs/site/src/data/users.tsx b/modules/docs/site/src/data/users.tsx
@@ -112,7 +112,18 @@ const Users: User[] = [
     preview: <JarFileIcon className="java-filetype"/>,
     website: null, // it appears a new version hasn't been published since Dokkatoo was added
     source: "https://github.com/GW2ToolBelt/api-generator/blob/2059cd9883a9eb9347e66679c42e471bf48e28e4/build.gradle.kts#L59-L83",
-    tags: ["html", "javadocJar"],
+    tags: ["html", "javadocJar", "kotlinJvm"],
+  },
+  {
+    title: "HiveMQ Spring Boot Starter",
+    description: "Use an automatically configured mqtt 3 or 5 client in your Spring Boot project.",
+    preview: <img
+        alt={`HiveMQ Spring Boot Starter website screenshot`}
+        src={require("./showcase/mqtt-starter.png").default}
+    />,
+    website: "https://javadoc.io/doc/de.smartsquare/mqtt-starter/latest/index.html",
+    source: "https://github.com/SmartsquareGmbH/mqtt-starter/blob/f0125bd179c64949dc0730539d24bca15263b855/build.gradle.kts#L75-L88",
+    tags: ["html", "javadocJar", "kotlinJvm"],
   },
   {
     title: "KobanKat",