WIP

docs/antora.yml

@@ -17,8 +17,3 @@ asciidoc:
     # FIXME: the copyright is not removed
     # FIXME: The package is not renamed
     chomp: 'all'
-    include-java: 'example$docs-src/test/java/io/micrometer/docs'
-    include-resources: 'example$docs-src/test/resources'
-    micrometer-main-code: 'https://github.com/micrometer-metrics/micrometer/tree/main'
-    docs-site: 'https://micrometer.io'
-    docs-micrometer: "{docs-site}/docs/{micrometer-version}"

docs/build.gradle

@@ -37,7 +37,12 @@ antora {
 
 tasks.named("generateAntoraYml") {
     asciidocAttributes = project.provider( {
-        return  ["micrometer-docs-version": project.version]
+        return  ["micrometer-docs-version": project.version,
+        "context-propagation-version" : "${contextPropagationVersion}".toString(),
+        "micrometer-version" : "${micrometerVersion}".toString(),
+        "tracing-version" : "${tracingVersion}".toString(),
+        "micrometer-docs-generation-version" : "${micrometerDocsGeneratorVersion}".toString(),
+        ]
     } )
 }
 

docs/cached-antora-playbook.yml

@@ -9,59 +9,38 @@ antora:
     enabled: false
   - '@springio/antora-extensions/latest-version-extension'
   - require: '@springio/antora-extensions/root-component-extension'
-    root_component_name: 'micrometer docs'
+    root_component_name: 'micrometer-docs'
 site:
-  title: Micrometer Docs Reference
+  title: Micrometer Documentation
+  url: https://micrometer.io/docs/
+  robots: allow
+git:
+  ensure_git_suffix: false
 content:
   sources:
-  - url: ./..
-    branches: HEAD
-    start_path: docs
-    worktrees: true
-  - url: https://github.com/micrometer-metrics/micrometer.git
-    start_path: docs
-    # This will need to become sth like this
-    # branches: ['main', '1.+({0..1}).x']
-    # tags: ['v{1..9}.+({0..9}).+({0..9})?(-{RC,M}*)', '!(v1.0.{0..8})', '!(v1.1.{0..8})', '!(v1.0.0-{RC,M}{0..9})','!(v1.1.0-{RC,M}{0..9})']
-    branches: antora
-  - url: https://github.com/micrometer-metrics/context-propagation.git
-    start_path: docs
-    # This will need to become sth like this
-    # branches: ['main', '1.+({0..1}).x']
-    # tags: ['v{1..9}.+({0..9}).+({0..9})?(-{RC,M}*)', '!(v1.0.{0..8})', '!(v1.1.{0..8})', '!(v1.0.0-{RC,M}{0..9})','!(v1.1.0-{RC,M}{0..9})']
-    branches: antora
-  - url: https://github.com/micrometer-metrics/tracing.git
-    start_path: docs
-    # This will need to become sth like this
-    # branches: ['main', '1.+({0..1}).x']
-    # tags: ['v{1..9}.+({0..9}).+({0..9})?(-{RC,M}*)', '!(v1.0.{0..8})', '!(v1.1.{0..8})', '!(v1.0.0-{RC,M}{0..9})','!(v1.1.0-{RC,M}{0..9})']
-    branches: antora
-  - url: https://github.com/micrometer-metrics/micrometer-docs-generator.git
-    start_path: docs
-    # This will need to become sth like this
-    # branches: ['main', '1.+({0..1}).x']
-    # tags: ['v{1..9}.+({0..9}).+({0..9})?(-{RC,M}*)', '!(v1.0.{0..8})', '!(v1.1.{0..8})', '!(v1.0.0-{RC,M}{0..9})','!(v1.1.0-{RC,M}{0..9})']
-    branches: antora
+    - url: ./..
+      branches: HEAD
+      start_path: docs
+      worktrees: true
 asciidoc:
   attributes:
     hide-uri-scheme: '@'
     page-pagination: ''
-    primary-site-url: https://micrometer.io/docs
     tabs-sync-option: '@'
   extensions:
-  - '@asciidoctor/tabs'
-  - '@springio/asciidoctor-extensions'
-  - '@springio/asciidoctor-extensions/include-code-extension'
+    - '@asciidoctor/tabs'
+    - '@springio/asciidoctor-extensions'
+    - '@springio/asciidoctor-extensions/include-code-extension'
   sourcemap: true
 urls:
   latest_version_segment_strategy: redirect:to
   latest_version_segment: ''
   redirect_facility: httpd
 runtime:
   log:
-    failure_level: warn
+    failure_level: error
 ui:
   bundle:
-    url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.3.3/ui-bundle.zip
+    url: https://github.com/rwinch/antora-ui-micrometer/releases/download/latest/ui-bundle.zip
     snapshot: true
 

docs/modules/ROOT/pages/index.adoc

@@ -9,9 +9,11 @@ Think SLF4J, but for observability.
 
 == Projects
 
-Micrometer `2023.11` release train consists of the following projects:
+Micrometer consists of various projects that have their own release cycle. Micrometer does not come with a release train BOM (Bill of Materials) but for your convenience we are grouping the corresponding projects with their compatible versions.
 
-- xref:1.12.0@micrometer:ROOT:index.adoc[Micrometer Core 1.12.0]
-- xref:1.1.0@micrometer-context-propagation:ROOT:index.adoc[Micrometer Context Propagation 1.1.0]
-- xref:1.2.0@micrometer-tracing:ROOT:index.adoc[Micrometer Tracing 1.2.0]
-- xref:1.1.0@micrometer-docs-generator:ROOT:index.adoc[Micrometer Docs Generator 1.1.0]
+Micrometer `{micrometer-docs-version}` release train consists of the following projects:
+
+- https://micrometer.io/docs/context-propagation/reference/{context-propagation-version}/index.html[Micrometer Context Propagation {context-propagation-version}]
+- https://micrometer.io/docs/micrometer/reference/{micrometer-version}/index.html[Micrometer Core {micrometer-version}]
+- https://micrometer.io/docs/tracing/reference/{tracing-version}/index.html[Micrometer Tracing {tracing-version}]
+- https://micrometer.io/docs/docs-generation/reference/{micrometer-docs-generation-version}/index.html[Micrometer Docs Generator {micrometer-docs-generation-version}]

gradle.properties

@@ -6,5 +6,10 @@ org.gradle.vfs.watch=true
 # see https://github.com/psxpaul/gradle-execfork-plugin/issues/1#issuecomment-307298771
 org.gradle.daemon=false
 
+# Antora
 # aligned with the latest release train for now
 version=2023.11.0-SNAPSHOT
+contextPropagationVersion=1.1.0-SNAPSHOT
+micrometerVersion=1.12.0-SNAPSHOT
+tracingVersion=1.2.0-SNAPSHOT
+micrometerDocsGeneratorVersion=1.1.0-SNAPSHOT