WIP

docs/antora.yml

@@ -1,12 +1,12 @@
-name: micrometer
+name: micrometer-docs
 version: true
-title: Micrometer
+title: Micrometer Docs
 nav:
   - modules/ROOT/nav.adoc
 ext:
   collector:
     run:
-      command: gradlew -q -PbuildSrc.skipTests=true "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :docs:generateAntoraResources
+      command: gradlew -q -PbuildSrc.skipTests=true -Pantora "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :docs:generateAntoraResources
       local: true
     scan:
       dir: ./build/generated-antora-resources

docs/build.gradle

@@ -37,7 +37,7 @@ antora {
 
 tasks.named("generateAntoraYml") {
     asciidocAttributes = project.provider( {
-        return  ["micrometer-version": project.version]
+        return  ["micrometer-docs-version": project.version]
     } )
 }
 
@@ -49,6 +49,10 @@ tasks.named("antora") {
     dependsOn "generateAntoraResources"
 }
 
+tasks.named("antora") {
+    dependsOn "test"
+}
+
 jar {
     enabled = false
 }

docs/cached-antora-playbook.yml

@@ -9,15 +9,39 @@ antora:
     enabled: false
   - '@springio/antora-extensions/latest-version-extension'
   - require: '@springio/antora-extensions/root-component-extension'
-    root_component_name: 'micrometer'
+    root_component_name: 'micrometer docs'
 site:
-  title: Micrometer Reference
+  title: Micrometer Docs Reference
 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
 asciidoc:
   attributes:
     hide-uri-scheme: '@'
@@ -30,12 +54,14 @@ asciidoc:
   - '@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
 ui:
   bundle:
-    url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.3.0/ui-bundle.zip
+    url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.3.3/ui-bundle.zip
     snapshot: true
 

docs/modules/ROOT/nav.adoc

@@ -1,65 +1 @@
-* xref:overview.adoc[Overview]
-* xref:installing.adoc[Installing]
-* xref:concepts.adoc[Concepts]
-** xref:concepts/implementations.adoc[Supported Monitoring Systems]
-** xref:concepts/registry.adoc[Registry]
-** xref:concepts/meters.adoc[Meters]
-** xref:concepts/naming.adoc[Naming Meters]
-** xref:concepts/meter-filters.adoc[Meter Filters]
-** xref:concepts/rate-aggregation.adoc[Rate Aggregation]
-** xref:concepts/counters.adoc[Counters]
-** xref:concepts/gauges.adoc[Gauges]
-** xref:concepts/timers.adoc[Timers]
-** xref:concepts/distribution-summaries.adoc[Distribution Summaries]
-** xref:concepts/long-task-timers.adoc[Long Task Timers]
-** xref:concepts/histogram-quantiles.adoc[Histograms and Percentiles]
-* xref:implementations.adoc[Implementations]
-** xref:implementations/appOptics.adoc[AppOptics]
-** xref:implementations/atlas.adoc[Atlas]
-** xref:implementations/cloudwatch.adoc[CloudWatch]
-** xref:implementations/datadog.adoc[Datadog]
-** xref:implementations/dynatrace.adoc[Dynatrace]
-** xref:implementations/elastic.adoc[Elasticsearch]
-** xref:implementations/ganglia.adoc[Ganglia]
-** xref:implementations/graphite.adoc[Graphite]
-** xref:implementations/humio.adoc[Humio]
-** xref:implementations/influx.adoc[Influx]
-** xref:implementations/instana.adoc[Instana]
-** xref:implementations/jmx.adoc[JMX]
-** xref:implementations/kairos.adoc[KairosDB]
-** xref:implementations/new-relic.adoc[New Relic]
-** xref:implementations/otlp.adoc[OpenTelemetry Protocol (OTLP)]
-** xref:implementations/prometheus.adoc[Prometheus]
-** xref:implementations/signalFx.adoc[SignalFx]
-** xref:implementations/stackdriver.adoc[Stackdriver]
-** xref:implementations/statsD.adoc[statsD]
-** xref:implementations/wavefront.adoc[Wavefront]
-* xref:reference.adoc[Reference Instrumentations]
-** xref:reference/jvm.adoc[JVM]
-** xref:reference/cache.adoc[Cache]
-** xref:reference/okhttpclient.adoc[OkHttpClient]
-** xref:reference/jetty.adoc[Jetty and Jersey]
-** xref:reference/netty.adoc[Netty]
-* xref:guides.adoc[Guides]
-** xref:guides/console-reporter.adoc[Passing through to Dropwizard's console reporter]
-** xref:guides/http-sender-resilience4j-retry.adoc[HttpSender with Resilience4j retry]
-** xref:guides/custom-meter-registry.adoc[Custom meter registry]
-* xref:observation.adoc[Micrometer Observation]
-** xref:observation/installing.adoc[Installing]
-** xref:observation/handler.adoc[Observation Handlers]
-** xref:observation/instrumenting.adoc[Instrumenting]
-** xref:observation/testing.adoc[Testing]
-** xref:observation/docs-gen.adoc[Micrometer Observation Docs Generation]
-** xref:observation/projects.adoc[Instrumented Projects]
-* xref:tracing.adoc[Micrometer Tracing]
-** xref:tracing/glossary.adoc[Glossary]
-** xref:tracing/tracers.adoc[Supported Tracers]
-** xref:tracing/reporters.adoc[Supported Reporters]
-** xref:tracing/api.adoc[Micrometer Tracing API]
-** xref:tracing/configuring.adoc[Micrometer Observation Configuration]
-** xref:tracing/testing.adoc[Testing]
-* xref:contextpropagation.adoc[Micrometer Context Propagation]
-** xref:contextpropagation/installing.adoc[Installing]
-** xref:contextpropagation/purpose.adoc[Purpose]
-** xref:contextpropagation/usage.adoc[Usage Examples]
 * xref:support.adoc[Support]