You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by al...@apache.org on 2022/06/01 13:44:20 UTC
[camel-quarkus] 01/01: Fix invalid links in the contributor guide doc
This is an automated email from the ASF dual-hosted git repository.
aldettinger pushed a commit to branch cq-contributor-guide-invalid-links
in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
commit 42bb25ca3abf9d51d5c761150482d5a03aba42e5
Author: aldettinger <al...@gmail.com>
AuthorDate: Wed Jun 1 15:37:41 2022 +0200
Fix invalid links in the contributor guide doc
---
.../ROOT/pages/contributor-guide/extension-documentation.adoc | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/modules/ROOT/pages/contributor-guide/extension-documentation.adoc b/docs/modules/ROOT/pages/contributor-guide/extension-documentation.adoc
index 0849659571..26ad0cf47d 100644
--- a/docs/modules/ROOT/pages/contributor-guide/extension-documentation.adoc
+++ b/docs/modules/ROOT/pages/contributor-guide/extension-documentation.adoc
@@ -2,24 +2,24 @@
:page-aliases: extension-documentation.adoc
The documentation pages for the individual extensions are generated by the
-`https://github.com/apache/camel-quarkus/blob/main/tooling/package-maven-plugin/src/main/java/org/apache/camel/quarkus/maven/UpdateExtensionDocPageMojo.java[update-extension-doc-page]` mojo
+`https://github.com/apache/camel-quarkus/blob/main/tooling/maven-plugin/src/main/java/org/apache/camel/quarkus/maven/UpdateExtensionDocPageMojo.java[update-extension-doc-page]` mojo
of `camel-quarkus-maven-plugin`.
The mojo is invoked from the runtime module of each extension.
The resulting AsciiDoc files are stored in
-`https://github.com/apache/camel-quarkus/tree/main/docs/modules/ROOT/pages/extensions[docs/modules/ROOT/pages/extensions]`.
+`https://github.com/apache/camel-quarkus/blob/main/docs/modules/ROOT/pages/reference/extensions[docs/modules/ROOT/pages/extensions]`.
From there, the pages are published by Antora to the Camel website.
The pages are referenced i.e. from the xref:reference/index.adoc[List of Camel Quarkus extensions]
and from Camel Quarkus items on https://code.quarkus.io/[code.quarkus.io].
-The `update-extension-doc-page` mojo merges the https://github.com/apache/camel-quarkus/blame/main/tooling/package-maven-plugin/src/main/resources/doc-templates/extension-doc-page.adoc[FreeMarker template] with the following data:
+The `update-extension-doc-page` mojo merges the https://raw.githubusercontent.com/apache/camel-quarkus/main/tooling/maven-plugin/src/main/resources/doc-templates/extension-doc-page.adoc[FreeMarker template] with the following data:
* `artifactIdBase`: the `artifactId` of the runtime module without the `camel-quarkus-` prefix.
* `jvmSince`: the `<camel.quarkus.jvmSince>` property in the runtime `pom.xml`
* `nativeSince`: the `<camel.quarkus.nativeSince>` property in the runtime `pom.xml`
* `nativeSupported`: `false` if the given extension lives under `extensions-jvm`, `true` otherwise.
* `models`: the list of Camel
- https://github.com/apache/camel/blob/main/tooling/camel-tooling-model/src/main/java/org/apache/camel/tooling/model/ComponentModel.java[components]
+ https://github.com/apache/camel/blob/main/tooling/camel-tooling-model/src/main/java/org/apache/camel/tooling/model/ComponentModel.java[components],
https://github.com/apache/camel/blob/main/tooling/camel-tooling-model/src/main/java/org/apache/camel/tooling/model/DataFormatModel.java[data formats], https://github.com/apache/camel/blob/main/tooling/camel-tooling-model/src/main/java/org/apache/camel/tooling/model/LanguageModel.java[languages], etc. the given extension delivers.
* `intro`: the first paragraph (optional); the content of `src/main/doc/intro.adoc` in the runtime module of the given extension.
If `intro.adoc` does not exist, the `description` from the Camel Catalog is used as the first paragraph on the page.