You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2021/12/02 09:32:56 UTC
[camel] branch main updated: Fixed xref failure
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 0ebbd2c Fixed xref failure
0ebbd2c is described below
commit 0ebbd2c0fde9c512510c22025d5744ed7c68523f
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Thu Dec 2 10:32:24 2021 +0100
Fixed xref failure
---
.../ROOT/pages/improving-the-documentation.adoc | 20 ++++++++++++++++----
1 file changed, 16 insertions(+), 4 deletions(-)
diff --git a/docs/user-manual/modules/ROOT/pages/improving-the-documentation.adoc b/docs/user-manual/modules/ROOT/pages/improving-the-documentation.adoc
index 0feca21..44aaddd 100644
--- a/docs/user-manual/modules/ROOT/pages/improving-the-documentation.adoc
+++ b/docs/user-manual/modules/ROOT/pages/improving-the-documentation.adoc
@@ -204,12 +204,18 @@ Generally there will never be a reason to refer from one version of a component
To assure this happens without maintenance issues, leave out the version and component segments from the xref, e.g. in the `components` component
[source,adoc]
-xref:eips:enterprise-integration-patterns.adoc[]
+----
+# use lowercase xref!
+XREF:eips:enterprise-integration-patterns.adoc[]
+----
NOT
[source,adoc]
-xref:next@components:eips:enterprise-integration-patterns.adoc[]
+----
+# use lowercase xref!
+XREF:next@components:eips:enterprise-integration-patterns.adoc[]
+----
Do this no matter how many locations the component is distributed over.
@@ -224,7 +230,10 @@ Leave out the version segment.
For example, this will link to this page from anywhere in the documentation:
[source,adoc]
-xref:user-manual::improving-the-documentation.adoc[]
+----
+# use lowercase xref!
+XREF:user-manual::improving-the-documentation.adoc[]
+----
=== Links between subprojects
@@ -257,6 +266,9 @@ NOTE: Setting these up is WIP
Use these attributes to refer to documentation for the related subproject, e.g.
[source,adoc]
-xref:{camel-version}@camel:eips:enterprise-integration-patterns.adoc[]
+----
+# use lowercase xref!
+XREF:{camel-version}@camel:eips:enterprise-integration-patterns.adoc[]
+----
If there's a missing attribute, raise an issue rather than using a concrete version.
\ No newline at end of file