From 17117f57d67fd8aca571582abb447688399bc073 Mon Sep 17 00:00:00 2001 From: Mitchell Herrijgers Date: Thu, 3 Oct 2024 16:15:18 +0100 Subject: [PATCH 1/7] MULTI-REPO_COMMIT: Move all extension reference guides to their designated 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. --- docs/README.md | 2 +- docs/_playbook/playbook.yaml | 2 +- docs/extension-guide/antora.yml | 14 -------------- docs/reference/antora.yml | 14 ++++++++++++++ .../modules/ROOT/pages/config.adoc | 2 +- .../modules/ROOT/pages/index.adoc | 0 .../modules/nav.adoc | 0 7 files changed, 17 insertions(+), 17 deletions(-) delete mode 100644 docs/extension-guide/antora.yml create mode 100644 docs/reference/antora.yml rename docs/{extension-guide => reference}/modules/ROOT/pages/config.adoc (98%) rename docs/{extension-guide => reference}/modules/ROOT/pages/index.adoc (100%) rename docs/{extension-guide => reference}/modules/nav.adoc (100%) diff --git a/docs/README.md b/docs/README.md index 3f26035..bc8455f 100644 --- 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 index 608a7c5..c345ca8 100644 --- 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 deleted file mode 100644 index 6238707..0000000 --- a/docs/extension-guide/antora.yml +++ /dev/null @@ -1,14 +0,0 @@ -name: tracing_extension_guide -title: Tracing Extension Guide -version: true -prerelease: true -start_page: ROOT:index.adoc - -asciidoc: - attributes: - component_description: The Tracing Extension guide from the former reference guide - type: guide - group: axon-framework - -nav: - - modules/nav.adoc \ No newline at end of file diff --git a/docs/reference/antora.yml b/docs/reference/antora.yml new file mode 100644 index 0000000..0c1efac --- /dev/null +++ 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 \ No newline at end of file diff --git a/docs/extension-guide/modules/ROOT/pages/config.adoc b/docs/reference/modules/ROOT/pages/config.adoc similarity index 98% rename from docs/extension-guide/modules/ROOT/pages/config.adoc rename to docs/reference/modules/ROOT/pages/config.adoc index e05de3f..ca065f5 100644 --- a/docs/extension-guide/modules/ROOT/pages/config.adoc +++ b/docs/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/docs/extension-guide/modules/ROOT/pages/index.adoc b/docs/reference/modules/ROOT/pages/index.adoc similarity index 100% rename from docs/extension-guide/modules/ROOT/pages/index.adoc rename to docs/reference/modules/ROOT/pages/index.adoc diff --git a/docs/extension-guide/modules/nav.adoc b/docs/reference/modules/nav.adoc similarity index 100% rename from docs/extension-guide/modules/nav.adoc rename to docs/reference/modules/nav.adoc From 1e2c9a4af953dc28e5c568b2f1cfbd8986c75903 Mon Sep 17 00:00:00 2001 From: Mitchell Herrijgers Date: Thu, 3 Oct 2024 17:06:50 +0100 Subject: [PATCH 2/7] Fix dead links over all documentation repositories --- docs/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/README.md b/docs/README.md index bc8455f..8775c0e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # Documentation For Axon Framework - Tracing Extension. -This folder contains the docs related to the Tracing Extension for Axon Framework. The docs in this folder are written as part of the [AxonIQ Library](https://library.axoniq.io), and are [written in Ascii and built with Antora.](https://library.axoniq.io/contribution_guide/overview/platform.html) +This folder contains the docs related to the Tracing Extension for Axon Framework. The docs in this folder are written as part of the [AxonIQ Library](https://library.axoniq.io), and are [written in Ascii and built with Antora.](https://library.axoniq.io/contibution-guide/overview/platform.html) The following are the current documentation sources (folders): @@ -8,13 +8,13 @@ The following are the current documentation sources (folders): ## Contributing to the docs. -You are welcome to contribute to these docs. Whether you want to fix a typo, or you find something missing, something that is not clear or can be improved, or even if you want to write an entire piece of docs to illustrate something that could help others to understand the use of the Bike Rental App, you are more than welcome to send a Pull Request to this GitHub repository. Just make sure you follow the guidelines explained in [AxonIQ Library Contribution Guide](https://library.axoniq.io/contribution_guide/index.html) +You are welcome to contribute to these docs. Whether you want to fix a typo, or you find something missing, something that is not clear or can be improved, or even if you want to write an entire piece of docs to illustrate something that could help others to understand the use of the Bike Rental App, you are more than welcome to send a Pull Request to this GitHub repository. Just make sure you follow the guidelines explained in [AxonIQ Library Contribution Guide](https://library.axoniq.io/contibution-guide/index.html) ## Building and testing these docs locally. If you want to build and explore the docs locally (because you have made changes or before contributing), you can use the Antora's build file in `docs/_playbook` folder. -You can check the [detailed information on how the process to build the docs works](https://library.axoniq.io/contribution_guide/overview/build.html), but in short, all you have to do is: +You can check the [detailed information on how the process to build the docs works](https://library.axoniq.io/contibution-guide/overview/build.html), but in short, all you have to do is: 1. Make sure you have Node (a LTS version is preferred), Antora and Vale installed in your system. 2. CD to the `docs/_playbook` folder. From b8b255aa3e36410a24a6a0533aac7e9d08076c71 Mon Sep 17 00:00:00 2001 From: Mitchell Herrijgers Date: Thu, 3 Oct 2024 17:15:18 +0100 Subject: [PATCH 3/7] MULTI-REPO_COMMIT: Move all extension reference guides to their designated 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. (cherry picked from commit 17117f57d67fd8aca571582abb447688399bc073) --- docs/README.md | 23 +++++++++++++++++++ docs/_playbook/playbook.yaml | 2 +- docs/extension-guide/antora.yml | 14 ----------- docs/reference/antora.yml | 14 +++++++++++ .../modules/ROOT/pages/config.adoc | 2 +- .../modules/ROOT/pages/index.adoc | 0 .../modules/nav.adoc | 0 7 files changed, 39 insertions(+), 16 deletions(-) create mode 100644 docs/README.md delete mode 100644 docs/extension-guide/antora.yml create mode 100644 docs/reference/antora.yml rename docs/{extension-guide => reference}/modules/ROOT/pages/config.adoc (98%) rename docs/{extension-guide => reference}/modules/ROOT/pages/index.adoc (100%) rename docs/{extension-guide => reference}/modules/nav.adoc (100%) diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..bc8455f --- /dev/null +++ b/docs/README.md @@ -0,0 +1,23 @@ +# Documentation For Axon Framework - Tracing Extension. + +This folder contains the docs related to the Tracing Extension for Axon Framework. The docs in this folder are written as part of the [AxonIQ Library](https://library.axoniq.io), and are [written in Ascii and built with Antora.](https://library.axoniq.io/contribution_guide/overview/platform.html) + +The following are the current documentation sources (folders): + +- `extension-guide` : [The Tracing Extension Guide](https://library.axoniq.io/tracing-extension-reference/index.html) + +## Contributing to the docs. + +You are welcome to contribute to these docs. Whether you want to fix a typo, or you find something missing, something that is not clear or can be improved, or even if you want to write an entire piece of docs to illustrate something that could help others to understand the use of the Bike Rental App, you are more than welcome to send a Pull Request to this GitHub repository. Just make sure you follow the guidelines explained in [AxonIQ Library Contribution Guide](https://library.axoniq.io/contribution_guide/index.html) + +## Building and testing these docs locally. + +If you want to build and explore the docs locally (because you have made changes or before contributing), you can use the Antora's build file in `docs/_playbook` folder. + +You can check the [detailed information on how the process to build the docs works](https://library.axoniq.io/contribution_guide/overview/build.html), but in short, all you have to do is: + +1. Make sure you have Node (a LTS version is preferred), Antora and Vale installed in your system. +2. CD to the `docs/_playbook` folder. +3. Run `npx antora playbook.yaml`. Antora will generate the set of static html files under `docs/_playbook/build/site` +4. Move to `docs/_playbook/build/site` and execute some local http server to serve files in that directory. For example by executing `python3 -m http.server 8070` +5. Open your browser and go to `http://localhost:8070`. You should be able to navigate the local version of the docs. diff --git a/docs/_playbook/playbook.yaml b/docs/_playbook/playbook.yaml index 608a7c5..c345ca8 100644 --- 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 deleted file mode 100644 index 6238707..0000000 --- a/docs/extension-guide/antora.yml +++ /dev/null @@ -1,14 +0,0 @@ -name: tracing_extension_guide -title: Tracing Extension Guide -version: true -prerelease: true -start_page: ROOT:index.adoc - -asciidoc: - attributes: - component_description: The Tracing Extension guide from the former reference guide - type: guide - group: axon-framework - -nav: - - modules/nav.adoc \ No newline at end of file diff --git a/docs/reference/antora.yml b/docs/reference/antora.yml new file mode 100644 index 0000000..0c1efac --- /dev/null +++ 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 \ No newline at end of file diff --git a/docs/extension-guide/modules/ROOT/pages/config.adoc b/docs/reference/modules/ROOT/pages/config.adoc similarity index 98% rename from docs/extension-guide/modules/ROOT/pages/config.adoc rename to docs/reference/modules/ROOT/pages/config.adoc index e05de3f..ca065f5 100644 --- a/docs/extension-guide/modules/ROOT/pages/config.adoc +++ b/docs/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/docs/extension-guide/modules/ROOT/pages/index.adoc b/docs/reference/modules/ROOT/pages/index.adoc similarity index 100% rename from docs/extension-guide/modules/ROOT/pages/index.adoc rename to docs/reference/modules/ROOT/pages/index.adoc diff --git a/docs/extension-guide/modules/nav.adoc b/docs/reference/modules/nav.adoc similarity index 100% rename from docs/extension-guide/modules/nav.adoc rename to docs/reference/modules/nav.adoc From 722a5ea331a0b2929cd4bcc88049e85ac15b3f6f Mon Sep 17 00:00:00 2001 From: Mitchell Herrijgers Date: Tue, 8 Oct 2024 17:05:39 +0100 Subject: [PATCH 4/7] Remove underscore from link --- README.md | 2 +- docs/reference/modules/ROOT/pages/index.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index da87d10..c2939ef 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Are you having trouble using the extension? We'd like to help you out the best we can! There are a couple of things to consider when you're traversing anything Axon: -* Checking the [reference guide](https://library.axoniq.io/axon_framework_ref/) should be your first stop, +* Checking the [reference guide](https://library.axoniq.io/axon-framework-reference/) should be your first stop, as the majority of possible scenarios you might encounter when using Axon should be covered there. * If the Reference Guide does not cover a specific topic you would've expected, we'd appreciate if you could post a [new thread/topic on our library fourms describing the problem](https://discuss.axoniq.io/c/26). diff --git a/docs/reference/modules/ROOT/pages/index.adoc b/docs/reference/modules/ROOT/pages/index.adoc index b04a71b..1c7a266 100644 --- a/docs/reference/modules/ROOT/pages/index.adoc +++ b/docs/reference/modules/ROOT/pages/index.adoc @@ -20,7 +20,7 @@ With this instrumentation, we can chain synchronous and asynchronous commands an ---- -The first dependency is xref:axon_framework_ref:ROOT:modules#_axon_tracing_spring_boot_starter[Spring Boot starter for Axon Tracing extension], which is the quickest start in to an extension configuration. +The first dependency is xref:axon-framework-reference:ROOT:modules#_axon_tracing_spring_boot_starter[Spring Boot starter for Axon Tracing extension], which is the quickest start in to an extension configuration. The second dependency is https://www.jaegertracing.io/[Jaeger,window=_blank,role=external] implementation for OpenTracing. From 9b6dc9e16d4926020b24eedc570da4f170547826 Mon Sep 17 00:00:00 2001 From: Mitchell Herrijgers Date: Thu, 3 Oct 2024 17:06:50 +0100 Subject: [PATCH 5/7] Fix dead links over all documentation repositories (cherry picked from commit 1e2c9a4af953dc28e5c568b2f1cfbd8986c75903) --- docs/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/README.md b/docs/README.md index bc8455f..8775c0e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # Documentation For Axon Framework - Tracing Extension. -This folder contains the docs related to the Tracing Extension for Axon Framework. The docs in this folder are written as part of the [AxonIQ Library](https://library.axoniq.io), and are [written in Ascii and built with Antora.](https://library.axoniq.io/contribution_guide/overview/platform.html) +This folder contains the docs related to the Tracing Extension for Axon Framework. The docs in this folder are written as part of the [AxonIQ Library](https://library.axoniq.io), and are [written in Ascii and built with Antora.](https://library.axoniq.io/contibution-guide/overview/platform.html) The following are the current documentation sources (folders): @@ -8,13 +8,13 @@ The following are the current documentation sources (folders): ## Contributing to the docs. -You are welcome to contribute to these docs. Whether you want to fix a typo, or you find something missing, something that is not clear or can be improved, or even if you want to write an entire piece of docs to illustrate something that could help others to understand the use of the Bike Rental App, you are more than welcome to send a Pull Request to this GitHub repository. Just make sure you follow the guidelines explained in [AxonIQ Library Contribution Guide](https://library.axoniq.io/contribution_guide/index.html) +You are welcome to contribute to these docs. Whether you want to fix a typo, or you find something missing, something that is not clear or can be improved, or even if you want to write an entire piece of docs to illustrate something that could help others to understand the use of the Bike Rental App, you are more than welcome to send a Pull Request to this GitHub repository. Just make sure you follow the guidelines explained in [AxonIQ Library Contribution Guide](https://library.axoniq.io/contibution-guide/index.html) ## Building and testing these docs locally. If you want to build and explore the docs locally (because you have made changes or before contributing), you can use the Antora's build file in `docs/_playbook` folder. -You can check the [detailed information on how the process to build the docs works](https://library.axoniq.io/contribution_guide/overview/build.html), but in short, all you have to do is: +You can check the [detailed information on how the process to build the docs works](https://library.axoniq.io/contibution-guide/overview/build.html), but in short, all you have to do is: 1. Make sure you have Node (a LTS version is preferred), Antora and Vale installed in your system. 2. CD to the `docs/_playbook` folder. From 0737e7d72a8275fcf280d3189332074146e35c20 Mon Sep 17 00:00:00 2001 From: Mitchell Herrijgers Date: Tue, 8 Oct 2024 17:07:31 +0100 Subject: [PATCH 6/7] Enable versioning and add release notes --- docs/reference/antora.yml | 5 +++-- docs/reference/modules/ROOT/pages/release-notes.adoc | 11 +++++++++++ docs/reference/modules/nav.adoc | 4 ++-- 3 files changed, 16 insertions(+), 4 deletions(-) create mode 100644 docs/reference/modules/ROOT/pages/release-notes.adoc diff --git a/docs/reference/antora.yml b/docs/reference/antora.yml index 0c1efac..7fecd1e 100644 --- a/docs/reference/antora.yml +++ b/docs/reference/antora.yml @@ -1,7 +1,8 @@ name: tracing-extension-reference title: Tracing Extension Guide -version: true -prerelease: true +version: + axon-tracing-(?+({0..9}).+({0..9})).*: $ + master: development start_page: ROOT:index.adoc asciidoc: diff --git a/docs/reference/modules/ROOT/pages/release-notes.adoc b/docs/reference/modules/ROOT/pages/release-notes.adoc new file mode 100644 index 0000000..409e226 --- /dev/null +++ b/docs/reference/modules/ROOT/pages/release-notes.adoc @@ -0,0 +1,11 @@ += Release Notes Tracing Extension +:navtitle: Release notes + +You can find the release notes for the Tracing Extension of version 4.10 below. +For earlier releases, please go to the link:https://legacydocs.axoniq.io/reference-guide/release-notes/rn-extensions/rn-tracing[legacy documentation]. + +== Release 4.10 + +Upgrades the Tracing Extension to be compatible with Axon Framework 4.10.0, and updates various dependencies. + +See the link:https://github.com/AxonFramework/extension-tracing/releases/tag/axon-tracing-4.10.0[GitHub release notes] for an exhaustive list of all changes. \ No newline at end of file diff --git a/docs/reference/modules/nav.adoc b/docs/reference/modules/nav.adoc index 7df35ff..3080c2d 100644 --- a/docs/reference/modules/nav.adoc +++ b/docs/reference/modules/nav.adoc @@ -1,2 +1,2 @@ -* xref::index.adoc[] -** xref::config.adoc[] \ No newline at end of file +* xref::config.adoc[] +* xref::release-notes.adoc[] From bd37567a502223604824730a219dbeae4a11af03 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sun, 27 Oct 2024 04:15:54 +0000 Subject: [PATCH 7/7] Bump actions/setup-java in the github-dependencies group Bumps the github-dependencies group with 1 update: [actions/setup-java](https://github.com/actions/setup-java). Updates `actions/setup-java` from 4.4.0 to 4.5.0 - [Release notes](https://github.com/actions/setup-java/releases) - [Commits](https://github.com/actions/setup-java/compare/v4.4.0...v4.5.0) --- updated-dependencies: - dependency-name: actions/setup-java dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github-dependencies ... Signed-off-by: dependabot[bot] --- .github/workflows/main.yml | 2 +- .github/workflows/pullrequest.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index e624edd..b8e2359 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -30,7 +30,7 @@ jobs: uses: actions/checkout@v4 - name: Set up JDK ${{ matrix.java-version }} - uses: actions/setup-java@v4.4.0 + uses: actions/setup-java@v4.5.0 with: distribution: 'zulu' java-version: ${{ matrix.java-version }} diff --git a/.github/workflows/pullrequest.yml b/.github/workflows/pullrequest.yml index c175760..9039c88 100644 --- a/.github/workflows/pullrequest.yml +++ b/.github/workflows/pullrequest.yml @@ -23,7 +23,7 @@ jobs: uses: actions/checkout@v4 - name: Set up JDK ${{ matrix.java-version }} - uses: actions/setup-java@v4.4.0 + uses: actions/setup-java@v4.5.0 with: distribution: 'zulu' java-version: ${{ matrix.java-version }}