You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@camel.apache.org by Claus Ibsen <cl...@gmail.com> on 2022/12/26 09:58:39 UTC

Re: [camel] branch main updated: Spring doc minor fix.

Hi


This causes build error, so I am reverting this

[INFO] --- camel-package-maven-plugin:3.21.0-SNAPSHOT:xref-check
(xref-check) @ docs ---
[ERROR] Unresolved xrefs:
[ERROR]   manual:ROOT:spring.adoc
(/Users/davsclaus/workspace/camel/docs/user-manual/modules/ROOT/pages/spring.adoc)
at line 14: xref:camel-spring-boot::index.adoc[Camel Spring Boot]



On Sun, Dec 25, 2022 at 8:31 PM <je...@apache.org> wrote:

> This is an automated email from the ASF dual-hosted git repository.
>
> jeremyross 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 796e58cd27a Spring doc minor fix.
> 796e58cd27a is described below
>
> commit 796e58cd27a07b91c5690cac977356788ba7a03a
> Author: Jeremy Ross <je...@gmail.com>
> AuthorDate: Sun Dec 25 13:30:11 2022 -0600
>
>     Spring doc minor fix.
> ---
>  docs/user-manual/modules/ROOT/pages/spring.adoc | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/docs/user-manual/modules/ROOT/pages/spring.adoc
> b/docs/user-manual/modules/ROOT/pages/spring.adoc
> index b4f3da46a9d..206ff0b05a1 100644
> --- a/docs/user-manual/modules/ROOT/pages/spring.adoc
> +++ b/docs/user-manual/modules/ROOT/pages/spring.adoc
> @@ -11,7 +11,7 @@ Apache Camel is designed to work first class with Spring
> in a number of ways, su
>
>  == Using Camel on Spring Boot
>
> -See the Camel Spring Boot documentation.
> +See the xref:camel-spring-boot::index.adoc[Camel Spring Boot]
> documentation.
>
>  == Using Camel with Spring XML files
>
> @@ -23,7 +23,7 @@ To use Camel with Spring XML files see the
> xref:spring-xml-extensions.adoc[Sprin
>
>  == Using Spring dependency injection
>
> -Spring dependency injection is integrated first-class when using Spring
> and Spring together.
> +Spring dependency injection is integrated first-class when using Camel
> and Spring together.
>
>  For example when using Camel on Spring Boot, then you can use any kind of
> Spring dependency and
>  be able to inject Camel resources such as 'CamelContext',
> xref:endpoint.adoc[Endpoint] and many more.
>
>

-- 
Claus Ibsen
-----------------
@davsclaus
Camel in Action 2: https://www.manning.com/ibsen2

Re: [camel] branch main updated: Spring doc minor fix.

Posted by Jeremy Ross <je...@gmail.com>.
It looks like the maven xref checker doesn't look at sub-projects to
resolve xrefs (
https://github.com/apache/camel/blob/6c84eb95ace6f4e57a90e5b660c292f89801abc2/docs/antora-playbook-local-xref-check.yml#L22-L34).
Therefore xrefs to spring, spring boot, camel-k, etc. are not allowed.

  sources:
    - url: ./../
      branches: HEAD
      start_path: docs/user-manual
    - url: ./../
      branches: HEAD
      start_path: core/camel-core-engine/src/main/docs
    - url: ./../
      branches: HEAD
      start_path: docs/components
    - url: ./../
      branches: HEAD
      start_path: docs/main



On Wed, Dec 28, 2022 at 10:01 AM Jeremy Ross <je...@gmail.com>
wrote:

> This puzzles me. I'm able to build the web site with this xref, and it
> resolves correctly. But `mvn xref-check` fails.
>
> On Mon, Dec 26, 2022 at 3:59 AM Claus Ibsen <cl...@gmail.com> wrote:
>
>> Hi
>>
>>
>> This causes build error, so I am reverting this
>>
>> [INFO] --- camel-package-maven-plugin:3.21.0-SNAPSHOT:xref-check
>> (xref-check) @ docs ---
>> [ERROR] Unresolved xrefs:
>> [ERROR]   manual:ROOT:spring.adoc
>>
>> (/Users/davsclaus/workspace/camel/docs/user-manual/modules/ROOT/pages/spring.adoc)
>> at line 14: xref:camel-spring-boot::index.adoc[Camel Spring Boot]
>>
>>
>>
>> On Sun, Dec 25, 2022 at 8:31 PM <je...@apache.org> wrote:
>>
>> > This is an automated email from the ASF dual-hosted git repository.
>> >
>> > jeremyross 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 796e58cd27a Spring doc minor fix.
>> > 796e58cd27a is described below
>> >
>> > commit 796e58cd27a07b91c5690cac977356788ba7a03a
>> > Author: Jeremy Ross <je...@gmail.com>
>> > AuthorDate: Sun Dec 25 13:30:11 2022 -0600
>> >
>> >     Spring doc minor fix.
>> > ---
>> >  docs/user-manual/modules/ROOT/pages/spring.adoc | 4 ++--
>> >  1 file changed, 2 insertions(+), 2 deletions(-)
>> >
>> > diff --git a/docs/user-manual/modules/ROOT/pages/spring.adoc
>> > b/docs/user-manual/modules/ROOT/pages/spring.adoc
>> > index b4f3da46a9d..206ff0b05a1 100644
>> > --- a/docs/user-manual/modules/ROOT/pages/spring.adoc
>> > +++ b/docs/user-manual/modules/ROOT/pages/spring.adoc
>> > @@ -11,7 +11,7 @@ Apache Camel is designed to work first class with
>> Spring
>> > in a number of ways, su
>> >
>> >  == Using Camel on Spring Boot
>> >
>> > -See the Camel Spring Boot documentation.
>> > +See the xref:camel-spring-boot::index.adoc[Camel Spring Boot]
>> > documentation.
>> >
>> >  == Using Camel with Spring XML files
>> >
>> > @@ -23,7 +23,7 @@ To use Camel with Spring XML files see the
>> > xref:spring-xml-extensions.adoc[Sprin
>> >
>> >  == Using Spring dependency injection
>> >
>> > -Spring dependency injection is integrated first-class when using Spring
>> > and Spring together.
>> > +Spring dependency injection is integrated first-class when using Camel
>> > and Spring together.
>> >
>> >  For example when using Camel on Spring Boot, then you can use any kind
>> of
>> > Spring dependency and
>> >  be able to inject Camel resources such as 'CamelContext',
>> > xref:endpoint.adoc[Endpoint] and many more.
>> >
>> >
>>
>> --
>> Claus Ibsen
>> -----------------
>> @davsclaus
>> Camel in Action 2: https://www.manning.com/ibsen2
>>
>

Re: [camel] branch main updated: Spring doc minor fix.

Posted by Jeremy Ross <je...@gmail.com>.
This puzzles me. I'm able to build the web site with this xref, and it
resolves correctly. But `mvn xref-check` fails.

On Mon, Dec 26, 2022 at 3:59 AM Claus Ibsen <cl...@gmail.com> wrote:

> Hi
>
>
> This causes build error, so I am reverting this
>
> [INFO] --- camel-package-maven-plugin:3.21.0-SNAPSHOT:xref-check
> (xref-check) @ docs ---
> [ERROR] Unresolved xrefs:
> [ERROR]   manual:ROOT:spring.adoc
>
> (/Users/davsclaus/workspace/camel/docs/user-manual/modules/ROOT/pages/spring.adoc)
> at line 14: xref:camel-spring-boot::index.adoc[Camel Spring Boot]
>
>
>
> On Sun, Dec 25, 2022 at 8:31 PM <je...@apache.org> wrote:
>
> > This is an automated email from the ASF dual-hosted git repository.
> >
> > jeremyross 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 796e58cd27a Spring doc minor fix.
> > 796e58cd27a is described below
> >
> > commit 796e58cd27a07b91c5690cac977356788ba7a03a
> > Author: Jeremy Ross <je...@gmail.com>
> > AuthorDate: Sun Dec 25 13:30:11 2022 -0600
> >
> >     Spring doc minor fix.
> > ---
> >  docs/user-manual/modules/ROOT/pages/spring.adoc | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/docs/user-manual/modules/ROOT/pages/spring.adoc
> > b/docs/user-manual/modules/ROOT/pages/spring.adoc
> > index b4f3da46a9d..206ff0b05a1 100644
> > --- a/docs/user-manual/modules/ROOT/pages/spring.adoc
> > +++ b/docs/user-manual/modules/ROOT/pages/spring.adoc
> > @@ -11,7 +11,7 @@ Apache Camel is designed to work first class with
> Spring
> > in a number of ways, su
> >
> >  == Using Camel on Spring Boot
> >
> > -See the Camel Spring Boot documentation.
> > +See the xref:camel-spring-boot::index.adoc[Camel Spring Boot]
> > documentation.
> >
> >  == Using Camel with Spring XML files
> >
> > @@ -23,7 +23,7 @@ To use Camel with Spring XML files see the
> > xref:spring-xml-extensions.adoc[Sprin
> >
> >  == Using Spring dependency injection
> >
> > -Spring dependency injection is integrated first-class when using Spring
> > and Spring together.
> > +Spring dependency injection is integrated first-class when using Camel
> > and Spring together.
> >
> >  For example when using Camel on Spring Boot, then you can use any kind
> of
> > Spring dependency and
> >  be able to inject Camel resources such as 'CamelContext',
> > xref:endpoint.adoc[Endpoint] and many more.
> >
> >
>
> --
> Claus Ibsen
> -----------------
> @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2
>