[
https://issues.apache.org/jira/browse/CAMEL-16228?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17286101#comment-17286101
]
Zoran Regvart commented on CAMEL-16228:
---------------------------------------
Thanks [~djencks] now I understand that we can set attributes per component in
[antora.yml|https://docs.antora.org/antora/2.3/component-attributes/#hard-set],
I was not aware of this until now. This will help when we point from
sub-project to Camel documentation (other than the manual) of specific version.
There are a number of issues that we have with the root cause of poor version
management, I'll try to enumerate the ones I know about:
* Release process doesn't account for changing the (Antora) component version,
this would be a non-issue if we were not publishing LTS, last release and
latest versions. We usually followup a release by changing the {{version}} in
{{antora.yml}} and change the version in {{xref}} links (examples:
[ccfcfcf6|https://github.com/apache/camel/commit/ccfcfcf6023aac038dd60d08071ec4f38a3b3a2e].
[af07b7f4|https://github.com/apache/camel-spring-boot/commit/af07b7f4ee312c4ee9e34077b760ac500b97f7fc],
[baa6bf97|https://github.com/apache/camel-spring-boot/commit/baa6bf9798234e4fac6ccbc12746d5567f3829e3]).
For this I think a proper solution is including a {{camel-version}} attribute
in {{antora.yml}} and referencing that from {{xref}} links. Then we would need
to change the {{version}} and {{camel-version}} in {{antora.yml}}.
* We forget to version links in the (Antora) "components" component, which end
up pointing to the {{latest}} version (examples:
[ae16cbd0|https://github.com/apache/camel/commit/ae16cbd0b86b1d90e4364f8f3de2dd8cffde8be0],
[ae16cbd0|https://github.com/apache/camel/commit/ae16cbd0b86b1d90e4364f8f3de2dd8cffde8be0].
I think same solution should apply here, we add {{camel-version}} attribute.
I think a lot of our problems would go away if we go through all xrefs, and
make sure that all xrefs that do not point to the user manual point to a
version dictated by the attribute, for now I think we only need
{{camel-version}}, we could also need {{camel-quarkus-version}} and similar if
we end up pointing from "components" component to the Camel Quarkus
documentation for example.
We could merge camel-spring-boot and camel-karaf into a distributed
"components" component, but I would not tackle this for this issue.
> Documentation: Fix xref link in old branches
> --------------------------------------------
>
> Key: CAMEL-16228
> URL: https://issues.apache.org/jira/browse/CAMEL-16228
> Project: Camel
> Issue Type: Task
> Components: documentation, website
> Reporter: Andrea Cosentino
> Priority: Major
> Fix For: 3.x
>
>
> Currently in the .adoc of our documentation we are using (for example)
> xref:components::kafka-component.adoc[KafkaIdempotentRepository]
> This is ok for master branch and latest documentation.
> The problem arises when we look at older active branch, all the link to
> components in 3.7.x for example are still pointi to latest. We need to change
> the docs in the following way
> xref:3.7.x@components::kafka-component.adoc[KafkaIdempotentRepository]
> We need to do this for 3.8.x, 3.7.x and 3.4.x
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
