You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by "holly-cummins (via GitHub)" <gi...@apache.org> on 2023/06/06 19:37:52 UTC
[GitHub] [camel-quarkus] holly-cummins opened a new issue, #4964: Dead guides links for extensions
holly-cummins opened a new issue, #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964
It looks like the guides links in the released extensions have gone out of sync with the published docs again.
I've started doing transformations to map from dead links (trying the previous release, etc). In these case, however, it seems like the issue isn't a timing one for when the docs are released and what extension is in what platform, but rather that we've changed the names or paths of docs pages. (Quarkus has this sometimes in the docs and handles it by putting redirects where the old pages were.)
For most of these, it seems like the name should have `-component.html` added on to the end, but there are exceptions. For example, https://camel.apache.org/camel-quarkus/latest/reference/extensions/cli-connector.html should be https://camel.apache.org/components/latest/others/cli-connector.html.
```
+ "https://camel.apache.org/camel-quarkus/latest/reference/extensions/cli-connector.html => 404 (Not Found) on http://localhost:9000/org.apache.camel.quarkus/camel-quarkus-cli-connector",
+ "https://camel.apache.org/camel-quarkus/latest/reference/extensions/datasonnet.html => 404 (Not Found) on http://localhost:9000/org.apache.camel.quarkus/camel-quarkus-datasonnet",
+ "https://camel.apache.org/camel-quarkus/latest/reference/extensions/elasticsearch.html => 404 (Not Found) on http://localhost:9000/org.apache.camel.quarkus/camel-quarkus-elasticsearch",
+ "https://camel.apache.org/camel-quarkus/latest/reference/extensions/mapstruct.html => 404 (Not Found) on http://localhost:9000/org.apache.camel.quarkus/camel-quarkus-mapstruct",
+ "https://camel.apache.org/camel-quarkus/latest/reference/extensions/optaplanner.html => 404 (Not Found) on http://localhost:9000/org.apache.camel.quarkus/camel-quarkus-optaplanner",
+ "https://camel.apache.org/camel-quarkus/latest/reference/extensions/smallrye-reactive-messaging.html => 404 (Not Found) on http://localhost:9000/org.apache.camel.quarkus/camel-quarkus-smallrye-reactive-messaging",
+ "https://camel.apache.org/camel-quarkus/latest/reference/extensions/xmlsecurity.html => 404 (Not Found) on http://localhost:9000/org.apache.camel.quarkus/camel-quarkus-xmlsecurity",
+ "https://camel.apache.org/camel-quarkus/latest/reference/extensions/tika.html => 404 (Not Found) on http://localhost:9000/org.apache.camel.quarkus/camel-quarkus-tika",
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] holly-cummins commented on issue #4964: Dead guides links for extensions
Posted by "holly-cummins (via GitHub)" <gi...@apache.org>.
holly-cummins commented on issue #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964#issuecomment-1721499369
Ahh, that would explain why I saw some new failures this morning (doh!). I haven't investigated properly to see if I need a different mapping logic now that we have the new release. I assume that's what's caused me problems. It's these guys:
```
"https://camel.apache.org/camel-quarkus/latest/reference/extensions/atlasmap.html",
"https://camel.apache.org/camel-quarkus/latest/reference/extensions/corda.html",
"https://camel.apache.org/camel-quarkus/latest/reference/extensions/solr.html",
"https://camel.apache.org/camel-quarkus/latest/reference/extensions/vm.html",
```
I had a quick look and I could see 3.2.1 links for atlasmap component, but I don't know if that's the same as atlasmap, and ... I'm continuing to look at it, but if something jumps out at you from that list about what they have in common, do shout.
Oh, and thanks for the update, and sorry to be the bearer of miserable news!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] jamesnetherton commented on issue #4964: Dead guides links for extensions
Posted by "jamesnetherton (via GitHub)" <gi...@apache.org>.
jamesnetherton commented on issue #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964#issuecomment-1582155624
> or are the -component pages actually a different set of content?
Yes, it's a different set of content....
The setup of the Camel documentation is quite complex. Each project in the Camel ecosystem maintains its own set docs and it's all tied together on the Camel website with Antora playbooks.
This project maintains docs specific to Camel Quarkus extensions and they contain links to the corresponding Camel component docs.
Things are in a state of flux (or mess :slightly_smiling_face:) at the moment because docs for Camel 4.x have not yet been published. So we are having to link to the older 3.x Camel releases.
I think if we fixed up the `3.0.x` branch as I suggested, it would probably fix the 404s you mentioned.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] jamesnetherton commented on issue #4964: Dead guides links for extensions
Posted by "jamesnetherton (via GitHub)" <gi...@apache.org>.
jamesnetherton commented on issue #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964#issuecomment-1582243929
> we should remove 3.0.x and have only next, WDYT?
Yes, sounds ok to me :+1:
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] jamesnetherton commented on issue #4964: Dead guides links for extensions
Posted by "jamesnetherton (via GitHub)" <gi...@apache.org>.
jamesnetherton commented on issue #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964#issuecomment-1582321575
We already have 'next' available so linking to that would work:
https://camel.apache.org/camel-quarkus/next/reference/extensions/mapstruct.html
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] jamesnetherton commented on issue #4964: Dead guides links for extensions
Posted by "jamesnetherton (via GitHub)" <gi...@apache.org>.
jamesnetherton commented on issue #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964#issuecomment-1721523382
> But I guess there was no release of those extensions where they were marked as deprecated between being there and not-there ... is that right?
Yeah, I think that is the problem (I've not checked to verify yet). Some of those bits got removed late on as we approached the Camel 4.0.0 GA.
Probably the only stable version of the docs where those extensions are still present is in the `2.13.x` stream, which is LTS:
https://camel.apache.org/camel-quarkus/2.13.x/index.html
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] holly-cummins commented on issue #4964: Dead guides links for extensions
Posted by "holly-cummins (via GitHub)" <gi...@apache.org>.
holly-cummins commented on issue #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964#issuecomment-1582100070
Thanks for looking @jamesnetherton! I've hit the exact problem you describe in the past, and so I do a bit of logic where if the link doesn't exist, it will try a version before or after. There's some hardcoding in there in what I check, so I probably need to continue tuning it as new releases happen.
However, in this case, it seems like the actual file names have changed/are incorrect.
For example,
https://camel.apache.org/components/latest/mapstruct.html does not exist
https://camel.apache.org/components/3.0.0.x/mapstruct.html does not exist
https://camel.apache.org/components/3.20.x/mapstruct.html does not exist
https://camel.apache.org/components/3.20.x/mapstruct-component.html *does* exist (note it's got `-component` tacked on to the end)
.... or are the -component pages actually a different page?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] jamesnetherton commented on issue #4964: Dead guides links for extensions
Posted by "jamesnetherton (via GitHub)" <gi...@apache.org>.
jamesnetherton commented on issue #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964#issuecomment-1582036358
This is because the Camel website is set up to point at the `3.0.x` branch where these extensions do not exist:
https://github.com/apache/camel-website/blob/main/antora-playbook-snippets/antora-playbook.yml#LL66C1-L66C16
It should probably be updated to `3.0.0-M2.x`.
@ppalaga do we actually need to maintain separate branches for these 3.x milestone releases? Or should we just rebase / reset `3.0.x` to the content from `3.0.0-M2.x`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] holly-cummins commented on issue #4964: Dead guides links for extensions
Posted by "holly-cummins (via GitHub)" <gi...@apache.org>.
holly-cummins commented on issue #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964#issuecomment-1582164182
Ah, ok, that makes sense. Is there any published page on the camel docs site for mapstruct.html, or is it only in the unpublished 3.0.0-M2 branch? I can get some ways with mapping from one release to another, but if there's nothing to map to, I think it would need the camel docs site changes you suggest.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] jamesnetherton commented on issue #4964: Dead guides links for extensions
Posted by "jamesnetherton (via GitHub)" <gi...@apache.org>.
jamesnetherton commented on issue #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964#issuecomment-1582176502
`MapStruct` was a new extension in the 3.0.0-M2 release, so there's no previous extension page to map to unfortunately.
Not ideal, but for the other items you could probably link to `https://camel.apache.org/camel-quarkus/2.16.x`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] ppalaga commented on issue #4964: Dead guides links for extensions
Posted by "ppalaga (via GitHub)" <gi...@apache.org>.
ppalaga commented on issue #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964#issuecomment-1582184045
> @ppalaga do we actually need to maintain separate branches for these 3.x milestone releases? Or should we just rebase / reset `3.0.x` to the content from `3.0.0-M2.x`?
Yeah, I was not aware `next` and `3.0.x` were separate in Antora config. I think while our 3.0.0 is not final, we should remove `3.0.x` and have only `next`, WDYT?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] jamesnetherton commented on issue #4964: Dead guides links for extensions
Posted by "jamesnetherton (via GitHub)" <gi...@apache.org>.
jamesnetherton commented on issue #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964#issuecomment-1721061007
Sorry it took so long, but we finally have docs for 3.x published:
https://camel.apache.org/camel-quarkus/3.2.x/
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] holly-cummins commented on issue #4964: Dead guides links for extensions
Posted by "holly-cummins (via GitHub)" <gi...@apache.org>.
holly-cummins commented on issue #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964#issuecomment-1583023346
I've just checked more carefully, and I was right the first time, and wrong the second time - we would normally try and map a `latest` version to an explicit version, based on what the latest released version is. So it's exactly as you say, @jamesnetherton, for something like [Optaplanner](https://quarkus.io/extensions/org.apache.camel.quarkus/camel-quarkus-optaplanner), when `latest` doesn't work, we look at the maven version, which is `3.0.0-M2`, and so we try a `3.0.x` link. But that link doesn't work because what's published for `3.0.x` isn't the M2 content. So that's probably something that should be updated, just for general correctness.
For this work item, with the `next` pointer, I'm ok, but maybe we should leave it open to track the M2 switch?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] jamesnetherton closed issue #4964: Dead guides links for extensions
Posted by "jamesnetherton (via GitHub)" <gi...@apache.org>.
jamesnetherton closed issue #4964: Dead guides links for extensions
URL: https://github.com/apache/camel-quarkus/issues/4964
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] holly-cummins commented on issue #4964: Dead guides links for extensions
Posted by "holly-cummins (via GitHub)" <gi...@apache.org>.
holly-cummins commented on issue #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964#issuecomment-1721518056
Ah, thanks for the insider knowledge! So what's supposed to happen in that case is that we go back through the docs to find the version of the docs where the extension did exist, and just point to that. Do you happen to know if there would be a version of the docs that they would still exist in? If so, I can figure out why I'm not finding it.
Or, if the extension is marked as deprecated, we don't bother and just don't show its docs. But I guess there was no release of those extensions where they were marked as deprecated between being there and not-there ... is that right?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] jamesnetherton commented on issue #4964: Dead guides links for extensions
Posted by "jamesnetherton (via GitHub)" <gi...@apache.org>.
jamesnetherton commented on issue #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964#issuecomment-1583274775
> maybe we should leave it open to track the M2 switch
Yes, that's fine 👍
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] holly-cummins commented on issue #4964: Dead guides links for extensions
Posted by "holly-cummins (via GitHub)" <gi...@apache.org>.
holly-cummins commented on issue #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964#issuecomment-1582193622
I thought 2.16.x is what I normally attempted to map to, but I've checked, and optaplanner does have a https://camel.apache.org/camel-quarkus/2.16.x/reference/extensions/optaplanner.html. Then I checked the code and there's something about 2.13, but nothing about 2.16.x, so I'll try that and see how many of the dead links I can resolve with that back-mapping. I just tried another one at random, and https://camel.apache.org/camel-quarkus/2.16.x/reference/extensions/elasticsearch.html doesn't exist, so it definitely won't be all of them.
For Quarkus, they have a `snapshot` docs section, and if I can't find anything else, I link to that. For example, https://quarkus.io/version/main/guides/ is the top level. Something similar for Camel might make sense. I think that's what you're suggesting, @ppalaga. Quarkus call it `main` but I think `next` works well.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [camel-quarkus] jamesnetherton commented on issue #4964: Dead guides links for extensions
Posted by "jamesnetherton (via GitHub)" <gi...@apache.org>.
jamesnetherton commented on issue #4964:
URL: https://github.com/apache/camel-quarkus/issues/4964#issuecomment-1721511296
It's expected unfortunately, as all of those extensions got removed in Camel 4.0.0 / Camel Quarkus 3.2.0 / Quarkus Platform 3.2.6.Final.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org