apache / camel-quarkus

Apache Camel Quarkus
https://camel.apache.org
Apache License 2.0
257 stars 191 forks source link

Various guide pages have been taken down for non-deprecated extensions #5814

Closed holly-cummins closed 8 months ago

holly-cummins commented 8 months ago

Bug description

I'm not sure what the best way to handle this is. It looks like some old versions have been removed from the https://camel.apache.org/camel-quarkus/ docs site, which means their pages have dead links.

When what's written in the metadata file doesn't point to a live file, I currently do the following to try and help users find the documentation, and avoid dead links:

I don't silently drop dead guides link as a general rule, because putting in an incorrect guides link is a common error for extension authors, and I want to catch those cases. The general assumption is that if you put it in the file, it's because you expect it to work. :)

For Camel, the current model doesn't seem to be working, so there's a few things I can do.

Here's the links

jamesnetherton commented 8 months ago

Add an exception and silently drop dead links for Camel extensions only. This has the drawback that if a guides link on a new extension gets messed up (easily done), no one gets alerted

I'd be ok with that. Not sure what others think.

The messed up guides link issue should (hopefully) never be a problem for us. They are all auto generated and the doc file name follows a convention.

Something else?

Maybe fall back to the raw AsciiDoc content on the release maintenance branch? E.g for Facebook:

https://github.com/apache/camel-quarkus/blob/3.6.x/docs/modules/ROOT/pages/reference/extensions/facebook.adoc

Some of the links wont get rendered outside of the Camel website, but at least the core content should be there.

ppalaga commented 8 months ago

Many thanks @holly-cummins for taking care for this. I agree with James, that dropping dead links for Camel might be a good solution. They are indeed auto-generated following a pattern (with one or two exceptions).

holly-cummins commented 8 months ago

Ok, I've made updates to drop dead guides, if the extension has the Camel group id.