Skip to content

feat: add analytics to api ref docs #1587

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.

Sign up for GitHub

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

Merged
merged 10 commits into from
May 6, 2025
Merged

feat: add analytics to api ref docs #1587

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
709eeff
smithy-kotlin version bump
xinsong-cui Apr 18, 2025
5df8a56
add analytics to api ref docs
xinsong-cui Apr 29, 2025
b18a1b2
revert commit
xinsong-cui Apr 29, 2025
2df3f3a
Merge branch 'main' of https://github.com/awslabs/aws-sdk-kotlin
xinsong-cui Apr 29, 2025
a73243a
Merge branch 'main' into add-analytics-to-api-ref-docs
xinsong-cui Apr 29, 2025
5aa178b
add test
xinsong-cui May 2, 2025
2a688f6
lint
xinsong-cui May 2, 2025
5e80127
address windows file path
xinsong-cui May 2, 2025
bba1a63
fail test when file not exist
xinsong-cui May 6, 2025
8cfeba4
lint
xinsong-cui May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/dokka-presets/templates/base.ftl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<@page_metadata.display/>
<#-- AWS Analytics tracking script - Implements site-wide analytics and tracking functionality -->
<script src="https://a0.awsstatic.com/s_code/js/3.0/awshome_s_code.js"></script>
<@template_cmd name="pathToRoot"><script>var pathToRoot = "${pathToRoot}";</script></@template_cmd>
<script>document.documentElement.classList.replace("no-js","js");</script>
<#-- This script doesn't need to be there but it is nice to have
Expand All @@ -24,6 +26,16 @@
}
}
</script>
<#-- Scripts for onboarding AWS Shortbread - Manages cookie consent banners and user preferences to help ensure
compliance with privacy regulations like GDPR -->
<script>var existingShortbreadEl = document.getElementById("awsccc-sb-ux-c");
existingShortbreadEl && existingShortbreadEl.remove();
</script>
<script src="https://prod.assets.shortbread.aws.dev/shortbread.js"></script>
<link href="https://prod.assets.shortbread.aws.dev/shortbread.css" rel="stylesheet">
<script>const shortbread = AWSCShortbread();
shortbread.checkForCookieConsent();
</script>
<#-- Resources (scripts, stylesheets) are handled by Dokka.
Use customStyleSheets and customAssets to change them. -->
<@resources/>
Expand Down
38 changes: 38 additions & 0 deletions dokka-aws/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@
*/
import org.jetbrains.kotlin.gradle.dsl.JvmTarget
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
import java.time.LocalDate

/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0
*/
plugins {
alias(libs.plugins.dokka)
alias(libs.plugins.kotlin.jvm)
}

Expand All @@ -18,6 +20,16 @@ description = "Custom Dokka plugin for AWS Kotlin SDK API docs"
dependencies {
compileOnly(libs.dokka.base)
compileOnly(libs.dokka.core)

testImplementation(libs.jsoup)
testImplementation(libs.junit.jupiter)
testImplementation(libs.kotest.assertions.core.jvm)
testImplementation(libs.kotlin.test.junit5)
}

tasks.test {
useJUnitPlatform()
dependsOn(tasks.dokkaHtml)
}

tasks.withType<KotlinCompile> {
Expand All @@ -31,3 +43,29 @@ tasks.withType<JavaCompile> {
sourceCompatibility = JavaVersion.VERSION_1_8.toString()
targetCompatibility = JavaVersion.VERSION_1_8.toString()
}

tasks.withType<org.jetbrains.dokka.gradle.AbstractDokkaTask>().configureEach {
val sdkVersion: String by project
moduleVersion.set(sdkVersion)

val year = LocalDate.now().year
val pluginConfigMap = mapOf(
"org.jetbrains.dokka.base.DokkaBase" to """
{
"customStyleSheets": [
"${rootProject.file("docs/dokka-presets/css/logo-styles.css").absolutePath.replace("\\", "/")}",
"${rootProject.file("docs/dokka-presets/css/aws-styles.css").absolutePath.replace("\\", "/")}"
],
"customAssets": [
"${rootProject.file("docs/dokka-presets/assets/logo-icon.svg").absolutePath.replace("\\", "/")}",
"${rootProject.file("docs/dokka-presets/assets/aws_logo_white_59x35.png").absolutePath.replace("\\", "/")}",
"${rootProject.file("docs/dokka-presets/scripts/accessibility.js").absolutePath.replace("\\", "/")}"
],
"footerMessage": "© $year, Amazon Web Services, Inc. or its affiliates. All rights reserved.",
"separateInheritedMembers" : true,
"templatesDir": "${rootProject.file("docs/dokka-presets/templates").absolutePath.replace("\\", "/")}"
}
""",
)
pluginsMapConfiguration.set(pluginConfigMap)
}
40 changes: 40 additions & 0 deletions dokka-aws/src/test/kotlin/aws/sdk/kotlin/dokka/DokkaAwsTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0
*/
package aws.sdk.kotlin.dokka

import org.jsoup.Jsoup
import org.junit.jupiter.api.Assumptions.assumeTrue
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.TestInstance
import java.io.File
import kotlin.test.assertTrue

@TestInstance(TestInstance.Lifecycle.PER_CLASS)
class DokkaAwsTest {
@Test
fun testLoadScripts() {
val testFile = File("build/dokka/html/index.html")

assumeTrue(
testFile.exists(),
"Skipping test: test file does not exist",
)
Copy link
Contributor

@ianbotsf ianbotsf May 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: We should not skip the test if the test file doesn't exist. We should fail (i.e., assertTrue).


val document = Jsoup.parse(testFile, "UTF-8")

val expectedScripts = listOf(
"awshome_s_code.js",
)

val scripts = document.head().select("script[src]")

expectedScripts.forEach { expectedScript ->
assertTrue(
scripts.any { it.attr("src").endsWith(expectedScript) },
"Expected script $expectedScript not found",
)
}
}
}
3 changes: 3 additions & 0 deletions gradle/libs.versions.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ kotlinx-benchmark-version = "0.4.12"
kotlinx-serialization-version = "1.7.3"
mockk-version = "1.13.13"
slf4j-version = "2.0.16"
jsoup-version = "1.19.1"
Copy link
Contributor

@ianbotsf ianbotsf May 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: The latest release is 1.20.1


[libraries]
aws-kotlin-repo-tools-build-support = { module="aws.sdk.kotlin.gradle:build-support", version.ref = "aws-kotlin-repo-tools-version" }
Expand Down Expand Up @@ -111,6 +112,8 @@ smithy-aws-smoke-test-model = { module = "software.amazon.smithy:smithy-aws-smok
junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit-version" }
junit-jupiter-params = { module = "org.junit.jupiter:junit-jupiter-params", version.ref = "junit-version" }

jsoup = { module = "org.jsoup:jsoup", version.ref = "jsoup-version" }

kotest-assertions-core = { module = "io.kotest:kotest-assertions-core", version.ref = "kotest-version" }
kotest-assertions-core-jvm = { module = "io.kotest:kotest-assertions-core-jvm", version.ref = "kotest-version" }
kotest-framework-datatest = { module = "io.kotest:kotest-framework-datatest", version.ref = "kotest-version" }
Expand Down
Loading