Merge pull request #4795 from JetBrains/ktl-1754-add-suffix-to-the-api-refs

ktl-1754 chore: Add context to the API refs title

Author: zoobestik

.teamcity/BuildParams.kt

@@ -4,30 +4,37 @@ object BuildParams {
   const val KOTLINX_COROUTINES_RELEASE_LABEL = "1.10.1"
   const val KOTLINX_COROUTINES_RELEASE_TAG = "whyoleg/dokka2-sync" // master
   const val KOTLINX_COROUTINES_ID = "kotlinx.coroutines"
+  const val KOTLINX_COROUTINES_TITLE = KOTLINX_COROUTINES_ID
 
   const val KOTLINX_SERIALIZATION_RELEASE_LABEL = "v1.8.1"
   const val KOTLINX_SERIALIZATION_RELEASE_TAG = "whyoleg/dokka2-sync" // master
   const val KOTLINX_SERIALIZATION_ID = "kotlinx.serialization"
+  const val KOTLINX_SERIALIZATION_TITLE = KOTLINX_SERIALIZATION_ID
 
   const val KOTLINX_DATETIME_RELEASE_LABEL = "v0.6.2"
   const val KOTLINX_DATETIME_RELEASE_TAG = "whyoleg/dokka2-sync" // latest-release
   const val KOTLINX_DATETIME_ID = "kotlinx-datetime"
+  const val KOTLINX_DATETIME_TITLE = KOTLINX_DATETIME_ID
 
   const val KOTLINX_IO_RELEASE_LABEL = "0.7.0" // KOTLINX_IO_RELEASE_TAG
   const val KOTLINX_IO_RELEASE_TAG = "whyoleg/dokka2-sync" // 0.6.0
   const val KOTLINX_IO_ID = "kotlinx-io"
-
+  const val KOTLINX_IO_TITLE = KOTLINX_IO_ID
 
   const val KOTLIN_RELEASE_LABEL = "2.1.20"
   const val KOTLIN_RELEASE_TAG = "whyoleg/dokka2-sync-stdlib"
-  const val KOTLIN_CORE_API_BUILD_ID = "Kotlin_KotlinRelease_2120_LibraryReferenceLatestDocs"
+
+  const val CORE_API_BUILD_ID = "Kotlin_KotlinRelease_2120_LibraryReferenceLatestDocs"
+  const val CORE_API_TITLE = "Core API"
 
   const val KGP_RELEASE_LABEL = KOTLIN_RELEASE_LABEL
   const val KGP_RELEASE_TAG = "whyoleg/dokka2-sync"
   const val KGP_ID = "kotlin-gradle-plugin"
+  const val KGP_TITLE = "Kotlin Gradle Plugin"
 
   const val KOTLINX_METADATA_ID = "kotlinx-metadata-jvm"
   const val KOTLINX_METADATA_RELEASE_TAG = KGP_RELEASE_TAG // KOTLIN_RELEASE_TAG
+  const val KOTLINX_METADATA_TITLE = KOTLINX_METADATA_ID
 
   const val SEARCH_APP_ID = "7961PKYRXV"
   const val SEARCH_INDEX_NAME = "prod_KOTLINLANG_WEBHELP"

.teamcity/builds/apiReferences/kgp/KotlinGradlePluginPrepareDokkaTemplates.kt

@@ -1,6 +1,7 @@
 package builds.apiReferences.kgp
 
 import BuildParams.KGP_ID
+import BuildParams.KGP_TITLE
 import builds.apiReferences.templates.PrepareDokkaTemplate
 import jetbrains.buildServer.configs.kotlin.BuildType
 
@@ -11,6 +12,7 @@ object KotlinGradlePluginPrepareDokkaTemplates : BuildType({
     templates(PrepareDokkaTemplate)
 
     params {
-        param("env.ALGOLIA_INDEX_NAME", "$KGP_ID")
+        param("env.ALGOLIA_INDEX_NAME", KGP_ID)
+        param("env.API_REFERENCE_NAME", KGP_TITLE)
     }
 })

.teamcity/builds/apiReferences/kotlinx/coroutines/KotlinxCoroutinesPrepareDokkaTemplates.kt

@@ -1,6 +1,7 @@
 package builds.apiReferences.kotlinx.coroutines
 
 import BuildParams.KOTLINX_COROUTINES_ID
+import BuildParams.KOTLINX_COROUTINES_TITLE
 import builds.apiReferences.templates.PrepareDokkaTemplate
 import jetbrains.buildServer.configs.kotlin.BuildType
 
@@ -11,6 +12,7 @@ object KotlinxCoroutinesPrepareDokkaTemplates : BuildType({
     templates(PrepareDokkaTemplate)
 
     params {
-        param("env.ALGOLIA_INDEX_NAME", "$KOTLINX_COROUTINES_ID")
+        param("env.ALGOLIA_INDEX_NAME", KOTLINX_COROUTINES_ID)
+        param("env.API_REFERENCE_NAME", KOTLINX_COROUTINES_TITLE)
     }
 })

.teamcity/builds/apiReferences/kotlinx/datetime/KotlinxDatetimePrepareDokkaTemplates.kt

@@ -1,6 +1,7 @@
 package builds.apiReferences.kotlinx.datetime
 
 import BuildParams.KOTLINX_DATETIME_ID
+import BuildParams.KOTLINX_DATETIME_TITLE
 import builds.apiReferences.templates.PrepareDokkaTemplate
 import jetbrains.buildServer.configs.kotlin.BuildType
 
@@ -11,6 +12,7 @@ object KotlinxDatetimePrepareDokkaTemplates : BuildType({
     templates(PrepareDokkaTemplate)
 
     params {
-        param("env.ALGOLIA_INDEX_NAME", "$KOTLINX_DATETIME_ID")
+        param("env.ALGOLIA_INDEX_NAME", KOTLINX_DATETIME_ID)
+        param("env.API_REFERENCE_NAME", KOTLINX_DATETIME_TITLE)
     }
 })

.teamcity/builds/apiReferences/kotlinx/io/KotlinxIOPrepareDokkaTemplates.kt

@@ -1,6 +1,7 @@
 package builds.apiReferences.kotlinx.io
 
 import BuildParams.KOTLINX_IO_ID
+import BuildParams.KOTLINX_IO_TITLE
 import builds.apiReferences.templates.PrepareDokkaTemplate
 import jetbrains.buildServer.configs.kotlin.BuildType
 
@@ -11,6 +12,7 @@ object KotlinxIOPrepareDokkaTemplates : BuildType({
     templates(PrepareDokkaTemplate)
 
     params {
-        param("env.ALGOLIA_INDEX_NAME", "$KOTLINX_IO_ID")
+        param("env.ALGOLIA_INDEX_NAME", KOTLINX_IO_ID)
+        param("env.API_REFERENCE_NAME", KOTLINX_IO_TITLE)
     }
 })

.teamcity/builds/apiReferences/kotlinx/metadataJvm/KotlinxMetadataJvmPrepareDokkaTemplates.kt

@@ -1,6 +1,7 @@
 package builds.apiReferences.kotlinx.metadataJvm
 
 import BuildParams.KOTLINX_METADATA_ID
+import BuildParams.KOTLINX_METADATA_TITLE
 import builds.apiReferences.templates.PrepareDokkaTemplate
 import jetbrains.buildServer.configs.kotlin.BuildType
 
@@ -11,6 +12,7 @@ object KotlinxMetadataJvmPrepareDokkaTemplates : BuildType({
     templates(PrepareDokkaTemplate)
 
     params {
-        param("env.ALGOLIA_INDEX_NAME", "$KOTLINX_METADATA_ID")
+        param("env.ALGOLIA_INDEX_NAME", KOTLINX_METADATA_ID)
+        param("env.API_REFERENCE_NAME", KOTLINX_METADATA_TITLE)
     }
 })

.teamcity/builds/apiReferences/kotlinx/serialization/KotlinxSerializationPrepareDokkaTemplates.kt

@@ -1,6 +1,7 @@
 package builds.apiReferences.kotlinx.serialization
 
 import BuildParams.KOTLINX_SERIALIZATION_ID
+import BuildParams.KOTLINX_SERIALIZATION_TITLE
 import builds.apiReferences.templates.PrepareDokkaTemplate
 import jetbrains.buildServer.configs.kotlin.BuildType
 
@@ -11,6 +12,7 @@ object KotlinxSerializationPrepareDokkaTemplates : BuildType({
     templates(PrepareDokkaTemplate)
 
     params {
-        param("env.ALGOLIA_INDEX_NAME", "$KOTLINX_SERIALIZATION_ID")
+        param("env.ALGOLIA_INDEX_NAME", KOTLINX_SERIALIZATION_ID)
+        param("env.API_REFERENCE_NAME", KOTLINX_SERIALIZATION_TITLE)
     }
 })

.teamcity/builds/apiReferences/stdlib/BuildStdlibApiReference.kt

@@ -1,6 +1,6 @@
 package builds.apiReferences.stdlib
 
-import BuildParams.KOTLIN_CORE_API_BUILD_ID
+import BuildParams.CORE_API_BUILD_ID
 import builds.SCRIPT_PATH
 import builds.apiReferences.scriptGenerateSitemap
 import builds.apiReferences.scriptNoRobots
@@ -41,7 +41,7 @@ object BuildStdlibApiReference : BuildType({
     }
 
     dependencies {
-        dependency(AbsoluteId(KOTLIN_CORE_API_BUILD_ID)) {
+        dependency(AbsoluteId(CORE_API_BUILD_ID)) {
             artifacts {
                 buildRule = tag("publish", "*")
                 cleanDestination = true

.teamcity/builds/apiReferences/stdlib/StdlibPrepareDokkaTemplates.kt

@@ -1,5 +1,6 @@
 package builds.apiReferences.stdlib
 
+import BuildParams.CORE_API_TITLE
 import BuildParams.SEARCH_INDEX_NAME
 import builds.apiReferences.templates.PrepareDokkaTemplate
 import jetbrains.buildServer.configs.kotlin.BuildType
@@ -17,5 +18,6 @@ object StdlibPrepareDokkaTemplates : BuildType({
         param("env.ALGOLIA_INDEX_NAME", SEARCH_INDEX_NAME)
         param("env.DOKKA_CUSTOM_BODY", "core-api")
         param("env.DOKKA_FEEDBACK", "true")
+        param("env.API_REFERENCE_NAME", CORE_API_TITLE)
     }
 })

.teamcity/builds/apiReferences/templates/PrepareDokkaTemplate.kt

@@ -15,6 +15,7 @@ object PrepareDokkaTemplate: Template({
 
   params {
 //      param("env.ALGOLIA_INDEX_NAME", "")
+      param("env.API_REFERENCE_NAME", "")
   }
 
   vcs {