From f1dc762c2a54d6ff3e9a7110c8a86512cb0f2f72 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Wed, 11 May 2022 13:12:58 +0200 Subject: [PATCH] Added automatic docs generation --- docs/pom.xml | 58 ++++++++++++++++++++++ docs/src/main/asciidoc/_observability.adoc | 8 +++ docs/src/main/asciidoc/appendix.adoc | 3 ++ 3 files changed, 69 insertions(+) create mode 100644 docs/src/main/asciidoc/_observability.adoc diff --git a/docs/pom.xml b/docs/pom.xml index 28627635..bf4776f0 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -15,6 +15,12 @@ spring.cloud.task.* deploy 1.5.0-alpha.16 + + + 1.0.0-SNAPSHOT + ${maven.multiModuleProjectDirectory}/spring-cloud-task-core/ + .* + ${maven.multiModuleProjectDirectory}/target/ @@ -49,6 +55,58 @@ org.codehaus.mojo exec-maven-plugin + + + generate-metrics-metadata + prepare-package + + java + + + io.micrometer.docs.metrics.DocsFromSources + true + + ${micrometer-docs-generator.inputPath} + ${micrometer-docs-generator.inclusionPattern} + ${micrometer-docs-generator.outputPath} + + + + + generate-tracing-metadata + prepare-package + + java + + + io.micrometer.docs.spans.DocsFromSources + true + + ${micrometer-docs-generator.inputPath} + ${micrometer-docs-generator.inclusionPattern} + ${micrometer-docs-generator.outputPath} + + + + + + + io.micrometer + + micrometer-docs-generator-spans + ${micrometer-docs-generator.version} + + jar + + + io.micrometer + + micrometer-docs-generator-metrics + ${micrometer-docs-generator.version} + + jar + + org.asciidoctor diff --git a/docs/src/main/asciidoc/_observability.adoc b/docs/src/main/asciidoc/_observability.adoc new file mode 100644 index 00000000..f31372d3 --- /dev/null +++ b/docs/src/main/asciidoc/_observability.adoc @@ -0,0 +1,8 @@ +:root-target: ../../../../target/ + +[[observability]] +== Observability metadata + +include::{root-target}_metrics.adoc[] + +include::{root-target}_spans.adoc[] diff --git a/docs/src/main/asciidoc/appendix.adoc b/docs/src/main/asciidoc/appendix.adoc index 34185ba3..5dee4c42 100644 --- a/docs/src/main/asciidoc/appendix.adoc +++ b/docs/src/main/asciidoc/appendix.adoc @@ -3,4 +3,7 @@ = Appendices include::appendix-task-repository-schema.adoc[] + include::appendix-building-the-documentation.adoc[] + +include::_observability.adoc[]