MULTI-REPO_COMMIT: Move all extension reference guides to their desig…

…nated page and rename README.adoc to index.adoc for friendlier URLS. Many small changes based on build output have also been done over many repositories. Some parts needed escaping, didn't have proper syntax, or headers that should really be tabs.
AxonFramework · Oct 3, 2024 · 17117f5 · 17117f5
1 parent 1061201
commit 17117f5
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 17 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -4,7 +4,7 @@ This folder contains the docs related to the Tracing Extension for Axon Framewor
 
 The following are the current documentation sources (folders):
 
-- `extension-guide` : [The Tracing Extension Guide](https://library.axoniq.io/tracing_extension_guide/index.html)
+- `extension-guide` : [The Tracing Extension Guide](https://library.axoniq.io/tracing-extension-reference/index.html)
 
 ## Contributing to the docs.
 

diff --git a/docs/_playbook/playbook.yaml b/docs/_playbook/playbook.yaml
@@ -1,6 +1,6 @@
 site:
   title: Tracing Extension docs PREVIEW
-  start_page: tracing_extension_guide::index.adoc
+  start_page: tracing-extension-reference::index.adoc
 
 content:
   sources:

diff --git a/docs/extension-guide/antora.yml b/docs/extension-guide/antora.yml
diff --git a/docs/reference/antora.yml b/docs/reference/antora.yml
@@ -0,0 +1,14 @@
+name: tracing-extension-reference
+title: Tracing Extension Guide
+version: true
+prerelease: true
+start_page: ROOT:index.adoc
+
+asciidoc:
+  attributes:
+    component_description: Extension adding OpenTracing integration to Axon's infrastructure components, superseded by integrated Open Telemetry support
+    type: extension-reference
+    group: axon-framework
+
+nav:
+  - modules/nav.adoc
diff --git a/...sion-guide/modules/ROOT/pages/config.adoc → .../reference/modules/ROOT/pages/config.adoc b/...sion-guide/modules/ROOT/pages/config.adoc → .../reference/modules/ROOT/pages/config.adoc
@@ -5,7 +5,7 @@ The extension can be disabled setting the property `axon.extension.tracing.enabl
 
 Furthermore, there is a more fine-grained configuration option of the tracing span tags on commands, events and queries. You can customize span tags easily, mixing and matching between available tag `MESSAGE_ID`, `AGGREGATE_ID`, `MESSAGE_TYPE`, `PAYLOAD_TYPE`, `MESSAGE_NAME` and `PAYLOAD`. Take into account that some of the tags make sense on a certain span type, but not on another, and some of them have an hidden cost on network (such as payload). Use them wisely.
 
-[sources,properties]
+[source,properties]
 ----
 axon.extension.tracing.span.commandTags=MESSAGE_ID, MESSAGE_TYPE, PAYLOAD_TYPE, MESSAGE_NAME
 axon.extension.tracing.span.eventTags=MESSAGE_ID, AGGREGATE_ID, MESSAGE_TYPE, PAYLOAD_TYPE

diff --git a/...nsion-guide/modules/ROOT/pages/index.adoc → docs/reference/modules/ROOT/pages/index.adoc b/...nsion-guide/modules/ROOT/pages/index.adoc → docs/reference/modules/ROOT/pages/index.adoc
diff --git a/docs/extension-guide/modules/nav.adoc → docs/reference/modules/nav.adoc b/docs/extension-guide/modules/nav.adoc → docs/reference/modules/nav.adoc