You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@camel.apache.org by David Jencks <da...@gmail.com> on 2021/09/16 20:10:34 UTC
[Website] version link anomalies?
While fixing the broken camel-quarkus partial website build I noticed a couple of things I don’t understand.
1. camel-quarkus latest seems to use camel 3.11.x, at least the docs do. I think that, if this is really correct, the camel-quarkus index page should prominently say that you aren’t getting the cutting-edge latest camel in camel-quarkus, but something slightly older. Naively, I expected camel-quarkus versions to track camel versions. Indicating the relationship between versions would certainly help me.
2. eips are now versioned with components, but at least some links from components to eips use {eip-vc} in xref:{eip-vc}:eips:polling-consumer.adoc[Polling Consumer]
which points to the latest eips. If camel-quarkus really intentionally depends on camel 3.11.x then it should be possible to build the partial website with only the 3.11.x versions, but I get lots of errors like
[ERROR] [12:44:05.727] ERROR (asciidoctor): target of xref not found: latest@components:eips:polling-consumer.adoc
[ERROR] file: docs/components/modules/ROOT/pages/beanstalk-component.adoc
[ERROR] source: https://github.com/apache/camel.git (refname: camel-3.11.x, start path: docs/components)
I think there are 22 such usages, involving all links in the `components` component to eips.
If we agree this is a problem I’ll prepare some PRs for the affected branches (presumably at least main and 3.11.x)
David Jencks
side note: The camel-quarkus index page (both latest and 2.0.0) says
Camel Quarkus also takes advantage of the many performance improvements made in Camel 3, which results in a lower memory footprint, less reliance on reflection (which is good for native application support) and faster startup times.
I’m bewildered by this, and want to know “compared with what?”. I also think it would be nice if there was an explanation of what is different between the latest and 2.0.0 versions of camel-quarkus, right on the index page.
Re: [Website] version link anomalies?
Posted by David Jencks <da...@gmail.com>.
> On Sep 24, 2021, at 12:16 AM, Claus Ibsen <cl...@gmail.com> wrote:
>
> On Thu, Sep 23, 2021 at 5:37 PM David Jencks <david.a.jencks@gmail.com <ma...@gmail.com>> wrote:
>>
>> I can do that :-) but it doesn’t answer my question of what the camel-quarkus version refers to. Is it arbitrary? Does it refer to a quarkus version?
>>
>
> Yes it refers to the quarkus version. Quarkus just recently bumped
> from v1 to v2.
>
>> If it refers to a quarkus version then I think the display version for latest ought to be something like 2.3.0 (Pre-release). In any case I suspect latest should be labeled prerelease.
>>
>
> I wonder if having to label "latest" as pre-release version XXX is not
> a maintenance overhead, as we need to bump this version numbers all
> the time.
> Maybe we can use "next" or "pre-release" without any version indicator.
Perhaps. It would get updated only when a new branch is created, right? So one more thing on the list of how-to-do-a-release might not be that bad. The new branch needs the version set anyway, to make it not collide with the ‘latest’ branch.
>
>> What is the relationship between camel-quarkus and camel? There are some hints in the antora.yml component descriptors that both 2.0.0 and latest use camel 3.11.x. What’s going to happen when 3.12.0 is released?
>>
>
> Camel Quarkus pickup this release when they are ready, and in a future
> release of theirs.
> So that could be 2.3 ot 2.4.
>
>> I think this version correspondence to quarkus and camel should be documented at least in the camel-quarkus README.adoc and preferebly somewhere in the docs themselves as well. For instance,
>>
>> ```
>> This version of camel-quarkus uses quarkus {quarkus-version} and camel {camel-version}.
>> ```
>>
>
> Yeah I think we should have a single page that documents this for all
> the Camel projects
> Instead of spreading this across various doc files.
> It can be on a new page that also lists the JDK versions supported.
I wonder if that will be maintainable. For instance, each camel-quarkus doc branch needs to know what version of at least camel main docs it relates to, and the best place for that is in the antora.yml component descriptor. If that’s wrong, the docs are wrong (as they are now :-). So that attribute can easily be shown elsewhere in the docs. I’d worry that a centralized page won’t be kept up to date: I don’t see a way to have it display the versions from the component version attributes, nor how to set the component version attributes from a centralized source of truth.
David Jencks
>
>
>
>> David Jencks
>>
>>> On Sep 22, 2021, at 10:31 PM, Claus Ibsen <cl...@gmail.com> wrote:
>>>
>>> Hi
>>>
>>> Ah camel-quarkus likely haven't updated and removed outdated releases.
>>> Its latest release is 2.2.0, which should be there instead of 2.0.0.
>>> The 2.0.0 should be removed.
>>>
>>> On Thu, Sep 23, 2021 at 4:38 AM David Jencks <da...@gmail.com> wrote:
>>>>
>>>> So camel-quarkus latest referring to camel components 3.11.x seems reasonable. What about camel-quarkus 2.0.0?
>>>>
>>>> Now I noticed some more problems….
>>>>
>>>> I can’t figure out what the meaning of the camel-quarkus version is. What does the `2.0.0` in the non-latest version refer to? What about `latest`?
>>>>
>>>> This is reflected in these pages….
>>>>
>>>> (1) https://camel.apache.org/camel-quarkus/2.0.0/reference/components.html
>>>> (2) https://camel.apache.org/camel-quarkus/2.0.0/reference/dataformats.html
>>>> (3) https://camel.apache.org/camel-quarkus/2.0.0/reference/languages.html
>>>> (4) https://camel.apache.org/camel-quarkus/2.0.0/reference/others.html
>>>>
>>>> the tables are constructed by attempting to query some parts of the main camel components component. 1, 3, and 4 query at version `2.0.0` which, not existing, produces no results. 2 queries at version `latest`
>>>>
>>>> Some of the attributes used in these queries should be in the antora.yml component descriptor, but I’d like to understand what the correct values are before putting them there.
>>>>
>>>> David Jencks
>>>>
>>>>> On Sep 18, 2021, at 12:31 AM, Zoran Regvart <zo...@regvart.com> wrote:
>>>>>
>>>>> Hi David & Cameleers,
>>>>> as far as I’m aware, all sub-projects lag behind the latest Camel version. I don’t know if that’s a problem, they usually are not very far behind.
>>>>> For the documentation and Camel Quarkus in particular, the past experience was that pointing to the latest Camel version often led to broken links so not changing the version led to greater stability of the website.
>>>>> I do think that documentation should be cross linked against the correct versions, i.e. the ones they depend on in the code and that version should be prominently displayed in the documentation.
>>>>>
>>>>> zoran
>>>>> --
>>>>> Sent from mobile
>>>>>
>>>>>> On 16. Sep 2021, at 22:10, David Jencks <da...@gmail.com> wrote:
>>>>>>
>>>>>> While fixing the broken camel-quarkus partial website build I noticed a couple of things I don’t understand.
>>>>>>
>>>>>> 1. camel-quarkus latest seems to use camel 3.11.x, at least the docs do. I think that, if this is really correct, the camel-quarkus index page should prominently say that you aren’t getting the cutting-edge latest camel in camel-quarkus, but something slightly older. Naively, I expected camel-quarkus versions to track camel versions. Indicating the relationship between versions would certainly help me.
>>>>>>
>>>>>> 2. eips are now versioned with components, but at least some links from components to eips use {eip-vc} in xref:{eip-vc}:eips:polling-consumer.adoc[Polling Consumer]
>>>>>> which points to the latest eips. If camel-quarkus really intentionally depends on camel 3.11.x then it should be possible to build the partial website with only the 3.11.x versions, but I get lots of errors like
>>>>>>
>>>>>> [ERROR] [12:44:05.727] ERROR (asciidoctor): target of xref not found: latest@components:eips:polling-consumer.adoc
>>>>>> [ERROR] file: docs/components/modules/ROOT/pages/beanstalk-component.adoc
>>>>>> [ERROR] source: https://github.com/apache/camel.git (refname: camel-3.11.x, start path: docs/components)
>>>>>>
>>>>>> I think there are 22 such usages, involving all links in the `components` component to eips.
>>>>>>
>>>>>> If we agree this is a problem I’ll prepare some PRs for the affected branches (presumably at least main and 3.11.x)
>>>>>>
>>>>>>
>>>>>> David Jencks
>>>>>>
>>>>>> side note: The camel-quarkus index page (both latest and 2.0.0) says
>>>>>> Camel Quarkus also takes advantage of the many performance improvements made in Camel 3, which results in a lower memory footprint, less reliance on reflection (which is good for native application support) and faster startup times.
>>>>>> I’m bewildered by this, and want to know “compared with what?”. I also think it would be nice if there was an explanation of what is different between the latest and 2.0.0 versions of camel-quarkus, right on the index page.
>>>>>>
>>>>>>
>>>>
>>>
>>>
>>> --
>>> Claus Ibsen
>>> -----------------
>>> http://davsclaus.com @davsclaus
>>> Camel in Action 2: https://www.manning.com/ibsen2
>>
>
>
> --
> Claus Ibsen
> -----------------
> http://davsclaus.com <http://davsclaus.com/> @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2 <https://www.manning.com/ibsen2>
Re: [Website] version link anomalies?
Posted by Claus Ibsen <cl...@gmail.com>.
On Thu, Sep 23, 2021 at 5:37 PM David Jencks <da...@gmail.com> wrote:
>
> I can do that :-) but it doesn’t answer my question of what the camel-quarkus version refers to. Is it arbitrary? Does it refer to a quarkus version?
>
Yes it refers to the quarkus version. Quarkus just recently bumped
from v1 to v2.
> If it refers to a quarkus version then I think the display version for latest ought to be something like 2.3.0 (Pre-release). In any case I suspect latest should be labeled prerelease.
>
I wonder if having to label "latest" as pre-release version XXX is not
a maintenance overhead, as we need to bump this version numbers all
the time.
Maybe we can use "next" or "pre-release" without any version indicator.
> What is the relationship between camel-quarkus and camel? There are some hints in the antora.yml component descriptors that both 2.0.0 and latest use camel 3.11.x. What’s going to happen when 3.12.0 is released?
>
Camel Quarkus pickup this release when they are ready, and in a future
release of theirs.
So that could be 2.3 ot 2.4.
> I think this version correspondence to quarkus and camel should be documented at least in the camel-quarkus README.adoc and preferebly somewhere in the docs themselves as well. For instance,
>
> ```
> This version of camel-quarkus uses quarkus {quarkus-version} and camel {camel-version}.
> ```
>
Yeah I think we should have a single page that documents this for all
the Camel projects
Instead of spreading this across various doc files.
It can be on a new page that also lists the JDK versions supported.
> David Jencks
>
> > On Sep 22, 2021, at 10:31 PM, Claus Ibsen <cl...@gmail.com> wrote:
> >
> > Hi
> >
> > Ah camel-quarkus likely haven't updated and removed outdated releases.
> > Its latest release is 2.2.0, which should be there instead of 2.0.0.
> > The 2.0.0 should be removed.
> >
> > On Thu, Sep 23, 2021 at 4:38 AM David Jencks <da...@gmail.com> wrote:
> >>
> >> So camel-quarkus latest referring to camel components 3.11.x seems reasonable. What about camel-quarkus 2.0.0?
> >>
> >> Now I noticed some more problems….
> >>
> >> I can’t figure out what the meaning of the camel-quarkus version is. What does the `2.0.0` in the non-latest version refer to? What about `latest`?
> >>
> >> This is reflected in these pages….
> >>
> >> (1) https://camel.apache.org/camel-quarkus/2.0.0/reference/components.html
> >> (2) https://camel.apache.org/camel-quarkus/2.0.0/reference/dataformats.html
> >> (3) https://camel.apache.org/camel-quarkus/2.0.0/reference/languages.html
> >> (4) https://camel.apache.org/camel-quarkus/2.0.0/reference/others.html
> >>
> >> the tables are constructed by attempting to query some parts of the main camel components component. 1, 3, and 4 query at version `2.0.0` which, not existing, produces no results. 2 queries at version `latest`
> >>
> >> Some of the attributes used in these queries should be in the antora.yml component descriptor, but I’d like to understand what the correct values are before putting them there.
> >>
> >> David Jencks
> >>
> >>> On Sep 18, 2021, at 12:31 AM, Zoran Regvart <zo...@regvart.com> wrote:
> >>>
> >>> Hi David & Cameleers,
> >>> as far as I’m aware, all sub-projects lag behind the latest Camel version. I don’t know if that’s a problem, they usually are not very far behind.
> >>> For the documentation and Camel Quarkus in particular, the past experience was that pointing to the latest Camel version often led to broken links so not changing the version led to greater stability of the website.
> >>> I do think that documentation should be cross linked against the correct versions, i.e. the ones they depend on in the code and that version should be prominently displayed in the documentation.
> >>>
> >>> zoran
> >>> --
> >>> Sent from mobile
> >>>
> >>>> On 16. Sep 2021, at 22:10, David Jencks <da...@gmail.com> wrote:
> >>>>
> >>>> While fixing the broken camel-quarkus partial website build I noticed a couple of things I don’t understand.
> >>>>
> >>>> 1. camel-quarkus latest seems to use camel 3.11.x, at least the docs do. I think that, if this is really correct, the camel-quarkus index page should prominently say that you aren’t getting the cutting-edge latest camel in camel-quarkus, but something slightly older. Naively, I expected camel-quarkus versions to track camel versions. Indicating the relationship between versions would certainly help me.
> >>>>
> >>>> 2. eips are now versioned with components, but at least some links from components to eips use {eip-vc} in xref:{eip-vc}:eips:polling-consumer.adoc[Polling Consumer]
> >>>> which points to the latest eips. If camel-quarkus really intentionally depends on camel 3.11.x then it should be possible to build the partial website with only the 3.11.x versions, but I get lots of errors like
> >>>>
> >>>> [ERROR] [12:44:05.727] ERROR (asciidoctor): target of xref not found: latest@components:eips:polling-consumer.adoc
> >>>> [ERROR] file: docs/components/modules/ROOT/pages/beanstalk-component.adoc
> >>>> [ERROR] source: https://github.com/apache/camel.git (refname: camel-3.11.x, start path: docs/components)
> >>>>
> >>>> I think there are 22 such usages, involving all links in the `components` component to eips.
> >>>>
> >>>> If we agree this is a problem I’ll prepare some PRs for the affected branches (presumably at least main and 3.11.x)
> >>>>
> >>>>
> >>>> David Jencks
> >>>>
> >>>> side note: The camel-quarkus index page (both latest and 2.0.0) says
> >>>> Camel Quarkus also takes advantage of the many performance improvements made in Camel 3, which results in a lower memory footprint, less reliance on reflection (which is good for native application support) and faster startup times.
> >>>> I’m bewildered by this, and want to know “compared with what?”. I also think it would be nice if there was an explanation of what is different between the latest and 2.0.0 versions of camel-quarkus, right on the index page.
> >>>>
> >>>>
> >>
> >
> >
> > --
> > Claus Ibsen
> > -----------------
> > http://davsclaus.com @davsclaus
> > Camel in Action 2: https://www.manning.com/ibsen2
>
--
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2
Re: [Website] version link anomalies?
Posted by David Jencks <da...@gmail.com>.
I can do that :-) but it doesn’t answer my question of what the camel-quarkus version refers to. Is it arbitrary? Does it refer to a quarkus version?
If it refers to a quarkus version then I think the display version for latest ought to be something like 2.3.0 (Pre-release). In any case I suspect latest should be labeled prerelease.
What is the relationship between camel-quarkus and camel? There are some hints in the antora.yml component descriptors that both 2.0.0 and latest use camel 3.11.x. What’s going to happen when 3.12.0 is released?
I think this version correspondence to quarkus and camel should be documented at least in the camel-quarkus README.adoc and preferebly somewhere in the docs themselves as well. For instance,
```
This version of camel-quarkus uses quarkus {quarkus-version} and camel {camel-version}.
```
David Jencks
> On Sep 22, 2021, at 10:31 PM, Claus Ibsen <cl...@gmail.com> wrote:
>
> Hi
>
> Ah camel-quarkus likely haven't updated and removed outdated releases.
> Its latest release is 2.2.0, which should be there instead of 2.0.0.
> The 2.0.0 should be removed.
>
> On Thu, Sep 23, 2021 at 4:38 AM David Jencks <da...@gmail.com> wrote:
>>
>> So camel-quarkus latest referring to camel components 3.11.x seems reasonable. What about camel-quarkus 2.0.0?
>>
>> Now I noticed some more problems….
>>
>> I can’t figure out what the meaning of the camel-quarkus version is. What does the `2.0.0` in the non-latest version refer to? What about `latest`?
>>
>> This is reflected in these pages….
>>
>> (1) https://camel.apache.org/camel-quarkus/2.0.0/reference/components.html
>> (2) https://camel.apache.org/camel-quarkus/2.0.0/reference/dataformats.html
>> (3) https://camel.apache.org/camel-quarkus/2.0.0/reference/languages.html
>> (4) https://camel.apache.org/camel-quarkus/2.0.0/reference/others.html
>>
>> the tables are constructed by attempting to query some parts of the main camel components component. 1, 3, and 4 query at version `2.0.0` which, not existing, produces no results. 2 queries at version `latest`
>>
>> Some of the attributes used in these queries should be in the antora.yml component descriptor, but I’d like to understand what the correct values are before putting them there.
>>
>> David Jencks
>>
>>> On Sep 18, 2021, at 12:31 AM, Zoran Regvart <zo...@regvart.com> wrote:
>>>
>>> Hi David & Cameleers,
>>> as far as I’m aware, all sub-projects lag behind the latest Camel version. I don’t know if that’s a problem, they usually are not very far behind.
>>> For the documentation and Camel Quarkus in particular, the past experience was that pointing to the latest Camel version often led to broken links so not changing the version led to greater stability of the website.
>>> I do think that documentation should be cross linked against the correct versions, i.e. the ones they depend on in the code and that version should be prominently displayed in the documentation.
>>>
>>> zoran
>>> --
>>> Sent from mobile
>>>
>>>> On 16. Sep 2021, at 22:10, David Jencks <da...@gmail.com> wrote:
>>>>
>>>> While fixing the broken camel-quarkus partial website build I noticed a couple of things I don’t understand.
>>>>
>>>> 1. camel-quarkus latest seems to use camel 3.11.x, at least the docs do. I think that, if this is really correct, the camel-quarkus index page should prominently say that you aren’t getting the cutting-edge latest camel in camel-quarkus, but something slightly older. Naively, I expected camel-quarkus versions to track camel versions. Indicating the relationship between versions would certainly help me.
>>>>
>>>> 2. eips are now versioned with components, but at least some links from components to eips use {eip-vc} in xref:{eip-vc}:eips:polling-consumer.adoc[Polling Consumer]
>>>> which points to the latest eips. If camel-quarkus really intentionally depends on camel 3.11.x then it should be possible to build the partial website with only the 3.11.x versions, but I get lots of errors like
>>>>
>>>> [ERROR] [12:44:05.727] ERROR (asciidoctor): target of xref not found: latest@components:eips:polling-consumer.adoc
>>>> [ERROR] file: docs/components/modules/ROOT/pages/beanstalk-component.adoc
>>>> [ERROR] source: https://github.com/apache/camel.git (refname: camel-3.11.x, start path: docs/components)
>>>>
>>>> I think there are 22 such usages, involving all links in the `components` component to eips.
>>>>
>>>> If we agree this is a problem I’ll prepare some PRs for the affected branches (presumably at least main and 3.11.x)
>>>>
>>>>
>>>> David Jencks
>>>>
>>>> side note: The camel-quarkus index page (both latest and 2.0.0) says
>>>> Camel Quarkus also takes advantage of the many performance improvements made in Camel 3, which results in a lower memory footprint, less reliance on reflection (which is good for native application support) and faster startup times.
>>>> I’m bewildered by this, and want to know “compared with what?”. I also think it would be nice if there was an explanation of what is different between the latest and 2.0.0 versions of camel-quarkus, right on the index page.
>>>>
>>>>
>>
>
>
> --
> Claus Ibsen
> -----------------
> http://davsclaus.com @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2
Re: [Website] version link anomalies?
Posted by Claus Ibsen <cl...@gmail.com>.
Hi
Ah camel-quarkus likely haven't updated and removed outdated releases.
Its latest release is 2.2.0, which should be there instead of 2.0.0.
The 2.0.0 should be removed.
On Thu, Sep 23, 2021 at 4:38 AM David Jencks <da...@gmail.com> wrote:
>
> So camel-quarkus latest referring to camel components 3.11.x seems reasonable. What about camel-quarkus 2.0.0?
>
> Now I noticed some more problems….
>
> I can’t figure out what the meaning of the camel-quarkus version is. What does the `2.0.0` in the non-latest version refer to? What about `latest`?
>
> This is reflected in these pages….
>
> (1) https://camel.apache.org/camel-quarkus/2.0.0/reference/components.html
> (2) https://camel.apache.org/camel-quarkus/2.0.0/reference/dataformats.html
> (3) https://camel.apache.org/camel-quarkus/2.0.0/reference/languages.html
> (4) https://camel.apache.org/camel-quarkus/2.0.0/reference/others.html
>
> the tables are constructed by attempting to query some parts of the main camel components component. 1, 3, and 4 query at version `2.0.0` which, not existing, produces no results. 2 queries at version `latest`
>
> Some of the attributes used in these queries should be in the antora.yml component descriptor, but I’d like to understand what the correct values are before putting them there.
>
> David Jencks
>
> > On Sep 18, 2021, at 12:31 AM, Zoran Regvart <zo...@regvart.com> wrote:
> >
> > Hi David & Cameleers,
> > as far as I’m aware, all sub-projects lag behind the latest Camel version. I don’t know if that’s a problem, they usually are not very far behind.
> > For the documentation and Camel Quarkus in particular, the past experience was that pointing to the latest Camel version often led to broken links so not changing the version led to greater stability of the website.
> > I do think that documentation should be cross linked against the correct versions, i.e. the ones they depend on in the code and that version should be prominently displayed in the documentation.
> >
> > zoran
> > --
> > Sent from mobile
> >
> >> On 16. Sep 2021, at 22:10, David Jencks <da...@gmail.com> wrote:
> >>
> >> While fixing the broken camel-quarkus partial website build I noticed a couple of things I don’t understand.
> >>
> >> 1. camel-quarkus latest seems to use camel 3.11.x, at least the docs do. I think that, if this is really correct, the camel-quarkus index page should prominently say that you aren’t getting the cutting-edge latest camel in camel-quarkus, but something slightly older. Naively, I expected camel-quarkus versions to track camel versions. Indicating the relationship between versions would certainly help me.
> >>
> >> 2. eips are now versioned with components, but at least some links from components to eips use {eip-vc} in xref:{eip-vc}:eips:polling-consumer.adoc[Polling Consumer]
> >> which points to the latest eips. If camel-quarkus really intentionally depends on camel 3.11.x then it should be possible to build the partial website with only the 3.11.x versions, but I get lots of errors like
> >>
> >> [ERROR] [12:44:05.727] ERROR (asciidoctor): target of xref not found: latest@components:eips:polling-consumer.adoc
> >> [ERROR] file: docs/components/modules/ROOT/pages/beanstalk-component.adoc
> >> [ERROR] source: https://github.com/apache/camel.git (refname: camel-3.11.x, start path: docs/components)
> >>
> >> I think there are 22 such usages, involving all links in the `components` component to eips.
> >>
> >> If we agree this is a problem I’ll prepare some PRs for the affected branches (presumably at least main and 3.11.x)
> >>
> >>
> >> David Jencks
> >>
> >> side note: The camel-quarkus index page (both latest and 2.0.0) says
> >> Camel Quarkus also takes advantage of the many performance improvements made in Camel 3, which results in a lower memory footprint, less reliance on reflection (which is good for native application support) and faster startup times.
> >> I’m bewildered by this, and want to know “compared with what?”. I also think it would be nice if there was an explanation of what is different between the latest and 2.0.0 versions of camel-quarkus, right on the index page.
> >>
> >>
>
--
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2
Re: [Website] version link anomalies?
Posted by David Jencks <da...@gmail.com>.
So camel-quarkus latest referring to camel components 3.11.x seems reasonable. What about camel-quarkus 2.0.0?
Now I noticed some more problems….
I can’t figure out what the meaning of the camel-quarkus version is. What does the `2.0.0` in the non-latest version refer to? What about `latest`?
This is reflected in these pages….
(1) https://camel.apache.org/camel-quarkus/2.0.0/reference/components.html
(2) https://camel.apache.org/camel-quarkus/2.0.0/reference/dataformats.html
(3) https://camel.apache.org/camel-quarkus/2.0.0/reference/languages.html
(4) https://camel.apache.org/camel-quarkus/2.0.0/reference/others.html
the tables are constructed by attempting to query some parts of the main camel components component. 1, 3, and 4 query at version `2.0.0` which, not existing, produces no results. 2 queries at version `latest`
Some of the attributes used in these queries should be in the antora.yml component descriptor, but I’d like to understand what the correct values are before putting them there.
David Jencks
> On Sep 18, 2021, at 12:31 AM, Zoran Regvart <zo...@regvart.com> wrote:
>
> Hi David & Cameleers,
> as far as I’m aware, all sub-projects lag behind the latest Camel version. I don’t know if that’s a problem, they usually are not very far behind.
> For the documentation and Camel Quarkus in particular, the past experience was that pointing to the latest Camel version often led to broken links so not changing the version led to greater stability of the website.
> I do think that documentation should be cross linked against the correct versions, i.e. the ones they depend on in the code and that version should be prominently displayed in the documentation.
>
> zoran
> --
> Sent from mobile
>
>> On 16. Sep 2021, at 22:10, David Jencks <da...@gmail.com> wrote:
>>
>> While fixing the broken camel-quarkus partial website build I noticed a couple of things I don’t understand.
>>
>> 1. camel-quarkus latest seems to use camel 3.11.x, at least the docs do. I think that, if this is really correct, the camel-quarkus index page should prominently say that you aren’t getting the cutting-edge latest camel in camel-quarkus, but something slightly older. Naively, I expected camel-quarkus versions to track camel versions. Indicating the relationship between versions would certainly help me.
>>
>> 2. eips are now versioned with components, but at least some links from components to eips use {eip-vc} in xref:{eip-vc}:eips:polling-consumer.adoc[Polling Consumer]
>> which points to the latest eips. If camel-quarkus really intentionally depends on camel 3.11.x then it should be possible to build the partial website with only the 3.11.x versions, but I get lots of errors like
>>
>> [ERROR] [12:44:05.727] ERROR (asciidoctor): target of xref not found: latest@components:eips:polling-consumer.adoc
>> [ERROR] file: docs/components/modules/ROOT/pages/beanstalk-component.adoc
>> [ERROR] source: https://github.com/apache/camel.git (refname: camel-3.11.x, start path: docs/components)
>>
>> I think there are 22 such usages, involving all links in the `components` component to eips.
>>
>> If we agree this is a problem I’ll prepare some PRs for the affected branches (presumably at least main and 3.11.x)
>>
>>
>> David Jencks
>>
>> side note: The camel-quarkus index page (both latest and 2.0.0) says
>> Camel Quarkus also takes advantage of the many performance improvements made in Camel 3, which results in a lower memory footprint, less reliance on reflection (which is good for native application support) and faster startup times.
>> I’m bewildered by this, and want to know “compared with what?”. I also think it would be nice if there was an explanation of what is different between the latest and 2.0.0 versions of camel-quarkus, right on the index page.
>>
>>
Re: [Website] version link anomalies?
Posted by Zoran Regvart <zo...@regvart.com>.
Hi David,
On Mon, Sep 20, 2021 at 9:01 AM David Jencks <da...@gmail.com> wrote:
> if the downloads page was an Antora page we could both generate it from a json or yaml file and also include the EOL date elsewhere using asciidoctor-jsonpath. It looks like the current downloads page is generated somehow but I don’t see how or where the data comes from.
Data for the download pages and the release pages comes from release
notes[1] and the layout logic[2] is governed by release categories
configuration[3]. It's not at all trivial, as is our policy on what we
promote on the downloads page...
zoran
[1] https://github.com/apache/camel-website/#adding-new-release-note
[2] https://github.com/apache/camel-website/tree/main/layouts/partials/releases
[3] https://github.com/apache/camel-website/blob/main/data/release-categories.yaml
--
Zoran Regvart
Re: [Website] version link anomalies?
Posted by David Jencks <da...@gmail.com>.
> On Sep 19, 2021, at 10:20 PM, Claus Ibsen <cl...@gmail.com> wrote:
>
> On Sun, Sep 19, 2021 at 1:46 AM David Jencks <david.a.jencks@gmail.com <ma...@gmail.com>> wrote:
>>
>> Now I have more questions :-\
>>
>> IIUC the latest (code) release is 3.11.2. Is this what is documented in the 3.11.x doc version?
>> Does the doc ‘latest’ version document unreleased code, i.e. the current state of the ‘main’ branch? If so, would it be appropriate to make it a pre-release version?
>>
>
> Yeah latest is the current main code, but a good idea to rename it to
> pre-release or something like that.
Antora has the concept of marking a version ‘pre-release’. The main effect is that it’s no longer the (Antora) “latest” version: right now, if we marked “latest” pre-release, then the Antora “latest” version in components would be 3.11.x. In particular, xrefs to “components” pages from other Antora components, where the xref doesn’t specify the version, will go to 3.11.x rather than “latest”. Since according to apache policy we shouldn’t be encouraging users to use unreleased code, making the docs for the unreleased code harder to get to and marked is probably a good idea:-).
We always know what version “latest” is going to be related as, so how about labeling is with that version? That would give us, for camel itself, `3.12 (prerelease)` rather than `latest` or ‘latest (prerelease)`.
>
>> Is 3.12 (non-LTS, IIUC) going to get a doc version other than ‘latest’?
>>
>
> Yeah the last release is there, eg 3.12.0, 3.13.0 and so on. But a non
> LTS is removed asap a new release is out, so 3.12.0 is removed when
> 3.13.0 is released.
>
Makes sense!
>> Apparently 3.4.x (LTS) went out of support sometime around last July. Would it be appropriate to remove the doc version or label it out of support, perhaps (LTS expired)?
>>
>
> Yeah lets remove it
I’ll make a PR.
>
>> In general, it might be nice to include the expiration date of LTS versions somewhere prominent in the docs, perhaps the components index page.
>>
>
> The EOL date is listed on downloads, which IMHO is a natural place for
> such information
> https://camel.apache.org/download/ <https://camel.apache.org/download/>
if the downloads page was an Antora page we could both generate it from a json or yaml file and also include the EOL date elsewhere using asciidoctor-jsonpath. It looks like the current downloads page is generated somehow but I don’t see how or where the data comes from.
David Jencks
>
>
>
>> too many questions….
>>
>> Thanks
>> David Jencks
>>
>>
>>
>>> On Sep 18, 2021, at 12:31 AM, Zoran Regvart <zo...@regvart.com> wrote:
>>>
>>> Hi David & Cameleers,
>>> as far as I’m aware, all sub-projects lag behind the latest Camel version. I don’t know if that’s a problem, they usually are not very far behind.
>>> For the documentation and Camel Quarkus in particular, the past experience was that pointing to the latest Camel version often led to broken links so not changing the version led to greater stability of the website.
>>> I do think that documentation should be cross linked against the correct versions, i.e. the ones they depend on in the code and that version should be prominently displayed in the documentation.
>>>
>>> zoran
>>> --
>>> Sent from mobile
>>>
>>>> On 16. Sep 2021, at 22:10, David Jencks <da...@gmail.com> wrote:
>>>>
>>>> While fixing the broken camel-quarkus partial website build I noticed a couple of things I don’t understand.
>>>>
>>>> 1. camel-quarkus latest seems to use camel 3.11.x, at least the docs do. I think that, if this is really correct, the camel-quarkus index page should prominently say that you aren’t getting the cutting-edge latest camel in camel-quarkus, but something slightly older. Naively, I expected camel-quarkus versions to track camel versions. Indicating the relationship between versions would certainly help me.
>>>>
>>>> 2. eips are now versioned with components, but at least some links from components to eips use {eip-vc} in xref:{eip-vc}:eips:polling-consumer.adoc[Polling Consumer]
>>>> which points to the latest eips. If camel-quarkus really intentionally depends on camel 3.11.x then it should be possible to build the partial website with only the 3.11.x versions, but I get lots of errors like
>>>>
>>>> [ERROR] [12:44:05.727] ERROR (asciidoctor): target of xref not found: latest@components:eips:polling-consumer.adoc
>>>> [ERROR] file: docs/components/modules/ROOT/pages/beanstalk-component.adoc
>>>> [ERROR] source: https://github.com/apache/camel.git (refname: camel-3.11.x, start path: docs/components)
>>>>
>>>> I think there are 22 such usages, involving all links in the `components` component to eips.
>>>>
>>>> If we agree this is a problem I’ll prepare some PRs for the affected branches (presumably at least main and 3.11.x)
>>>>
>>>>
>>>> David Jencks
>>>>
>>>> side note: The camel-quarkus index page (both latest and 2.0.0) says
>>>> Camel Quarkus also takes advantage of the many performance improvements made in Camel 3, which results in a lower memory footprint, less reliance on reflection (which is good for native application support) and faster startup times.
>>>> I’m bewildered by this, and want to know “compared with what?”. I also think it would be nice if there was an explanation of what is different between the latest and 2.0.0 versions of camel-quarkus, right on the index page.
>>>>
>>>>
>>
>
>
> --
> Claus Ibsen
> -----------------
> http://davsclaus.com <http://davsclaus.com/> @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2 <https://www.manning.com/ibsen2>
Re: [Website] version link anomalies?
Posted by David Jencks <da...@gmail.com>.
I merged the camel branch related PRs and now the camel-website PR https://github.com/apache/camel-website/pull/628 is ready to merge. There’s a preview at https://pr-628--camel.netlify.app <https://pr-628--camel.netlify.app/>.
After merging I realized that user-manual and 2.x should not be linking to the unreleased EIP docs but to the latest released docs. I’ve updated the JIRI issue to mention this and made 2 more PRs, https://github.com/apache/camel/pull/6148 and https://github.com/apache/camel/pull/6149. These aren’t in the preview.
David Jencks
> On Sep 21, 2021, at 9:49 PM, David Jencks <da...@gmail.com> wrote:
>
> I opened CAMEL-16992 <https://issues.apache.org/jira/browse/CAMEL-16992> to deal with some of this.
>
> It:
> - removes 3.4.x (camel, camel-spring-boot, camel-karat)
> - labels camel main latest ‘prerelease: true’ and sets the display-version to ‘3.12.0 (Prerelease)’. The version segment in the URI is still ‘latest’ I think this is OK, and should make it easier to update when a new version is released.
> - makes references to eips from components pages stay within the components version rather than go to ‘latest’. References from user-manual still go to ‘latest’.
>
> Theres a preview at https://pr-628--camel.netlify.app <https://pr-628--camel.netlify.app/>
>
> David Jencks
>
>> On Sep 19, 2021, at 10:20 PM, Claus Ibsen <claus.ibsen@gmail.com <ma...@gmail.com>> wrote:
>>
>> On Sun, Sep 19, 2021 at 1:46 AM David Jencks <david.a.jencks@gmail.com <ma...@gmail.com>> wrote:
>>>
>>> Now I have more questions :-\
>>>
>>> IIUC the latest (code) release is 3.11.2. Is this what is documented in the 3.11.x doc version?
>>> Does the doc ‘latest’ version document unreleased code, i.e. the current state of the ‘main’ branch? If so, would it be appropriate to make it a pre-release version?
>>>
>>
>> Yeah latest is the current main code, but a good idea to rename it to
>> pre-release or something like that.
>>
>>> Is 3.12 (non-LTS, IIUC) going to get a doc version other than ‘latest’?
>>>
>>
>> Yeah the last release is there, eg 3.12.0, 3.13.0 and so on. But a non
>> LTS is removed asap a new release is out, so 3.12.0 is removed when
>> 3.13.0 is released.
>>
>>> Apparently 3.4.x (LTS) went out of support sometime around last July. Would it be appropriate to remove the doc version or label it out of support, perhaps (LTS expired)?
>>>
>>
>> Yeah lets remove it
>>
>>> In general, it might be nice to include the expiration date of LTS versions somewhere prominent in the docs, perhaps the components index page.
>>>
>>
>> The EOL date is listed on downloads, which IMHO is a natural place for
>> such information
>> https://camel.apache.org/download/ <https://camel.apache.org/download/>
>>
>>
>>
>>> too many questions….
>>>
>>> Thanks
>>> David Jencks
>>>
>>>
>>>
>>>> On Sep 18, 2021, at 12:31 AM, Zoran Regvart <zoran@regvart.com <ma...@regvart.com>> wrote:
>>>>
>>>> Hi David & Cameleers,
>>>> as far as I’m aware, all sub-projects lag behind the latest Camel version. I don’t know if that’s a problem, they usually are not very far behind.
>>>> For the documentation and Camel Quarkus in particular, the past experience was that pointing to the latest Camel version often led to broken links so not changing the version led to greater stability of the website.
>>>> I do think that documentation should be cross linked against the correct versions, i.e. the ones they depend on in the code and that version should be prominently displayed in the documentation.
>>>>
>>>> zoran
>>>> --
>>>> Sent from mobile
>>>>
>>>>> On 16. Sep 2021, at 22:10, David Jencks <david.a.jencks@gmail.com <ma...@gmail.com>> wrote:
>>>>>
>>>>> While fixing the broken camel-quarkus partial website build I noticed a couple of things I don’t understand.
>>>>>
>>>>> 1. camel-quarkus latest seems to use camel 3.11.x, at least the docs do. I think that, if this is really correct, the camel-quarkus index page should prominently say that you aren’t getting the cutting-edge latest camel in camel-quarkus, but something slightly older. Naively, I expected camel-quarkus versions to track camel versions. Indicating the relationship between versions would certainly help me.
>>>>>
>>>>> 2. eips are now versioned with components, but at least some links from components to eips use {eip-vc} in xref:{eip-vc}:eips:polling-consumer.adoc[Polling Consumer]
>>>>> which points to the latest eips. If camel-quarkus really intentionally depends on camel 3.11.x then it should be possible to build the partial website with only the 3.11.x versions, but I get lots of errors like
>>>>>
>>>>> [ERROR] [12:44:05.727] ERROR (asciidoctor): target of xref not found: latest@components:eips:polling-consumer.adoc
>>>>> [ERROR] file: docs/components/modules/ROOT/pages/beanstalk-component.adoc
>>>>> [ERROR] source: https://github.com/apache/camel.git <https://github.com/apache/camel.git> (refname: camel-3.11.x, start path: docs/components)
>>>>>
>>>>> I think there are 22 such usages, involving all links in the `components` component to eips.
>>>>>
>>>>> If we agree this is a problem I’ll prepare some PRs for the affected branches (presumably at least main and 3.11.x)
>>>>>
>>>>>
>>>>> David Jencks
>>>>>
>>>>> side note: The camel-quarkus index page (both latest and 2.0.0) says
>>>>> Camel Quarkus also takes advantage of the many performance improvements made in Camel 3, which results in a lower memory footprint, less reliance on reflection (which is good for native application support) and faster startup times.
>>>>> I’m bewildered by this, and want to know “compared with what?”. I also think it would be nice if there was an explanation of what is different between the latest and 2.0.0 versions of camel-quarkus, right on the index page.
>>>>>
>>>>>
>>>
>>
>>
>> --
>> Claus Ibsen
>> -----------------
>> http://davsclaus.com <http://davsclaus.com/> @davsclaus
>> Camel in Action 2: https://www.manning.com/ibsen2 <https://www.manning.com/ibsen2>
Re: [Website] version link anomalies?
Posted by David Jencks <da...@gmail.com>.
I opened CAMEL-16992 <https://issues.apache.org/jira/browse/CAMEL-16992> to deal with some of this.
It:
- removes 3.4.x (camel, camel-spring-boot, camel-karat)
- labels camel main latest ‘prerelease: true’ and sets the display-version to ‘3.12.0 (Prerelease)’. The version segment in the URI is still ‘latest’ I think this is OK, and should make it easier to update when a new version is released.
- makes references to eips from components pages stay within the components version rather than go to ‘latest’. References from user-manual still go to ‘latest’.
Theres a preview at https://pr-628--camel.netlify.app <https://pr-628--camel.netlify.app/>
David Jencks
> On Sep 19, 2021, at 10:20 PM, Claus Ibsen <cl...@gmail.com> wrote:
>
> On Sun, Sep 19, 2021 at 1:46 AM David Jencks <david.a.jencks@gmail.com <ma...@gmail.com>> wrote:
>>
>> Now I have more questions :-\
>>
>> IIUC the latest (code) release is 3.11.2. Is this what is documented in the 3.11.x doc version?
>> Does the doc ‘latest’ version document unreleased code, i.e. the current state of the ‘main’ branch? If so, would it be appropriate to make it a pre-release version?
>>
>
> Yeah latest is the current main code, but a good idea to rename it to
> pre-release or something like that.
>
>> Is 3.12 (non-LTS, IIUC) going to get a doc version other than ‘latest’?
>>
>
> Yeah the last release is there, eg 3.12.0, 3.13.0 and so on. But a non
> LTS is removed asap a new release is out, so 3.12.0 is removed when
> 3.13.0 is released.
>
>> Apparently 3.4.x (LTS) went out of support sometime around last July. Would it be appropriate to remove the doc version or label it out of support, perhaps (LTS expired)?
>>
>
> Yeah lets remove it
>
>> In general, it might be nice to include the expiration date of LTS versions somewhere prominent in the docs, perhaps the components index page.
>>
>
> The EOL date is listed on downloads, which IMHO is a natural place for
> such information
> https://camel.apache.org/download/ <https://camel.apache.org/download/>
>
>
>
>> too many questions….
>>
>> Thanks
>> David Jencks
>>
>>
>>
>>> On Sep 18, 2021, at 12:31 AM, Zoran Regvart <zo...@regvart.com> wrote:
>>>
>>> Hi David & Cameleers,
>>> as far as I’m aware, all sub-projects lag behind the latest Camel version. I don’t know if that’s a problem, they usually are not very far behind.
>>> For the documentation and Camel Quarkus in particular, the past experience was that pointing to the latest Camel version often led to broken links so not changing the version led to greater stability of the website.
>>> I do think that documentation should be cross linked against the correct versions, i.e. the ones they depend on in the code and that version should be prominently displayed in the documentation.
>>>
>>> zoran
>>> --
>>> Sent from mobile
>>>
>>>> On 16. Sep 2021, at 22:10, David Jencks <da...@gmail.com> wrote:
>>>>
>>>> While fixing the broken camel-quarkus partial website build I noticed a couple of things I don’t understand.
>>>>
>>>> 1. camel-quarkus latest seems to use camel 3.11.x, at least the docs do. I think that, if this is really correct, the camel-quarkus index page should prominently say that you aren’t getting the cutting-edge latest camel in camel-quarkus, but something slightly older. Naively, I expected camel-quarkus versions to track camel versions. Indicating the relationship between versions would certainly help me.
>>>>
>>>> 2. eips are now versioned with components, but at least some links from components to eips use {eip-vc} in xref:{eip-vc}:eips:polling-consumer.adoc[Polling Consumer]
>>>> which points to the latest eips. If camel-quarkus really intentionally depends on camel 3.11.x then it should be possible to build the partial website with only the 3.11.x versions, but I get lots of errors like
>>>>
>>>> [ERROR] [12:44:05.727] ERROR (asciidoctor): target of xref not found: latest@components:eips:polling-consumer.adoc
>>>> [ERROR] file: docs/components/modules/ROOT/pages/beanstalk-component.adoc
>>>> [ERROR] source: https://github.com/apache/camel.git (refname: camel-3.11.x, start path: docs/components)
>>>>
>>>> I think there are 22 such usages, involving all links in the `components` component to eips.
>>>>
>>>> If we agree this is a problem I’ll prepare some PRs for the affected branches (presumably at least main and 3.11.x)
>>>>
>>>>
>>>> David Jencks
>>>>
>>>> side note: The camel-quarkus index page (both latest and 2.0.0) says
>>>> Camel Quarkus also takes advantage of the many performance improvements made in Camel 3, which results in a lower memory footprint, less reliance on reflection (which is good for native application support) and faster startup times.
>>>> I’m bewildered by this, and want to know “compared with what?”. I also think it would be nice if there was an explanation of what is different between the latest and 2.0.0 versions of camel-quarkus, right on the index page.
>>>>
>>>>
>>
>
>
> --
> Claus Ibsen
> -----------------
> http://davsclaus.com <http://davsclaus.com/> @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2 <https://www.manning.com/ibsen2>
Re: [Website] version link anomalies?
Posted by Claus Ibsen <cl...@gmail.com>.
On Sun, Sep 19, 2021 at 1:46 AM David Jencks <da...@gmail.com> wrote:
>
> Now I have more questions :-\
>
> IIUC the latest (code) release is 3.11.2. Is this what is documented in the 3.11.x doc version?
> Does the doc ‘latest’ version document unreleased code, i.e. the current state of the ‘main’ branch? If so, would it be appropriate to make it a pre-release version?
>
Yeah latest is the current main code, but a good idea to rename it to
pre-release or something like that.
> Is 3.12 (non-LTS, IIUC) going to get a doc version other than ‘latest’?
>
Yeah the last release is there, eg 3.12.0, 3.13.0 and so on. But a non
LTS is removed asap a new release is out, so 3.12.0 is removed when
3.13.0 is released.
> Apparently 3.4.x (LTS) went out of support sometime around last July. Would it be appropriate to remove the doc version or label it out of support, perhaps (LTS expired)?
>
Yeah lets remove it
> In general, it might be nice to include the expiration date of LTS versions somewhere prominent in the docs, perhaps the components index page.
>
The EOL date is listed on downloads, which IMHO is a natural place for
such information
https://camel.apache.org/download/
> too many questions….
>
> Thanks
> David Jencks
>
>
>
> > On Sep 18, 2021, at 12:31 AM, Zoran Regvart <zo...@regvart.com> wrote:
> >
> > Hi David & Cameleers,
> > as far as I’m aware, all sub-projects lag behind the latest Camel version. I don’t know if that’s a problem, they usually are not very far behind.
> > For the documentation and Camel Quarkus in particular, the past experience was that pointing to the latest Camel version often led to broken links so not changing the version led to greater stability of the website.
> > I do think that documentation should be cross linked against the correct versions, i.e. the ones they depend on in the code and that version should be prominently displayed in the documentation.
> >
> > zoran
> > --
> > Sent from mobile
> >
> >> On 16. Sep 2021, at 22:10, David Jencks <da...@gmail.com> wrote:
> >>
> >> While fixing the broken camel-quarkus partial website build I noticed a couple of things I don’t understand.
> >>
> >> 1. camel-quarkus latest seems to use camel 3.11.x, at least the docs do. I think that, if this is really correct, the camel-quarkus index page should prominently say that you aren’t getting the cutting-edge latest camel in camel-quarkus, but something slightly older. Naively, I expected camel-quarkus versions to track camel versions. Indicating the relationship between versions would certainly help me.
> >>
> >> 2. eips are now versioned with components, but at least some links from components to eips use {eip-vc} in xref:{eip-vc}:eips:polling-consumer.adoc[Polling Consumer]
> >> which points to the latest eips. If camel-quarkus really intentionally depends on camel 3.11.x then it should be possible to build the partial website with only the 3.11.x versions, but I get lots of errors like
> >>
> >> [ERROR] [12:44:05.727] ERROR (asciidoctor): target of xref not found: latest@components:eips:polling-consumer.adoc
> >> [ERROR] file: docs/components/modules/ROOT/pages/beanstalk-component.adoc
> >> [ERROR] source: https://github.com/apache/camel.git (refname: camel-3.11.x, start path: docs/components)
> >>
> >> I think there are 22 such usages, involving all links in the `components` component to eips.
> >>
> >> If we agree this is a problem I’ll prepare some PRs for the affected branches (presumably at least main and 3.11.x)
> >>
> >>
> >> David Jencks
> >>
> >> side note: The camel-quarkus index page (both latest and 2.0.0) says
> >> Camel Quarkus also takes advantage of the many performance improvements made in Camel 3, which results in a lower memory footprint, less reliance on reflection (which is good for native application support) and faster startup times.
> >> I’m bewildered by this, and want to know “compared with what?”. I also think it would be nice if there was an explanation of what is different between the latest and 2.0.0 versions of camel-quarkus, right on the index page.
> >>
> >>
>
--
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2
Re: [Website] version link anomalies?
Posted by Zoran Regvart <zo...@regvart.com>.
Hi David,
On Sun, Sep 19, 2021 at 1:46 AM David Jencks <da...@gmail.com> wrote:
> Now I have more questions :-\
:)
> IIUC the latest (code) release is 3.11.2. Is this what is documented in the 3.11.x doc version?
Yes
> Does the doc ‘latest’ version document unreleased code, i.e. the current state of the ‘main’ branch? If so, would it be appropriate to make it a pre-release version?
Yes it's whatever is on `main`, we could name it pre-release instead
of latest. I would forgo the `latest` as a version, i.e. go with
Antora versionless documentation, and put "(Pre release)" in the name,
as we have for LTS.
> Is 3.12 (non-LTS, IIUC) going to get a doc version other than ‘latest’?
It should, we did that before for latest (and non `main`) non-LTS versions.
> Apparently 3.4.x (LTS) went out of support sometime around last July. Would it be appropriate to remove the doc version or label it out of support, perhaps (LTS expired)?
I think we should, it was probably left there because of inertia. Not
sure how folk feel about keeping older versions of documentation, e.g.
we do keep a release archive. Perhaps it would be good for the users
to also release a documentation archive?
> In general, it might be nice to include the expiration date of LTS versions somewhere prominent in the docs, perhaps the components index page.
+1
> too many questions….
Keep 'em coming :)
zoran
--
Zoran Regvart
Re: [Website] version link anomalies?
Posted by David Jencks <da...@gmail.com>.
Now I have more questions :-\
IIUC the latest (code) release is 3.11.2. Is this what is documented in the 3.11.x doc version?
Does the doc ‘latest’ version document unreleased code, i.e. the current state of the ‘main’ branch? If so, would it be appropriate to make it a pre-release version?
Is 3.12 (non-LTS, IIUC) going to get a doc version other than ‘latest’?
Apparently 3.4.x (LTS) went out of support sometime around last July. Would it be appropriate to remove the doc version or label it out of support, perhaps (LTS expired)?
In general, it might be nice to include the expiration date of LTS versions somewhere prominent in the docs, perhaps the components index page.
too many questions….
Thanks
David Jencks
> On Sep 18, 2021, at 12:31 AM, Zoran Regvart <zo...@regvart.com> wrote:
>
> Hi David & Cameleers,
> as far as I’m aware, all sub-projects lag behind the latest Camel version. I don’t know if that’s a problem, they usually are not very far behind.
> For the documentation and Camel Quarkus in particular, the past experience was that pointing to the latest Camel version often led to broken links so not changing the version led to greater stability of the website.
> I do think that documentation should be cross linked against the correct versions, i.e. the ones they depend on in the code and that version should be prominently displayed in the documentation.
>
> zoran
> --
> Sent from mobile
>
>> On 16. Sep 2021, at 22:10, David Jencks <da...@gmail.com> wrote:
>>
>> While fixing the broken camel-quarkus partial website build I noticed a couple of things I don’t understand.
>>
>> 1. camel-quarkus latest seems to use camel 3.11.x, at least the docs do. I think that, if this is really correct, the camel-quarkus index page should prominently say that you aren’t getting the cutting-edge latest camel in camel-quarkus, but something slightly older. Naively, I expected camel-quarkus versions to track camel versions. Indicating the relationship between versions would certainly help me.
>>
>> 2. eips are now versioned with components, but at least some links from components to eips use {eip-vc} in xref:{eip-vc}:eips:polling-consumer.adoc[Polling Consumer]
>> which points to the latest eips. If camel-quarkus really intentionally depends on camel 3.11.x then it should be possible to build the partial website with only the 3.11.x versions, but I get lots of errors like
>>
>> [ERROR] [12:44:05.727] ERROR (asciidoctor): target of xref not found: latest@components:eips:polling-consumer.adoc
>> [ERROR] file: docs/components/modules/ROOT/pages/beanstalk-component.adoc
>> [ERROR] source: https://github.com/apache/camel.git (refname: camel-3.11.x, start path: docs/components)
>>
>> I think there are 22 such usages, involving all links in the `components` component to eips.
>>
>> If we agree this is a problem I’ll prepare some PRs for the affected branches (presumably at least main and 3.11.x)
>>
>>
>> David Jencks
>>
>> side note: The camel-quarkus index page (both latest and 2.0.0) says
>> Camel Quarkus also takes advantage of the many performance improvements made in Camel 3, which results in a lower memory footprint, less reliance on reflection (which is good for native application support) and faster startup times.
>> I’m bewildered by this, and want to know “compared with what?”. I also think it would be nice if there was an explanation of what is different between the latest and 2.0.0 versions of camel-quarkus, right on the index page.
>>
>>
Re: [Website] version link anomalies?
Posted by Zoran Regvart <zo...@regvart.com>.
Hi David & Cameleers,
as far as I’m aware, all sub-projects lag behind the latest Camel version. I don’t know if that’s a problem, they usually are not very far behind.
For the documentation and Camel Quarkus in particular, the past experience was that pointing to the latest Camel version often led to broken links so not changing the version led to greater stability of the website.
I do think that documentation should be cross linked against the correct versions, i.e. the ones they depend on in the code and that version should be prominently displayed in the documentation.
zoran
--
Sent from mobile
> On 16. Sep 2021, at 22:10, David Jencks <da...@gmail.com> wrote:
>
> While fixing the broken camel-quarkus partial website build I noticed a couple of things I don’t understand.
>
> 1. camel-quarkus latest seems to use camel 3.11.x, at least the docs do. I think that, if this is really correct, the camel-quarkus index page should prominently say that you aren’t getting the cutting-edge latest camel in camel-quarkus, but something slightly older. Naively, I expected camel-quarkus versions to track camel versions. Indicating the relationship between versions would certainly help me.
>
> 2. eips are now versioned with components, but at least some links from components to eips use {eip-vc} in xref:{eip-vc}:eips:polling-consumer.adoc[Polling Consumer]
> which points to the latest eips. If camel-quarkus really intentionally depends on camel 3.11.x then it should be possible to build the partial website with only the 3.11.x versions, but I get lots of errors like
>
> [ERROR] [12:44:05.727] ERROR (asciidoctor): target of xref not found: latest@components:eips:polling-consumer.adoc
> [ERROR] file: docs/components/modules/ROOT/pages/beanstalk-component.adoc
> [ERROR] source: https://github.com/apache/camel.git (refname: camel-3.11.x, start path: docs/components)
>
> I think there are 22 such usages, involving all links in the `components` component to eips.
>
> If we agree this is a problem I’ll prepare some PRs for the affected branches (presumably at least main and 3.11.x)
>
>
> David Jencks
>
> side note: The camel-quarkus index page (both latest and 2.0.0) says
> Camel Quarkus also takes advantage of the many performance improvements made in Camel 3, which results in a lower memory footprint, less reliance on reflection (which is good for native application support) and faster startup times.
> I’m bewildered by this, and want to know “compared with what?”. I also think it would be nice if there was an explanation of what is different between the latest and 2.0.0 versions of camel-quarkus, right on the index page.
>
>