This is an automated email from the ASF dual-hosted git repository.
zregvart pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new 1ceccf2 CAMEL-13589: fix broken anchors
1ceccf2 is described below
commit 1ceccf27807d82b3212e37d180d81032154b968c
Author: Zoran Regvart <zregv...@apache.org>
AuthorDate: Tue Jul 23 09:59:39 2019 +0200
CAMEL-13589: fix broken anchors
Few last broken anchors in the documentation.
---
.../camel-bean/src/main/docs/bean-language.adoc | 10 +++++-----
.../camel-test-spring/src/main/docs/test-spring.adoc | 20 +++++++++-----------
.../camel-core/src/main/docs/eips/unmarshal-eip.adoc | 2 +-
.../components/modules/ROOT/pages/bean-language.adoc | 10 +++++-----
docs/components/modules/ROOT/pages/test-spring.adoc | 20 +++++++++-----------
.../user-manual/modules/ROOT/pages/bean-binding.adoc | 2 +-
.../modules/ROOT/pages/content-enricher.adoc | 2 +-
.../user-manual/modules/ROOT/pages/contributing.adoc | 16 +++++++++++++++-
.../modules/ROOT/pages/unmarshal-eip.adoc | 2 +-
9 files changed, 47 insertions(+), 37 deletions(-)
diff --git a/components/camel-bean/src/main/docs/bean-language.adoc
b/components/camel-bean/src/main/docs/bean-language.adoc
index b92c834..10b76fa 100644
--- a/components/camel-bean/src/main/docs/bean-language.adoc
+++ b/components/camel-bean/src/main/docs/bean-language.adoc
@@ -18,9 +18,9 @@ using the type of the message body and using any annotations
on the bean
methods.
The xref:manual::bean-binding.adoc[Bean Binding] rules are used to bind the
-xref:manual::message.html[Message] Exchange to the method parameters; so you
can
+xref:manual::message.adoc[Message] Exchange to the method parameters; so you
can
annotate the bean to extract headers or other expressions such as
-xref:components::xpath-language.adoc[XPath] or
xref:components::xquery-language.html[XQuery] from the message.
+xref:components::xpath-language.adoc[XPath] or
xref:components::xquery-language.adoc[XQuery] from the message.
[[BeanLanguage-UsingBeanExpressionsinJava]]
=== Using Bean Expressions in Java
@@ -98,11 +98,11 @@ or other expressions.
[[BeanLanguage-Non-RegistryBeans]]
=== Non-Registry Beans
-The xref:bean-language.html[Bean Language] also supports invoking beans
-that isn't registered in the xref:registry.html[Registry]. This is
+The xref:bean-language.adoc[Bean Language] also supports invoking beans
+that isn't registered in the xref:registry.adoc[Registry]. This is
usable for quickly to invoke a bean from Java DSL where you don't need
to register the bean in the xref:registry.html[Registry] such as the
-xref:spring.html[Spring] *`ApplicationContext`*. Camel can instantiate
+xref:spring.adoc[Spring] *`ApplicationContext`*. Camel can instantiate
the bean and invoke the method if given a class or invoke an already
existing instance.
diff --git a/components/camel-test-spring/src/main/docs/test-spring.adoc
b/components/camel-test-spring/src/main/docs/test-spring.adoc
index 7981da5..e665089 100644
--- a/components/camel-test-spring/src/main/docs/test-spring.adoc
+++ b/components/camel-test-spring/src/main/docs/test-spring.adoc
@@ -9,13 +9,13 @@ Allows to test Camel with Spring applications such as Spring
XML files or Spring
This documentation is old and needs to be updated
====
-http://camel.apache.org/testing.html[Testing] is a crucial part of any
development or integration work. The Spring Framework offers a number of
features that makes it easy to test while using Spring for Inversion of Control
which works with JUnit 3.x, JUnit 4.x, and http://testng.org[TestNG].
+xref:testing.adoc[Testing] is a crucial part of any development or integration
work. The Spring Framework offers a number of features that makes it easy to
test while using Spring for Inversion of Control which works with JUnit 3.x,
JUnit 4.x, and http://testng.org[TestNG].
-We can use Spring for IoC and the Camel
http://camel.apache.org/mock.html[Mock] and
http://camel.apache.org/test.html[Test] endpoints to create sophisticated
integration/unit tests that are easy to run and debug inside your IDE. There
are three supported approaches for testing with Spring in Camel.
+We can use Spring for IoC and the Camel
xref:components::mock-component.adoc[Mock] and xref:components::test.adoc[Test]
endpoints to create sophisticated integration/unit tests that are easy to run
and debug inside your IDE. There are three supported approaches for testing
with Spring in Camel.
[width="100%",cols="1,1,4,1",options="header",]
|=======================================================================
|Name |Testing Frameworks Supported |Description |Required Camel Test
Dependencies
-|<<SpringTesting-CamelSpringTestSupport>>[CamelSpringTestSupport] a|
+|<<camel-spring-test-support,Camel Spring Test Support>> a|
* JUnit 3.x (deprecated)
* JUnit 4.x
* TestNG
@@ -27,14 +27,14 @@ Provided by:
* `org.apache.camel.test.junit4.CamelSpringTestSupport`
* `org.apache.camel.testng.CamelSpringTestSupport`
-These base classes provide
http://camel.apache.org/camel-test.html#CamelTest-FeaturesProvidedbyCamelTestSupport[feature
parity] with the simple `CamelTestSupport` classes from
http://camel.apache.org/camel-test.html[Camel Test] but do not support Spring
annotations on the test class such as `@Autowired`, `@DirtiesContext`, and
`@ContextConfiguration`.
+These base classes provide feature parity with the simple `CamelTestSupport`
classes from xref:components::test.adoc[Camel Test] but do not support Spring
annotations on the test class such as `@Autowired`, `@DirtiesContext`, and
`@ContextConfiguration`.
a|
* JUnit 3.x (deprecated) - camel-test-spring
* JUnit 4.x - camel-test-spring
* TestNG - camel-test-ng
-|<<SpringTesting-PlainSpringTest>>[Plain Spring Test] a|
+|<<plain-spring-test, Plain Spring Test>> a|
* JUnit 3.x
* JUnit 4.x
* TestNG
@@ -59,7 +59,7 @@ a|
* JUnit 4.x - None
* TestNG - None
-|<<SpringTesting-CamelEnhancedSpringTest>>[Camel Enhanced Spring Test] a|
+|<<camel-enhanced-spring-test,Camel Enhanced Spring Test>> a|
* JUnit 4.x
* TestNG
@@ -75,8 +75,7 @@ a|
* TestNG - camel-test-ng
|=======================================================================
-
-
+[#camel-spring-test-support]
### CamelSpringTestSupport
The following Spring test support classes:
@@ -100,8 +99,7 @@ protected abstract AbstractApplicationContext
createApplicationContext();
----
You are responsible for the instantiation of the Spring context in the method
implementation. All of the features available in the non-Spring aware
counterparts from http://camel.apache.org/camel-test.html[Camel Test] are
available in your test.
-
-
+[#plain-spring-test]
### Plain Spring Test
In this approach, your test classes directly inherit from the Spring Test
abstract test classes or use the JUnit 4.x test runner provided in Spring Test.
This approach supports dependency injection into your test class and the full
suite of Spring Test annotations. However, it does not support the features
provided by the `CamelSpringTestSupport` classes.
@@ -293,7 +291,7 @@ public class MyCamelTest {
}
----
-
+[#camel-enhanced-spring-test]
### Camel Enhanced Spring Test
Using the `org.apache.camel.test.junit4.CamelSpringJUnit4ClassRunner` runner
with the `@RunWith` annotation or extending
`org.apache.camel.testng.AbstractCamelTestNGSpringContextTests` provides the
full feature set of Spring Test with support for the feature set provided in
the `CamelTestSupport` classes.
diff --git a/core/camel-core/src/main/docs/eips/unmarshal-eip.adoc
b/core/camel-core/src/main/docs/eips/unmarshal-eip.adoc
index 33e2548..a917ff3 100644
--- a/core/camel-core/src/main/docs/eips/unmarshal-eip.adoc
+++ b/core/camel-core/src/main/docs/eips/unmarshal-eip.adoc
@@ -1,7 +1,7 @@
[[unmarshal-eip]]
== Unmarshal EIP
-If you receive a message from one of the Camel
xref:components::index.adoc[Components] such as
xref:components::file-component.adoc[File],
xref:components::http4-component.adoc[HTTP] or
xref:components::jms-component.adoc[JMS] you often want to unmarshal the
payload into some bean so that you can process it using some
xref:bean-integration.adoc[Bean Integration] or perform
xref:expression.adoc#predicate[Predicate] evaluation and so forth. To do this
use the *unmarshal* word in the xref:d [...]
+If you receive a message from one of the Camel
xref:components::index.adoc[Components] such as
xref:components::file-component.adoc[File],
xref:components::http4-component.adoc[HTTP] or
xref:components::jms-component.adoc[JMS] you often want to unmarshal the
payload into some bean so that you can process it using some
xref:bean-integration.adoc[Bean Integration] or perform
xref:predicate.adoc[Predicate] evaluation and so forth. To do this use the
*unmarshal* word in the xref:dsl.adoc[DSL [...]
== Options
diff --git a/docs/components/modules/ROOT/pages/bean-language.adoc
b/docs/components/modules/ROOT/pages/bean-language.adoc
index b92c834..10b76fa 100644
--- a/docs/components/modules/ROOT/pages/bean-language.adoc
+++ b/docs/components/modules/ROOT/pages/bean-language.adoc
@@ -18,9 +18,9 @@ using the type of the message body and using any annotations
on the bean
methods.
The xref:manual::bean-binding.adoc[Bean Binding] rules are used to bind the
-xref:manual::message.html[Message] Exchange to the method parameters; so you
can
+xref:manual::message.adoc[Message] Exchange to the method parameters; so you
can
annotate the bean to extract headers or other expressions such as
-xref:components::xpath-language.adoc[XPath] or
xref:components::xquery-language.html[XQuery] from the message.
+xref:components::xpath-language.adoc[XPath] or
xref:components::xquery-language.adoc[XQuery] from the message.
[[BeanLanguage-UsingBeanExpressionsinJava]]
=== Using Bean Expressions in Java
@@ -98,11 +98,11 @@ or other expressions.
[[BeanLanguage-Non-RegistryBeans]]
=== Non-Registry Beans
-The xref:bean-language.html[Bean Language] also supports invoking beans
-that isn't registered in the xref:registry.html[Registry]. This is
+The xref:bean-language.adoc[Bean Language] also supports invoking beans
+that isn't registered in the xref:registry.adoc[Registry]. This is
usable for quickly to invoke a bean from Java DSL where you don't need
to register the bean in the xref:registry.html[Registry] such as the
-xref:spring.html[Spring] *`ApplicationContext`*. Camel can instantiate
+xref:spring.adoc[Spring] *`ApplicationContext`*. Camel can instantiate
the bean and invoke the method if given a class or invoke an already
existing instance.
diff --git a/docs/components/modules/ROOT/pages/test-spring.adoc
b/docs/components/modules/ROOT/pages/test-spring.adoc
index 7981da5..e665089 100644
--- a/docs/components/modules/ROOT/pages/test-spring.adoc
+++ b/docs/components/modules/ROOT/pages/test-spring.adoc
@@ -9,13 +9,13 @@ Allows to test Camel with Spring applications such as Spring
XML files or Spring
This documentation is old and needs to be updated
====
-http://camel.apache.org/testing.html[Testing] is a crucial part of any
development or integration work. The Spring Framework offers a number of
features that makes it easy to test while using Spring for Inversion of Control
which works with JUnit 3.x, JUnit 4.x, and http://testng.org[TestNG].
+xref:testing.adoc[Testing] is a crucial part of any development or integration
work. The Spring Framework offers a number of features that makes it easy to
test while using Spring for Inversion of Control which works with JUnit 3.x,
JUnit 4.x, and http://testng.org[TestNG].
-We can use Spring for IoC and the Camel
http://camel.apache.org/mock.html[Mock] and
http://camel.apache.org/test.html[Test] endpoints to create sophisticated
integration/unit tests that are easy to run and debug inside your IDE. There
are three supported approaches for testing with Spring in Camel.
+We can use Spring for IoC and the Camel
xref:components::mock-component.adoc[Mock] and xref:components::test.adoc[Test]
endpoints to create sophisticated integration/unit tests that are easy to run
and debug inside your IDE. There are three supported approaches for testing
with Spring in Camel.
[width="100%",cols="1,1,4,1",options="header",]
|=======================================================================
|Name |Testing Frameworks Supported |Description |Required Camel Test
Dependencies
-|<<SpringTesting-CamelSpringTestSupport>>[CamelSpringTestSupport] a|
+|<<camel-spring-test-support,Camel Spring Test Support>> a|
* JUnit 3.x (deprecated)
* JUnit 4.x
* TestNG
@@ -27,14 +27,14 @@ Provided by:
* `org.apache.camel.test.junit4.CamelSpringTestSupport`
* `org.apache.camel.testng.CamelSpringTestSupport`
-These base classes provide
http://camel.apache.org/camel-test.html#CamelTest-FeaturesProvidedbyCamelTestSupport[feature
parity] with the simple `CamelTestSupport` classes from
http://camel.apache.org/camel-test.html[Camel Test] but do not support Spring
annotations on the test class such as `@Autowired`, `@DirtiesContext`, and
`@ContextConfiguration`.
+These base classes provide feature parity with the simple `CamelTestSupport`
classes from xref:components::test.adoc[Camel Test] but do not support Spring
annotations on the test class such as `@Autowired`, `@DirtiesContext`, and
`@ContextConfiguration`.
a|
* JUnit 3.x (deprecated) - camel-test-spring
* JUnit 4.x - camel-test-spring
* TestNG - camel-test-ng
-|<<SpringTesting-PlainSpringTest>>[Plain Spring Test] a|
+|<<plain-spring-test, Plain Spring Test>> a|
* JUnit 3.x
* JUnit 4.x
* TestNG
@@ -59,7 +59,7 @@ a|
* JUnit 4.x - None
* TestNG - None
-|<<SpringTesting-CamelEnhancedSpringTest>>[Camel Enhanced Spring Test] a|
+|<<camel-enhanced-spring-test,Camel Enhanced Spring Test>> a|
* JUnit 4.x
* TestNG
@@ -75,8 +75,7 @@ a|
* TestNG - camel-test-ng
|=======================================================================
-
-
+[#camel-spring-test-support]
### CamelSpringTestSupport
The following Spring test support classes:
@@ -100,8 +99,7 @@ protected abstract AbstractApplicationContext
createApplicationContext();
----
You are responsible for the instantiation of the Spring context in the method
implementation. All of the features available in the non-Spring aware
counterparts from http://camel.apache.org/camel-test.html[Camel Test] are
available in your test.
-
-
+[#plain-spring-test]
### Plain Spring Test
In this approach, your test classes directly inherit from the Spring Test
abstract test classes or use the JUnit 4.x test runner provided in Spring Test.
This approach supports dependency injection into your test class and the full
suite of Spring Test annotations. However, it does not support the features
provided by the `CamelSpringTestSupport` classes.
@@ -293,7 +291,7 @@ public class MyCamelTest {
}
----
-
+[#camel-enhanced-spring-test]
### Camel Enhanced Spring Test
Using the `org.apache.camel.test.junit4.CamelSpringJUnit4ClassRunner` runner
with the `@RunWith` annotation or extending
`org.apache.camel.testng.AbstractCamelTestNGSpringContextTests` provides the
full feature set of Spring Test with support for the feature set provided in
the `CamelTestSupport` classes.
diff --git a/docs/user-manual/modules/ROOT/pages/bean-binding.adoc
b/docs/user-manual/modules/ROOT/pages/bean-binding.adoc
index 9e59c53..f412c8d 100644
--- a/docs/user-manual/modules/ROOT/pages/bean-binding.adoc
+++ b/docs/user-manual/modules/ROOT/pages/bean-binding.adoc
@@ -320,7 +320,7 @@ bind to message headers and other values such as:
.bean(OrderService.class, "doSomething(${body}, ${header.high})")
----
-You can also use the OGNL support of the xref:simple-language.html[Simple]
+You can also use the OGNL support of the xref:simple-language.adoc[Simple]
expression language. Now suppose the message body is an object which has
a method named `asXml`. To invoke the `asXml` method we can do as
follows:
diff --git a/docs/user-manual/modules/ROOT/pages/content-enricher.adoc
b/docs/user-manual/modules/ROOT/pages/content-enricher.adoc
index ff2bc1b..eb0afe6 100644
--- a/docs/user-manual/modules/ROOT/pages/content-enricher.adoc
+++ b/docs/user-manual/modules/ROOT/pages/content-enricher.adoc
@@ -144,7 +144,7 @@ xref:exchange.adoc[Exchange].
from. You must use either `uri` or `ref`. **Important:** From Camel
2.16 onwards, this option is removed, and you use an
xref:expression.adoc[Expression] to configure the uri, such as
-xref:simple-language.adoc[Simple] or xref:constant.html[Constant] or any other
+xref:simple-language.adoc[Simple] or xref:constant-language.adoc[Constant] or
any other
dynamic language that can compute the uri dynamically using values from
the current xref:exchange.adoc[Exchange].
diff --git a/docs/user-manual/modules/ROOT/pages/contributing.adoc
b/docs/user-manual/modules/ROOT/pages/contributing.adoc
index 9258ca3..652cc42 100644
--- a/docs/user-manual/modules/ROOT/pages/contributing.adoc
+++ b/docs/user-manual/modules/ROOT/pages/contributing.adoc
@@ -17,7 +17,7 @@ There are many ways you can help make Camel a better piece of
software - please
* <<working-on-the-code,Working on the code>>
* <<running-checkstyle,Running checkstyle>>
* <<checking-karaf-and-spring-boot-integration-tests,Checking Karaf and Spring
Boot Integration Tests>>
-* <<apache-camel-committers-should-work-on-the—asf-git-repo,Apache Camel
committers should work on the ASF git repo>>
+* <<apache-camel-committers-should-work-on-the-asf-git-repo,Apache Camel
committers should work on the ASF git repo>>
* <<creating-patches,Creating patches>>
* <<pull-request-at-github,Pull request at Github>>
* <<manual-patch-files,Manual patch files>>
@@ -26,6 +26,7 @@ There are many ways you can help make Camel a better piece of
software - please
* <<becoming-a-committer,Becoming a committer>>
* <<more-resources,More resources>>
+[#getting-in-touch]
== Getting in touch
There are various ways of communicating with the Camel community.
@@ -34,6 +35,7 @@ There are various ways of communicating with the Camel
community.
* Pop by on http://camel.apache.org/irc-room.html[IRC] and say hi
* Add some comments to the http://camel.apache.org/navigation.html[wiki]
+[#improving-the-documentation]
== Improving the documentation
Documentation is massively important to help users make the most of Apache
Camel and its probably the area that needs the most help!
@@ -51,6 +53,7 @@ To edit the documentation:
For more information see
https://github.com/apache/camel/blob/master/docs/user-manual/en/faq/how-does-the-website-work.adoc[How
does the website work] or
https://github.com/apache/camel/blob/master/docs/user-manual/en/faq/how-do-i-edit-the-website.adoc[How
do I edit the website for more details].
+[#if-you-find-a-bug-or-problem]
== If you find a bug or problem
Please raise a new issue in our
https://issues.apache.org/jira/browse/CAMEL[issue tracker]
@@ -58,6 +61,7 @@ If you can create a JUnit test case then your issue is more
likely to be resolve
e.g. take a look at some of the existing
https://svn.apache.org/repos/asf/camel/trunk/camel-core/src/test/java/[unit
tests cases]
Then we can add your issue to Subversion and then we'll know when its really
fixed and we can ensure that the problem stays fixed in future releases.
+[#working-on-the-code]
== Working on the code
We recommend to work on the code from https://github.com/apache/camel/[github].
@@ -71,6 +75,7 @@ Build the project (fast build).
If you intend to work on the code and provide patches and other work you want
to submit to the Apache Camel project, then you can fork the project on github
and work on your own fork. The custom work you do should be done on branches
you create, which can then be committed and pushed upstream, and then submitted
to Apache Camel as PRs (pull requests). You can find many resources online how
to work on github projects and how to submit work to these projects.
+[#running-checkstyle]
== Running checkstyle
Apache Camel source code is using a coding style/format which can be checked
whether is complying using the checkstyle plugin.
@@ -83,6 +88,7 @@ Please remember to run this check on your code changes before
submitting a patch
cd camel-ftp
mvn clean install -Psourcecheck
+[#checking-karaf-and-spring-boot-integration-tests]
== Checking Karaf and Spring Boot Integration Tests
Apache Camel source code has a set of Integration Test for Karaf and Spring
Boot platform.
@@ -96,6 +102,7 @@ And for Spring Boot:
cd tests/camel-itest-spring-boot
mvn clean test -Dtest=Camel<component_name>Test
+[#apache-camel-committers-should-work-on-the-asf-git-repo]
== Apache Camel committers should work on the ASF git repo
If you are an Apache Camel committer then clone the ASF git repo at
@@ -115,10 +122,12 @@ Build the project (without testing).
PS: You might need to build multiple times (if you get a build error) because
sometimes maven fails to download all the files.
Then import the projects into your workspace.
+[#creating-patches]
== Creating patches
We recommend you create patches as github PRs which is much easier for us to
accept and work with. You do this as any other github project, where you can
fork the project, and create a branch where you work on the code, and then
commit and push that code to your fork. Then navigate to the Apache Camel
github webpage, and you will see that github in the top of the page has a
wizard to send your recent work as a PR (pull request).
+[#pull-request-at-github]
== Pull request at Github
There is also a Git repository at Github which you could fork. Then you submit
patches as any other github project - eg work on a new feature branch and send
a pull request. One of the committers then needs to accept your pull request to
bring the code to the ASF codebase. After the code has been included into the
ASF codebase, you need to close the pull request because we can't do that...
@@ -128,6 +137,7 @@ We favor using the syntax:
CAMEL-9999: Some message goes here
+[#manual-patch-files]
== Manual patch files
We gladly accept patches if you can find ways to improve, tune or fix Camel in
some way.
@@ -143,6 +153,7 @@ or
git diff --no-prefix > patchfile.txt
+[#submitting-patches]
== Submitting patches
The easiest way to submit a patch is to
@@ -152,16 +163,19 @@ The easiest way to submit a patch is to
* *tick the Patch Attached* button on the issue
We prefer patches has unit tests as well and that these unit tests have proper
assertions as well, so remember to replace your system.out or logging with an
assertion instead!
+[#using-the-issue-tracker]
== Using the issue tracker
Before you can raise an issue in the
https://issues.apache.org/jira/browse/CAMEL[issue tracker] you need to register
with it. This is quick & painless.
+[#becoming-a-committer]
== Becoming a committer
Once you've got involved as above, we may well invite you to be a committer.
See http://camel.apache.org/how-do-i-become-a-committer.html[How do I become a
committer] for more details.
The first step is contributing to the project; if you want to take that a step
forward and become a fellow committer on the project then see the
http://activemq.apache.org/becoming-a-committer.html[Committer Guide]
+[#more-resources]
== More resources
Git is not a brand new technology and therefore Camel is not the only ASF
project thinking about using it. So here are some more resources you mind find
useful:
diff --git a/docs/user-manual/modules/ROOT/pages/unmarshal-eip.adoc
b/docs/user-manual/modules/ROOT/pages/unmarshal-eip.adoc
index 33e2548..a917ff3 100644
--- a/docs/user-manual/modules/ROOT/pages/unmarshal-eip.adoc
+++ b/docs/user-manual/modules/ROOT/pages/unmarshal-eip.adoc
@@ -1,7 +1,7 @@
[[unmarshal-eip]]
== Unmarshal EIP
-If you receive a message from one of the Camel
xref:components::index.adoc[Components] such as
xref:components::file-component.adoc[File],
xref:components::http4-component.adoc[HTTP] or
xref:components::jms-component.adoc[JMS] you often want to unmarshal the
payload into some bean so that you can process it using some
xref:bean-integration.adoc[Bean Integration] or perform
xref:expression.adoc#predicate[Predicate] evaluation and so forth. To do this
use the *unmarshal* word in the xref:d [...]
+If you receive a message from one of the Camel
xref:components::index.adoc[Components] such as
xref:components::file-component.adoc[File],
xref:components::http4-component.adoc[HTTP] or
xref:components::jms-component.adoc[JMS] you often want to unmarshal the
payload into some bean so that you can process it using some
xref:bean-integration.adoc[Bean Integration] or perform
xref:predicate.adoc[Predicate] evaluation and so forth. To do this use the
*unmarshal* word in the xref:dsl.adoc[DSL [...]
== Options
